Spring/spring-ai
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update documentation for OpenAiApi.ChatCompletionRequest's constructor

Browse Source
This commit is contained in:
xsg22
2024-06-03 20:57:56 +08:00
committed by Christian Tzolov
parent ccddc53f71
commit 369fbf8f8b
1 changed files with 3 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
models/spring-ai-openai/src/main/java/org/springframework/ai/openai/api/OpenAiApi.java
View File

@@ -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