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

Fix Javadoc comments in OpenAiAudioApi and OpenAiApi

Browse Source 
- Correct OpenAiAudioApi Javadoc: remove chat completion reference
- Add missing @param for webClientBuilder in OpenAiApi constructor
This commit is contained in:
inpink
2024-09-09 19:59:22 +09:00
committed by Mark Pollack
parent 3c9ae4e1d6
commit 897a4114f5
2 changed files with 11 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -93,6 +93,7 @@ public class OpenAiApi {
* @param baseUrl api base URL.
* @param apiKey OpenAI apiKey.
* @param restClientBuilder RestClient builder.
* @param webClientBuilder WebClient builder.
*/
public OpenAiApi(String baseUrl, String apiKey, RestClient.Builder restClientBuilder,
WebClient.Builder webClientBuilder) {
@@ -104,6 +105,7 @@ public class OpenAiApi {
* @param baseUrl api base URL.
* @param apiKey OpenAI apiKey.
* @param restClientBuilder RestClient builder.
* @param webClientBuilder WebClient builder.
* @param responseErrorHandler Response error handler.
*/
public OpenAiApi(String baseUrl, String apiKey, RestClient.Builder restClientBuilder,
@@ -116,7 +118,10 @@ public class OpenAiApi {
* Create a new chat completion api.
* @param baseUrl api base URL.
* @param apiKey OpenAI apiKey.
* @param completionsPath the path to the chat completions endpoint.
* @param embeddingsPath the path to the embeddings endpoint.
* @param restClientBuilder RestClient builder.
* @param webClientBuilder WebClient builder.
* @param responseErrorHandler Response error handler.
*/
public OpenAiApi(String baseUrl, String apiKey, String completionsPath, String embeddingsPath,
@@ -132,7 +137,10 @@ public class OpenAiApi {
* @param baseUrl api base URL.
* @param apiKey OpenAI apiKey.
* @param headers the http headers to use.
* @param completionsPath the path to the chat completions endpoint.
* @param embeddingsPath the path to the embeddings endpoint.
* @param restClientBuilder RestClient builder.
* @param webClientBuilder WebClient builder.
* @param responseErrorHandler Response error handler.
*/
public OpenAiApi(String baseUrl, String apiKey, MultiValueMap<String, String> headers, String completionsPath,

6
models/spring-ai-openai/src/main/java/org/springframework/ai/openai/api/OpenAiAudioApi.java
View File

@@ -62,7 +62,7 @@ public class OpenAiAudioApi {
}
/**
* Create an new chat completion api.
* Create a new audio api.
* @param baseUrl api base URL.
* @param openAiToken OpenAI apiKey.
* @param restClientBuilder RestClient builder.
@@ -81,7 +81,7 @@ public class OpenAiAudioApi {
}
/**
* Create an new chat completion api.
* Create a new audio api.
* @param baseUrl api base URL.
* @param apiKey OpenAI apiKey.
* @param restClientBuilder RestClient builder.
@@ -96,7 +96,7 @@ public class OpenAiAudioApi {
}
/**
* Create an new chat completion api.
* Create a new audio api.
* @param baseUrl api base URL.
* @param apiKey OpenAI apiKey.
* @param headers the http headers to use.