Skip to content

Add missing reasoningContent to internalCall metadata #5733

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

Open
sachinnn99 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add missing reasoningContent to internalCall metadata #5733

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
3 changes: 2 additions & 1 deletion models/spring-ai-openai/src/main/java/org/springframework/ai/openai/OpenAiChatModel.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,8 @@ private ChatResponse internalCall(Prompt prompt, ChatResponse previousChatRespon
"index", choice.index() != null ? choice.index() : 0,
"finishReason", getFinishReasonJson(choice.finishReason()),
"refusal", StringUtils.hasText(choice.message().refusal()) ? choice.message().refusal() : "",
"annotations", choice.message().annotations() != null ? choice.message().annotations() : List.of(Map.of()));
"annotations", choice.message().annotations() != null ? choice.message().annotations() : List.of(Map.of()),
"reasoningContent", choice.message().reasoningContent() != null ? choice.message().reasoningContent() : "");
return buildGeneration(choice, metadata, request);
}).toList();
// @formatter:on
Expand Down
47 changes: 46 additions & 1 deletion ...java/org/springframework/ai/openai/chat/OpenAiChatModelWithChatResponseMetadataTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,7 @@ void aiResponseContainsAiMetadata() {
assertThat(chatGenerationMetadata).isNotNull();
assertThat(chatGenerationMetadata.getFinishReason()).isEqualTo("STOP");
assertThat(chatGenerationMetadata.getContentFilters()).isEmpty();
assertThat(generation.getOutput().getMetadata().get("reasoningContent")).isEqualTo("");
});
}

Expand All @@ -144,7 +145,26 @@ void aiResponseContainsAiLogprobsMetadata() {
assertThat(logprobs).isNotNull().isInstanceOf(OpenAiApi.LogProbs.class);
}

@Test
void aiResponseContainsReasoningContent() {

prepareMock(getJsonWithReasoningContent());

Prompt prompt = new Prompt("Reach for the sky.");

ChatResponse response = this.openAiChatClient.call(prompt);

assertThat(response).isNotNull();
assertThat(response.getResult()).isNotNull();
assertThat(response.getResult().getOutput().getMetadata().get("reasoningContent"))
.isEqualTo("Let me think step by step...");
}

private void prepareMock(boolean includeLogprobs) {
prepareMock(getJson(includeLogprobs));
}

private void prepareMock(String json) {

HttpHeaders httpHeaders = new HttpHeaders();
httpHeaders.set(OpenAiApiResponseHeaders.REQUESTS_LIMIT_HEADER.getName(), "4000");
Expand All @@ -157,7 +177,7 @@ private void prepareMock(boolean includeLogprobs) {
this.server.expect(requestTo(StringContains.containsString("/v1/chat/completions")))
.andExpect(method(HttpMethod.POST))
.andExpect(header(HttpHeaders.AUTHORIZATION, "Bearer " + TEST_API_KEY))
.andRespond(withSuccess(getJson(includeLogprobs), MediaType.APPLICATION_JSON).headers(httpHeaders));
.andRespond(withSuccess(json, MediaType.APPLICATION_JSON).headers(httpHeaders));

}

Expand Down Expand Up @@ -209,6 +229,31 @@ private String getJson(boolean includeLogprobs) {
return String.format(getBaseJson(), "");
}

private String getJsonWithReasoningContent() {
return """
{
"id": "chatcmpl-456",
"object": "chat.completion",
"created": 1677652288,
"model": "gpt-4o",
"choices": [{
"index": 0,
"message": {
"role": "assistant",
"content": "I surrender!",
"reasoning_content": "Let me think step by step..."
},
"finish_reason": "stop"
}],
"usage": {
"prompt_tokens": 9,
"completion_tokens": 12,
"total_tokens": 21
}
}
""";
}

@SpringBootConfiguration
static class Config {

Expand Down