From 369fbf8f8bc6238e5a5958a637ae66218c4797cf Mon Sep 17 00:00:00 2001
From: xsg22 <111886011+xsg22@users.noreply.github.com>
Date: Mon, 3 Jun 2024 20:57:56 +0800
Subject: [PATCH] Update documentation for OpenAiApi.ChatCompletionRequest's
 constructor

---
 .../java/org/springframework/ai/openai/api/OpenAiApi.java  | 7 +++----
 1 file changed, 3 insertions(+), 4 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
index a491bf000..796874d35 100644
--- 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
@@ -350,7 +350,7 @@ public class OpenAiApi {
 			@JsonProperty("user") String user) {
 
 		/**
-		 * Shortcut constructor for a chat completion request with the given messages and model.
+		 * Shortcut constructor for a chat completion request with the given messages, model and temperature.
 		 *
 		 * @param messages A list of messages comprising the conversation so far.
 		 * @param model ID of the model to use.
@@ -363,7 +363,7 @@ public class OpenAiApi {
 		}
 
 		/**
-		 * Shortcut constructor for a chat completion request with the given messages, model and control for streaming.
+		 * Shortcut constructor for a chat completion request with the given messages, model, temperature and control for streaming.
 		 *
 		 * @param messages A list of messages comprising the conversation so far.
 		 * @param model ID of the model to use.
@@ -394,8 +394,7 @@ public class OpenAiApi {
 		}
 
 				/**
-		 * Shortcut constructor for a chat completion request with the given messages, model, tools and tool choice.
-		 * Streaming is set to false, temperature to 0.8 and all other parameters are null.
+		 * Shortcut constructor for a chat completion request with the given messages for streaming.
 		 *
 		 * @param messages A list of messages comprising the conversation so far.
 		 * @param stream If set, partial message deltas will be sent.Tokens will be sent as data-only server-sent events