Skip to content

fix: MessageConverter.toLlmResponse does not map ChatResponse Usage to LlmResponse #1161

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
copybara-service merged 1 commit into from
Jun 29, 2026
+96 −5
Merged

fix: MessageConverter.toLlmResponse does not map ChatResponse Usage to LlmResponse #1161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
29 changes: 24 additions & 5 deletions contrib/spring-ai/src/main/java/com/google/adk/models/springai/MessageConverter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import com.google.adk.models.LlmResponse;
import com.google.genai.types.Content;
import com.google.genai.types.FunctionCall;
import com.google.genai.types.GenerateContentResponseUsageMetadata;
import com.google.genai.types.Part;
import java.net.URI;
import java.util.ArrayList;
Expand All @@ -32,6 +33,8 @@
import org.springframework.ai.chat.messages.SystemMessage;
import org.springframework.ai.chat.messages.ToolResponseMessage;
import org.springframework.ai.chat.messages.UserMessage;
import org.springframework.ai.chat.metadata.EmptyUsage;
import org.springframework.ai.chat.metadata.Usage;
import org.springframework.ai.chat.model.ChatResponse;
import org.springframework.ai.chat.model.Generation;
import org.springframework.ai.chat.prompt.ChatOptions;
Expand Down Expand Up @@ -318,11 +321,27 @@ public LlmResponse toLlmResponse(ChatResponse chatResponse, boolean isStreaming)
boolean isPartial = isStreaming && isPartialResponse(assistantMessage);
boolean isTurnComplete = !isStreaming || isTurnCompleteResponse(chatResponse);

return LlmResponse.builder()
.content(content)
.partial(isPartial)
.turnComplete(isTurnComplete)
.build();
LlmResponse.Builder responseBuilder =
LlmResponse.builder().content(content).partial(isPartial).turnComplete(isTurnComplete);

if (chatResponse.getMetadata() != null
&& chatResponse.getMetadata().getUsage() != null
&& !(chatResponse.getMetadata().getUsage() instanceof EmptyUsage)) {
Usage springUsage = chatResponse.getMetadata().getUsage();

GenerateContentResponseUsageMetadata adkUsage =
GenerateContentResponseUsageMetadata.builder()
.promptTokenCount(nullSafeInt(springUsage.getPromptTokens()))
.candidatesTokenCount(nullSafeInt(springUsage.getCompletionTokens()))
.totalTokenCount(nullSafeInt(springUsage.getTotalTokens()))
.build();
responseBuilder.usageMetadata(adkUsage);
}
return responseBuilder.build();
}

private int nullSafeInt(Integer value) {
return value != null ? value.intValue() : 0;
}

/** Determines if an assistant message represents a partial response in streaming. */
Expand Down
72 changes: 72 additions & 0 deletions contrib/spring-ai/src/test/java/com/google/adk/models/springai/MessageConverterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@
import org.springframework.ai.chat.messages.Message;
import org.springframework.ai.chat.messages.SystemMessage;
import org.springframework.ai.chat.messages.UserMessage;
import org.springframework.ai.chat.metadata.ChatResponseMetadata;
import org.springframework.ai.chat.metadata.DefaultUsage;
import org.springframework.ai.chat.model.ChatResponse;
import org.springframework.ai.chat.model.Generation;
import org.springframework.ai.chat.prompt.Prompt;
Expand Down Expand Up @@ -237,6 +239,76 @@ void testToLlmResponseFromChatResponseWithToolCalls() {
assertThat(functionCallPart.functionCall().get().id()).contains("call_123");
}

@Test
void testUsageMetadataShouldBeEmptyWhenSpringAiMetadataIsNull() {
MessageConverter converter = new MessageConverter(new ObjectMapper());
AssistantMessage assistantMessage = new AssistantMessage("intermediate chunk");
Generation generation = new Generation(assistantMessage);

ChatResponse chatResponse = new ChatResponse(List.of(generation), null);

LlmResponse llmResponse = converter.toLlmResponse(chatResponse, true);

assertThat(llmResponse.usageMetadata().isEmpty());
}

@Test
void testUsageMetadataShouldBeEmptyWhenSpringAiUsageIsNull() {
MessageConverter converter = new MessageConverter(new ObjectMapper());
AssistantMessage assistantMessage = new AssistantMessage("intermediate chunk");
Generation generation = new Generation(assistantMessage);

ChatResponseMetadata metadata = ChatResponseMetadata.builder().id("resp-no-usage").build();

ChatResponse chatResponse = new ChatResponse(List.of(generation), metadata);

LlmResponse llmResponse = converter.toLlmResponse(chatResponse, true);

assertThat(llmResponse.usageMetadata().isEmpty());
}

@Test
void testUsageMetadataShouldDefaultToZeroWhenSpringAiTokensAreNull() {
MessageConverter converter = new MessageConverter(new ObjectMapper());
AssistantMessage assistantMessage = new AssistantMessage("final chunk");
Generation generation = new Generation(assistantMessage);

// Anonymous implementation to simulate incomplete provider data where some token counts are
// null
DefaultUsage incompleteUsage = new DefaultUsage(null, null, 42);
ChatResponseMetadata metadata =
ChatResponseMetadata.builder().id("resp-partial-tokens").usage(incompleteUsage).build();

ChatResponse chatResponse = new ChatResponse(List.of(generation), metadata);

LlmResponse llmResponse = converter.toLlmResponse(chatResponse, false);

assertThat(llmResponse.usageMetadata().isPresent());
assertThat(llmResponse.usageMetadata().get().promptTokenCount().orElse(-1)).isEqualTo(0);
assertThat(llmResponse.usageMetadata().get().candidatesTokenCount().orElse(-1)).isEqualTo(0);
assertThat(llmResponse.usageMetadata().get().totalTokenCount().orElse(-1)).isEqualTo(42);
}

@Test
void testUsageMetadataShouldMapCorrectlyWhenAllFieldsArePresent() {
MessageConverter converter = new MessageConverter(new ObjectMapper());
AssistantMessage assistantMessage = new AssistantMessage("final chunk");
Generation generation = new Generation(assistantMessage);

DefaultUsage completeUsage = new DefaultUsage(15, 25, 40);
ChatResponseMetadata metadata =
ChatResponseMetadata.builder().id("resp-happy-path").usage(completeUsage).build();

ChatResponse chatResponse = new ChatResponse(List.of(generation), metadata);

LlmResponse llmResponse = converter.toLlmResponse(chatResponse, false);

assertThat(llmResponse.usageMetadata().isPresent());
assertThat(llmResponse.usageMetadata().get().promptTokenCount().orElse(-1)).isEqualTo(15);
assertThat(llmResponse.usageMetadata().get().candidatesTokenCount().orElse(-1)).isEqualTo(25);
assertThat(llmResponse.usageMetadata().get().totalTokenCount().orElse(-1)).isEqualTo(40);
}

@Test
Comment thread
hemasekhar-p marked this conversation as resolved.
void testToolCallIdPreservedInConversion() {
// Create AssistantMessage with tool call including ID
Expand Down