From 6538d73afbf5f36d59af13f579d831240104723d Mon Sep 17 00:00:00 2001 From: devholic22 Date: Sun, 23 Jun 2024 19:44:59 +0900 Subject: [PATCH 1/3] Add comments in OpenAiAudioSpeechModel * Add comments in OpenAiAudioSpeechModel like OpenAiChatModel --- .../ai/openai/OpenAiAudioSpeechModel.java | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/models/spring-ai-openai/src/main/java/org/springframework/ai/openai/OpenAiAudioSpeechModel.java b/models/spring-ai-openai/src/main/java/org/springframework/ai/openai/OpenAiAudioSpeechModel.java index 027ee50be9..f85eb7be5a 100644 --- a/models/spring-ai-openai/src/main/java/org/springframework/ai/openai/OpenAiAudioSpeechModel.java +++ b/models/spring-ai-openai/src/main/java/org/springframework/ai/openai/OpenAiAudioSpeechModel.java @@ -41,6 +41,7 @@ * OpenAI audio speech client implementation for backed by {@link OpenAiAudioApi}. * * @author Ahmed Yousri + * @author Hyunjoon Choi * @see OpenAiAudioApi * @since 1.0.0-M1 */ @@ -48,16 +49,29 @@ public class OpenAiAudioSpeechModel implements SpeechModel, StreamingSpeechModel private final Logger logger = LoggerFactory.getLogger(getClass()); + /** + * The default options used for the audio completion requests. + */ private final OpenAiAudioSpeechOptions defaultOptions; + /** + * The speed of the default voice synthesis. + * @see OpenAiAudioSpeechOptions + */ private static final Float SPEED = 1.0f; + /** + * The retry template used to retry the OpenAI Audio API calls. + */ public final RetryTemplate retryTemplate = RetryTemplate.builder() .maxAttempts(10) .retryOn(OpenAiApiException.class) .exponentialBackoff(Duration.ofMillis(2000), 5, Duration.ofMillis(3 * 60000)) .build(); + /** + * Low-level access to the OpenAI Audio API. + */ private final OpenAiAudioApi audioApi; /** From 912091dcfdc7975e9e2ae4231b11f546752d88e9 Mon Sep 17 00:00:00 2001 From: devholic22 Date: Sun, 23 Jun 2024 19:46:12 +0900 Subject: [PATCH 2/3] Remove duplicated comment in OpenAiAudioSpeechOptions * Remove duplicated word in OpenAiAudioSpeechOptions AudioResponseFormat comment --- .../springframework/ai/openai/OpenAiAudioSpeechOptions.java | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/models/spring-ai-openai/src/main/java/org/springframework/ai/openai/OpenAiAudioSpeechOptions.java b/models/spring-ai-openai/src/main/java/org/springframework/ai/openai/OpenAiAudioSpeechOptions.java index bcf551ac83..a05965e453 100644 --- a/models/spring-ai-openai/src/main/java/org/springframework/ai/openai/OpenAiAudioSpeechOptions.java +++ b/models/spring-ai-openai/src/main/java/org/springframework/ai/openai/OpenAiAudioSpeechOptions.java @@ -26,6 +26,7 @@ * Options for OpenAI text to audio - speech synthesis. * * @author Ahmed Yousri + * @author Hyunjoon Choi * @since 1.0.0-M1 */ @JsonInclude(JsonInclude.Include.NON_NULL) @@ -53,7 +54,7 @@ public class OpenAiAudioSpeechOptions implements ModelOptions { /** * The format of the audio output. Supported formats are mp3, opus, aac, and flac. - * Defaults to mp3. Defaults to mp3 + * Defaults to mp3. */ @JsonProperty("response_format") private AudioResponseFormat responseFormat; From cd6fc0e54495a427f85c62a5319f6b0ecccfcf80 Mon Sep 17 00:00:00 2001 From: devholic22 Date: Tue, 2 Jul 2024 23:49:16 +0900 Subject: [PATCH 3/3] Add comments in OpenAiAudioSpeechModel * Add comments in OpenAiAudioSpeechModel like OpenAiChatModel * Remove duplicated word in OpenAiAudioSpeechOptions AudioResponseFormat comment --- .../ai/openai/OpenAiAudioSpeechModel.java | 14 ++++++++++++++ .../ai/openai/OpenAiAudioSpeechOptions.java | 3 ++- 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/models/spring-ai-openai/src/main/java/org/springframework/ai/openai/OpenAiAudioSpeechModel.java b/models/spring-ai-openai/src/main/java/org/springframework/ai/openai/OpenAiAudioSpeechModel.java index 027ee50be9..f85eb7be5a 100644 --- a/models/spring-ai-openai/src/main/java/org/springframework/ai/openai/OpenAiAudioSpeechModel.java +++ b/models/spring-ai-openai/src/main/java/org/springframework/ai/openai/OpenAiAudioSpeechModel.java @@ -41,6 +41,7 @@ * OpenAI audio speech client implementation for backed by {@link OpenAiAudioApi}. * * @author Ahmed Yousri + * @author Hyunjoon Choi * @see OpenAiAudioApi * @since 1.0.0-M1 */ @@ -48,16 +49,29 @@ public class OpenAiAudioSpeechModel implements SpeechModel, StreamingSpeechModel private final Logger logger = LoggerFactory.getLogger(getClass()); + /** + * The default options used for the audio completion requests. + */ private final OpenAiAudioSpeechOptions defaultOptions; + /** + * The speed of the default voice synthesis. + * @see OpenAiAudioSpeechOptions + */ private static final Float SPEED = 1.0f; + /** + * The retry template used to retry the OpenAI Audio API calls. + */ public final RetryTemplate retryTemplate = RetryTemplate.builder() .maxAttempts(10) .retryOn(OpenAiApiException.class) .exponentialBackoff(Duration.ofMillis(2000), 5, Duration.ofMillis(3 * 60000)) .build(); + /** + * Low-level access to the OpenAI Audio API. + */ private final OpenAiAudioApi audioApi; /** diff --git a/models/spring-ai-openai/src/main/java/org/springframework/ai/openai/OpenAiAudioSpeechOptions.java b/models/spring-ai-openai/src/main/java/org/springframework/ai/openai/OpenAiAudioSpeechOptions.java index bcf551ac83..a05965e453 100644 --- a/models/spring-ai-openai/src/main/java/org/springframework/ai/openai/OpenAiAudioSpeechOptions.java +++ b/models/spring-ai-openai/src/main/java/org/springframework/ai/openai/OpenAiAudioSpeechOptions.java @@ -26,6 +26,7 @@ * Options for OpenAI text to audio - speech synthesis. * * @author Ahmed Yousri + * @author Hyunjoon Choi * @since 1.0.0-M1 */ @JsonInclude(JsonInclude.Include.NON_NULL) @@ -53,7 +54,7 @@ public class OpenAiAudioSpeechOptions implements ModelOptions { /** * The format of the audio output. Supported formats are mp3, opus, aac, and flac. - * Defaults to mp3. Defaults to mp3 + * Defaults to mp3. */ @JsonProperty("response_format") private AudioResponseFormat responseFormat;