Update OpenAI chat UML diagram

spring-projects · Aug 9, 2024 · af25430 · af25430
1 parent 2da161c
commit af25430
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/models/spring-ai-openai/src/main/java/org/springframework/ai/openai/api/OpenAiApi.java b/models/spring-ai-openai/src/main/java/org/springframework/ai/openai/api/OpenAiApi.java
@@ -922,6 +922,8 @@ public record Usage(// @formatter:off
 	 * the model runs with. Can be used in conjunction with the seed request parameter to
 	 * understand when backend changes have been made that might impact determinism.
 	 * @param object The object type, which is always 'chat.completion.chunk'.
+	 * @param usage Usage statistics for the completion request. Present in the last chunk
+	 * only if the StreamOptions.includeUsage is set to true.
 	 */
 	@JsonInclude(Include.NON_NULL)
 	public record ChatCompletionChunk(// @formatter:off

diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/images/openai-chat-api.jpg b/spring-ai-docs/src/main/antora/modules/ROOT/images/openai-chat-api.jpg