Skip to content

Commit c483370

Browse files
ilayaperumalgilayaperumalg
committed
refactor: Rename ChatGenerationMetadata -> GenerationMetadata
 - To be consistent with the naming, the metadata for Generation is named as `GenerationMetadata` Resolves #1863
1 parent 6cfe5e7 commit c483370

File tree

30 files changed

+126
-129
lines changed

30 files changed

+126
-129
lines changed

‎models/spring-ai-anthropic/src/main/java/org/springframework/ai/anthropic/AnthropicChatModel.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
import org.springframework.ai.chat.messages.MessageType;
4646
import org.springframework.ai.chat.messages.ToolResponseMessage;
4747
import org.springframework.ai.chat.messages.UserMessage;
48-
import org.springframework.ai.chat.metadata.ChatGenerationMetadata;
48+
import org.springframework.ai.chat.metadata.GenerationMetadata;
4949
import org.springframework.ai.chat.metadata.ChatResponseMetadata;
5050
import org.springframework.ai.chat.model.AbstractToolCallSupport;
5151
import org.springframework.ai.chat.model.ChatModel;
@@ -293,14 +293,14 @@ private ChatResponse toChatResponse(ChatCompletionResponse chatCompletion) {
293293
.stream()
294294
.filter(content -> content.type() != ContentBlock.Type.TOOL_USE)
295295
.map(content -> new Generation(new AssistantMessage(content.text(), Map.of()),
296-
ChatGenerationMetadata.builder().finishReason(chatCompletion.stopReason()).build()))
296+
GenerationMetadata.builder().finishReason(chatCompletion.stopReason()).build()))
297297
.toList();
298298

299299
List<Generation> allGenerations = new ArrayList<>(generations);
300300

301301
if (chatCompletion.stopReason() != null && generations.isEmpty()) {
302302
Generation generation = new Generation(new AssistantMessage(null, Map.of()),
303-
ChatGenerationMetadata.builder().finishReason(chatCompletion.stopReason()).build());
303+
GenerationMetadata.builder().finishReason(chatCompletion.stopReason()).build());
304304
allGenerations.add(generation);
305305
}
306306

@@ -324,7 +324,7 @@ private ChatResponse toChatResponse(ChatCompletionResponse chatCompletion) {
324324

325325
AssistantMessage assistantMessage = new AssistantMessage("", Map.of(), toolCalls);
326326
Generation toolCallGeneration = new Generation(assistantMessage,
327-
ChatGenerationMetadata.builder().finishReason(chatCompletion.stopReason()).build());
327+
GenerationMetadata.builder().finishReason(chatCompletion.stopReason()).build());
328328
allGenerations.add(toolCallGeneration);
329329
}
330330

‎models/spring-ai-azure-openai/src/main/java/org/springframework/ai/azure/openai/AzureOpenAiChatModel.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@
6363
import org.springframework.ai.chat.messages.Message;
6464
import org.springframework.ai.chat.messages.ToolResponseMessage;
6565
import org.springframework.ai.chat.messages.UserMessage;
66-
import org.springframework.ai.chat.metadata.ChatGenerationMetadata;
66+
import org.springframework.ai.chat.metadata.GenerationMetadata;
6767
import org.springframework.ai.chat.metadata.ChatResponseMetadata;
6868
import org.springframework.ai.chat.metadata.EmptyUsage;
6969
import org.springframework.ai.chat.metadata.PromptMetadata;
@@ -458,8 +458,8 @@ else if (data instanceof byte[] dataBytes) {
458458
}
459459
}
460460

461-
private ChatGenerationMetadata generateChoiceMetadata(ChatChoice choice) {
462-
return ChatGenerationMetadata.builder()
461+
private GenerationMetadata generateChoiceMetadata(ChatChoice choice) {
462+
return GenerationMetadata.builder()
463463
.finishReason(String.valueOf(choice.getFinishReason()))
464464
.metadata("contentFilterResults", choice.getContentFilterResults())
465465
.build();

‎models/spring-ai-azure-openai/src/test/java/org/springframework/ai/azure/openai/metadata/AzureOpenAiChatModelMetadataTests.java‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
import org.springframework.ai.azure.openai.AzureOpenAiChatModel;
2828
import org.springframework.ai.azure.openai.MockAzureOpenAiTestConfiguration;
2929
import org.springframework.ai.chat.messages.AssistantMessage;
30-
import org.springframework.ai.chat.metadata.ChatGenerationMetadata;
30+
import org.springframework.ai.chat.metadata.GenerationMetadata;
3131
import org.springframework.ai.chat.metadata.ChatResponseMetadata;
3232
import org.springframework.ai.chat.metadata.EmptyRateLimit;
3333
import org.springframework.ai.chat.metadata.PromptMetadata;
@@ -124,11 +124,11 @@ private void assertGenerationMetadata(ChatResponse response) {
124124

125125
private void assertChoiceMetadata(Generation generation) {
126126

127-
ChatGenerationMetadata chatGenerationMetadata = generation.getMetadata();
127+
GenerationMetadata generationMetadata = generation.getMetadata();
128128

129-
assertThat(chatGenerationMetadata).isNotNull();
130-
assertThat(chatGenerationMetadata.getFinishReason()).isEqualTo("stop");
131-
assertContentFilterResults(chatGenerationMetadata.get("contentFilterResults"));
129+
assertThat(generationMetadata).isNotNull();
130+
assertThat(generationMetadata.getFinishReason()).isEqualTo("stop");
131+
assertContentFilterResults(generationMetadata.get("contentFilterResults"));
132132
}
133133

134134
private void assertContentFilterResultsForPrompt(ContentFilterResultDetailsForPrompt contentFilterResultForPrompt,

‎models/spring-ai-bedrock-converse/src/main/java/org/springframework/ai/bedrock/converse/BedrockProxyChatModel.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@
7171
import org.springframework.ai.chat.messages.MessageType;
7272
import org.springframework.ai.chat.messages.ToolResponseMessage;
7373
import org.springframework.ai.chat.messages.UserMessage;
74-
import org.springframework.ai.chat.metadata.ChatGenerationMetadata;
74+
import org.springframework.ai.chat.metadata.GenerationMetadata;
7575
import org.springframework.ai.chat.metadata.ChatResponseMetadata;
7676
import org.springframework.ai.chat.metadata.DefaultUsage;
7777
import org.springframework.ai.chat.model.AbstractToolCallSupport;
@@ -419,14 +419,14 @@ private ChatResponse toChatResponse(ConverseResponse response, ChatResponse perv
419419
.stream()
420420
.filter(content -> content.type() != ContentBlock.Type.TOOL_USE)
421421
.map(content -> new Generation(new AssistantMessage(content.text(), Map.of()),
422-
ChatGenerationMetadata.builder().finishReason(response.stopReasonAsString()).build()))
422+
GenerationMetadata.builder().finishReason(response.stopReasonAsString()).build()))
423423
.toList();
424424

425425
List<Generation> allGenerations = new ArrayList<>(generations);
426426

427427
if (response.stopReasonAsString() != null && generations.isEmpty()) {
428428
Generation generation = new Generation(new AssistantMessage(null, Map.of()),
429-
ChatGenerationMetadata.builder().finishReason(response.stopReasonAsString()).build());
429+
GenerationMetadata.builder().finishReason(response.stopReasonAsString()).build());
430430
allGenerations.add(generation);
431431
}
432432

@@ -451,7 +451,7 @@ private ChatResponse toChatResponse(ConverseResponse response, ChatResponse perv
451451

452452
AssistantMessage assistantMessage = new AssistantMessage("", Map.of(), toolCalls);
453453
Generation toolCallGeneration = new Generation(assistantMessage,
454-
ChatGenerationMetadata.builder().finishReason(response.stopReasonAsString()).build());
454+
GenerationMetadata.builder().finishReason(response.stopReasonAsString()).build());
455455
allGenerations.add(toolCallGeneration);
456456
}
457457

‎models/spring-ai-bedrock-converse/src/main/java/org/springframework/ai/bedrock/converse/api/ConverseApiUtils.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
import software.amazon.awssdk.services.bedrockruntime.model.ToolUseBlockStart;
4747

4848
import org.springframework.ai.chat.messages.AssistantMessage;
49-
import org.springframework.ai.chat.metadata.ChatGenerationMetadata;
49+
import org.springframework.ai.chat.metadata.GenerationMetadata;
5050
import org.springframework.ai.chat.metadata.ChatResponseMetadata;
5151
import org.springframework.ai.chat.metadata.DefaultUsage;
5252
import org.springframework.ai.chat.model.ChatResponse;
@@ -141,7 +141,7 @@ public static Flux<ChatResponse> toChatResponse(Flux<ConverseStreamOutput> respo
141141

142142
AssistantMessage assistantMessage = new AssistantMessage("", Map.of(), toolCalls);
143143
Generation toolCallGeneration = new Generation(assistantMessage,
144-
ChatGenerationMetadata.builder().finishReason("tool_use").build());
144+
GenerationMetadata.builder().finishReason("tool_use").build());
145145

146146
var chatResponseMetaData = ChatResponseMetadata.builder()
147147
.withUsage(new DefaultUsage(promptTokens, generationTokens, totalTokens))
@@ -176,7 +176,7 @@ else if (nextEvent instanceof ContentBlockDeltaEvent contentBlockDeltaEvent) {
176176

177177
var generation = new Generation(
178178
new AssistantMessage(contentBlockDeltaEvent.delta().text(), Map.of()),
179-
ChatGenerationMetadata.builder()
179+
GenerationMetadata.builder()
180180
.finishReason(lastAggregation.metadataAggregation().stopReason())
181181
.build());
182182

‎models/spring-ai-bedrock/src/main/java/org/springframework/ai/bedrock/anthropic/BedrockAnthropicChatModel.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
import org.springframework.ai.bedrock.anthropic.api.AnthropicChatBedrockApi.AnthropicChatRequest;
2626
import org.springframework.ai.bedrock.anthropic.api.AnthropicChatBedrockApi.AnthropicChatResponse;
2727
import org.springframework.ai.chat.messages.AssistantMessage;
28-
import org.springframework.ai.chat.metadata.ChatGenerationMetadata;
28+
import org.springframework.ai.chat.metadata.GenerationMetadata;
2929
import org.springframework.ai.chat.model.ChatModel;
3030
import org.springframework.ai.chat.model.ChatResponse;
3131
import org.springframework.ai.chat.model.Generation;
@@ -81,15 +81,15 @@ public Flux<ChatResponse> stream(Prompt prompt) {
8181

8282
return fluxResponse.map(response -> {
8383
String stopReason = response.stopReason() != null ? response.stopReason() : null;
84-
ChatGenerationMetadata chatGenerationMetadata = null;
84+
GenerationMetadata generationMetadata = null;
8585
if (response.amazonBedrockInvocationMetrics() != null) {
86-
chatGenerationMetadata = ChatGenerationMetadata.builder()
86+
generationMetadata = GenerationMetadata.builder()
8787
.finishReason(stopReason)
8888
.metadata("metrics", response.amazonBedrockInvocationMetrics())
8989
.build();
9090
}
9191
return new ChatResponse(
92-
List.of(new Generation(new AssistantMessage(response.completion()), chatGenerationMetadata)));
92+
List.of(new Generation(new AssistantMessage(response.completion()), generationMetadata)));
9393
});
9494
}
9595

‎models/spring-ai-bedrock/src/main/java/org/springframework/ai/bedrock/anthropic3/BedrockAnthropic3ChatModel.java‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
import org.springframework.ai.chat.messages.Message;
3636
import org.springframework.ai.chat.messages.MessageType;
3737
import org.springframework.ai.chat.messages.UserMessage;
38-
import org.springframework.ai.chat.metadata.ChatGenerationMetadata;
38+
import org.springframework.ai.chat.metadata.GenerationMetadata;
3939
import org.springframework.ai.chat.metadata.ChatResponseMetadata;
4040
import org.springframework.ai.chat.metadata.DefaultUsage;
4141
import org.springframework.ai.chat.metadata.Usage;
@@ -88,7 +88,7 @@ public ChatResponse call(Prompt prompt) {
8888
List<Generation> generations = response.content()
8989
.stream()
9090
.map(content -> new Generation(new AssistantMessage(content.text()),
91-
ChatGenerationMetadata.builder().finishReason(response.stopReason()).build()))
91+
GenerationMetadata.builder().finishReason(response.stopReason()).build()))
9292
.toList();
9393

9494
ChatResponseMetadata metadata = ChatResponseMetadata.builder()
@@ -114,16 +114,16 @@ public Flux<ChatResponse> stream(Prompt prompt) {
114114
inputTokens.set(response.message().usage().inputTokens());
115115
}
116116
String content = response.type() == StreamingType.CONTENT_BLOCK_DELTA ? response.delta().text() : "";
117-
ChatGenerationMetadata chatGenerationMetadata = null;
117+
GenerationMetadata generationMetadata = null;
118118
if (response.type() == StreamingType.MESSAGE_DELTA) {
119-
chatGenerationMetadata = ChatGenerationMetadata.builder()
119+
generationMetadata = GenerationMetadata.builder()
120120
.finishReason(response.delta().stopReason())
121121
.metadata("usage",
122122
new Anthropic3ChatBedrockApi.AnthropicUsage(inputTokens.get(),
123123
response.usage().outputTokens()))
124124
.build();
125125
}
126-
return new ChatResponse(List.of(new Generation(new AssistantMessage(content), chatGenerationMetadata)));
126+
return new ChatResponse(List.of(new Generation(new AssistantMessage(content), generationMetadata)));
127127
});
128128
}
129129

‎models/spring-ai-bedrock/src/main/java/org/springframework/ai/bedrock/cohere/BedrockCohereChatModel.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
import org.springframework.ai.bedrock.cohere.api.CohereChatBedrockApi.CohereChatRequest;
2727
import org.springframework.ai.bedrock.cohere.api.CohereChatBedrockApi.CohereChatResponse;
2828
import org.springframework.ai.chat.messages.AssistantMessage;
29-
import org.springframework.ai.chat.metadata.ChatGenerationMetadata;
29+
import org.springframework.ai.chat.metadata.GenerationMetadata;
3030
import org.springframework.ai.chat.metadata.Usage;
3131
import org.springframework.ai.chat.model.ChatModel;
3232
import org.springframework.ai.chat.model.ChatResponse;
@@ -79,7 +79,7 @@ public Flux<ChatResponse> stream(Prompt prompt) {
7979
String finishReason = g.finishReason().name();
8080
Usage usage = BedrockUsage.from(g.amazonBedrockInvocationMetrics());
8181
return new ChatResponse(List.of(new Generation(new AssistantMessage(""),
82-
ChatGenerationMetadata.builder().finishReason(finishReason).metadata("usage", usage).build())));
82+
GenerationMetadata.builder().finishReason(finishReason).metadata("usage", usage).build())));
8383
}
8484
return new ChatResponse(List.of(new Generation(new AssistantMessage(g.text()))));
8585
});

‎models/spring-ai-bedrock/src/main/java/org/springframework/ai/bedrock/jurassic2/BedrockAi21Jurassic2ChatModel.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
import org.springframework.ai.bedrock.jurassic2.api.Ai21Jurassic2ChatBedrockApi;
2121
import org.springframework.ai.bedrock.jurassic2.api.Ai21Jurassic2ChatBedrockApi.Ai21Jurassic2ChatRequest;
2222
import org.springframework.ai.chat.messages.AssistantMessage;
23-
import org.springframework.ai.chat.metadata.ChatGenerationMetadata;
23+
import org.springframework.ai.chat.metadata.GenerationMetadata;
2424
import org.springframework.ai.chat.model.ChatModel;
2525
import org.springframework.ai.chat.model.ChatResponse;
2626
import org.springframework.ai.chat.model.Generation;
@@ -70,7 +70,7 @@ public ChatResponse call(Prompt prompt) {
7070
return new ChatResponse(response.completions()
7171
.stream()
7272
.map(completion -> new Generation(new AssistantMessage(completion.data().text()),
73-
ChatGenerationMetadata.builder().finishReason(completion.finishReason().reason()).build()))
73+
GenerationMetadata.builder().finishReason(completion.finishReason().reason()).build()))
7474
.toList());
7575
}
7676

‎models/spring-ai-bedrock/src/main/java/org/springframework/ai/bedrock/llama/BedrockLlamaChatModel.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
import org.springframework.ai.bedrock.llama.api.LlamaChatBedrockApi.LlamaChatRequest;
2626
import org.springframework.ai.bedrock.llama.api.LlamaChatBedrockApi.LlamaChatResponse;
2727
import org.springframework.ai.chat.messages.AssistantMessage;
28-
import org.springframework.ai.chat.metadata.ChatGenerationMetadata;
28+
import org.springframework.ai.chat.metadata.GenerationMetadata;
2929
import org.springframework.ai.chat.metadata.Usage;
3030
import org.springframework.ai.chat.model.ChatModel;
3131
import org.springframework.ai.chat.model.ChatResponse;
@@ -70,7 +70,7 @@ public ChatResponse call(Prompt prompt) {
7070
LlamaChatResponse response = this.chatApi.chatCompletion(request);
7171

7272
return new ChatResponse(List.of(new Generation(new AssistantMessage(response.generation()),
73-
ChatGenerationMetadata.builder()
73+
GenerationMetadata.builder()
7474
.finishReason(response.stopReason().name())
7575
.metadata("usage", extractUsage(response))
7676
.build())));
@@ -86,7 +86,7 @@ public Flux<ChatResponse> stream(Prompt prompt) {
8686
return fluxResponse.map(response -> {
8787
String stopReason = response.stopReason() != null ? response.stopReason().name() : null;
8888
return new ChatResponse(List.of(new Generation(new AssistantMessage(response.generation()),
89-
ChatGenerationMetadata.builder()
89+
GenerationMetadata.builder()
9090
.finishReason(stopReason)
9191
.metadata("usage", extractUsage(response))
9292
.build())));

0 commit comments

Comments
 (0)