Skip to content

[MISC] Add Token Usage to AIMessage Response #48

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 21, 2025
Merged

[MISC] Add Token Usage to AIMessage Response #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c125cbb
Add total_tokens to AiMessage
paxiaatucsdedu Oct 20, 2025
61c05d6
Revert "Add total_tokens to AiMessage"
paxiaatucsdedu Oct 20, 2025
b96e40c
Add total_tokens to AIMessage
paxiaatucsdedu Oct 20, 2025
01400bc
Add unit test for total_tokens
paxiaatucsdedu Oct 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions libs/oci/langchain_oci/chat_models/oci_generative_ai.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,11 @@ def chat_generation_info(self, response: Any) -> Dict[str, Any]:
"is_search_required": response.data.chat_response.is_search_required,
"finish_reason": response.data.chat_response.finish_reason,
}

# Include token usage if available
if hasattr(response.data.chat_response, "usage") and response.data.chat_response.usage:
generation_info["total_tokens"] = response.data.chat_response.usage.total_tokens

# Include tool calls if available
if self.chat_tool_calls(response):
generation_info["tool_calls"] = self.format_response_tool_calls(
Expand Down Expand Up @@ -602,6 +607,11 @@ def chat_generation_info(self, response: Any) -> Dict[str, Any]:
"finish_reason": response.data.chat_response.choices[0].finish_reason,
"time_created": str(response.data.chat_response.time_created),
}

# Include token usage if available
if hasattr(response.data.chat_response, "usage") and response.data.chat_response.usage:
generation_info["total_tokens"] = response.data.chat_response.usage.total_tokens

if self.chat_tool_calls(response):
generation_info["tool_calls"] = self.format_response_tool_calls(
self.chat_tool_calls(response)
Expand Down
17 changes: 17 additions & 0 deletions libs/oci/tests/unit_tests/chat_models/test_oci_generative_ai.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,11 @@ def mocked_response(*args): # type: ignore[no-untyped-def]
"citations": None,
"documents": None,
"tool_calls": None,
"usage": MockResponseDict(
{
"total_tokens": 50,
}
),
}
),
"model_id": "cohere.command-r-16k",
Expand Down Expand Up @@ -116,6 +121,11 @@ def mocked_response(*args): # type: ignore[no-untyped-def]
)
],
"time_created": "2025-08-14T10:00:01.100000+00:00",
"usage": MockResponseDict(
{
"total_tokens": 75,
}
),
}
),
"model_id": "meta.llama-3.3-70b-instruct",
Expand All @@ -141,6 +151,13 @@ def mocked_response(*args): # type: ignore[no-untyped-def]
expected = "Assistant chat reply."
actual = llm.invoke(messages, temperature=0.2)
assert actual.content == expected

# Test total_tokens in additional_kwargs
assert "total_tokens" in actual.additional_kwargs
if provider == "cohere":
assert actual.additional_kwargs["total_tokens"] == 50
elif provider == "meta":
assert actual.additional_kwargs["total_tokens"] == 75


@pytest.mark.requires("oci")
Expand Down