Skip to content

Commit 360b3ab

Browse files
committed
update docs
Signed-off-by: Alexandros Pappas <[email protected]>
1 parent 019bedb commit 360b3ab

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

spring-ai-docs/src/main/antora/modules/ROOT/pages/api/audio/speech/openai-speech.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ The prefix `spring.ai.openai.audio.speech` is used as the property prefix that l
8585
| spring.ai.openai.audio.speech.api-key | The API Key | -
8686
| spring.ai.openai.audio.speech.organization-id | Optionally you can specify which organization used for an API request. | -
8787
| spring.ai.openai.audio.speech.project-id | Optionally, you can specify which project is used for an API request. | -
88-
| spring.ai.openai.audio.speech.options.model | ID of the model to use for generating the audio. For OpenAI's TTS API, use one of the available models: tts-1 or tts-1-hd. | tts-1
88+
| spring.ai.openai.audio.speech.options.model | ID of the model to use for generating the audio. Available models: `gpt-4o-mini-tts` (default, optimized for speed and cost), `gpt-4o-tts` (higher quality), `tts-1` (legacy, optimized for speed), or `tts-1-hd` (legacy, optimized for quality). | gpt-4o-mini-tts
8989
| spring.ai.openai.audio.speech.options.voice | The voice to use for synthesis. For OpenAI's TTS API, One of the available voices for the chosen model: alloy, echo, fable, onyx, nova, and shimmer. | alloy
9090
| spring.ai.openai.audio.speech.options.response-format | The format of the audio output. Supported formats are mp3, opus, aac, flac, wav, and pcm. | mp3
9191
| spring.ai.openai.audio.speech.options.speed | The speed of the voice synthesis. The acceptable range is from 0.25 (slowest) to 4.0 (fastest). | 1.0
@@ -107,7 +107,7 @@ For example:
107107
[source,java]
108108
----
109109
OpenAiAudioSpeechOptions speechOptions = OpenAiAudioSpeechOptions.builder()
110-
.model("tts-1")
110+
.model("gpt-4o-mini-tts")
111111
.voice(OpenAiAudioApi.SpeechRequest.Voice.ALLOY)
112112
.responseFormat(OpenAiAudioApi.SpeechRequest.AudioResponseFormat.MP3)
113113
.speed(1.0f)
@@ -153,7 +153,7 @@ var openAiAudioSpeechModel = new OpenAiAudioSpeechModel(openAiAudioApi);
153153
var speechOptions = OpenAiAudioSpeechOptions.builder()
154154
.responseFormat(OpenAiAudioApi.SpeechRequest.AudioResponseFormat.MP3)
155155
.speed(1.0f)
156-
.model(OpenAiAudioApi.TtsModel.TTS_1.value)
156+
.model(OpenAiAudioApi.TtsModel.GPT_4_O_MINI_TTS.value)
157157
.build();
158158
159159
var speechPrompt = new SpeechPrompt("Hello, this is a text-to-speech example.", speechOptions);
@@ -181,7 +181,7 @@ OpenAiAudioSpeechOptions speechOptions = OpenAiAudioSpeechOptions.builder()
181181
.voice(OpenAiAudioApi.SpeechRequest.Voice.ALLOY)
182182
.speed(1.0f)
183183
.responseFormat(OpenAiAudioApi.SpeechRequest.AudioResponseFormat.MP3)
184-
.model(OpenAiAudioApi.TtsModel.TTS_1.value)
184+
.model(OpenAiAudioApi.TtsModel.GPT_4_O_MINI_TTS.value)
185185
.build();
186186
187187
SpeechPrompt speechPrompt = new SpeechPrompt("Today is a wonderful day to build something people love!", speechOptions);

spring-ai-docs/src/main/antora/modules/ROOT/pages/api/audio/transcriptions/openai-transcriptions.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ The prefix `spring.ai.openai.audio.transcription` is used as the property prefix
8383
| spring.ai.openai.audio.transcription.api-key | The API Key | -
8484
| spring.ai.openai.audio.transcription.organization-id | Optionally you can specify which organization used for an API request. | -
8585
| spring.ai.openai.audio.transcription.project-id | Optionally, you can specify which project is used for an API request. | -
86-
| spring.ai.openai.audio.transcription.options.model | ID of the model to use. Only whisper-1 (which is powered by our open source Whisper V2 model) is currently available. | whisper-1
86+
| spring.ai.openai.audio.transcription.options.model | ID of the model to use for transcription. Available models: `gpt-4o-transcribe` (speech-to-text powered by GPT-4o), `gpt-4o-mini-transcribe` (speech-to-text powered by GPT-4o mini), or `whisper-1` (general-purpose speech recognition model, default). | whisper-1
8787
| spring.ai.openai.audio.transcription.options.response-format | The format of the transcript output, in one of these options: json, text, srt, verbose_json, or vtt. | json
8888
| spring.ai.openai.audio.transcription.options.prompt | An optional text to guide the model's style or continue a previous audio segment. The prompt should match the audio language. |
8989
| spring.ai.openai.audio.transcription.options.language | The language of the input audio. Supplying the input language in ISO-639-1 format will improve accuracy and latency. |

0 commit comments

Comments
 (0)