Package org.springframework.ai.openai

Class OpenAiAudioSpeechOptions.Builder

java.lang.Object

org.springframework.ai.openai.AbstractOpenAiOptions.AbstractBuilder<OpenAiAudioSpeechOptions,OpenAiAudioSpeechOptions.Builder>

org.springframework.ai.openai.OpenAiAudioSpeechOptions.Builder

Enclosing class:

OpenAiAudioSpeechOptions

public static final class OpenAiAudioSpeechOptions.Builder
extends AbstractOpenAiOptions.AbstractBuilder<OpenAiAudioSpeechOptions,OpenAiAudioSpeechOptions.Builder>

Field Summary

Fields inherited from class org.springframework.ai.openai.AbstractOpenAiOptions.AbstractBuilder

apiKey, baseUrl, credential, customHeaders, isGitHubModels, isMicrosoftFoundry, maxRetries, microsoftDeploymentName, microsoftFoundryServiceVersion, model, organizationId, proxy, timeout

Method Summary

Modifier and Type	Method	Description
OpenAiAudioSpeechOptions	build()
OpenAiAudioSpeechOptions.Builder	from(OpenAiAudioSpeechOptions fromOptions)
OpenAiAudioSpeechOptions.Builder	input(@Nullable String input)
OpenAiAudioSpeechOptions.Builder	instructions(@Nullable String instructions)	Sets control instructions for the voice delivery (e.g. tone, pace).
OpenAiAudioSpeechOptions.Builder	merge(@Nullable org.springframework.ai.audio.tts.TextToSpeechOptions from)
OpenAiAudioSpeechOptions.Builder	responseFormat(@Nullable String responseFormat)
OpenAiAudioSpeechOptions.Builder	responseFormat(@Nullable OpenAiAudioSpeechOptions.AudioResponseFormat responseFormat)
OpenAiAudioSpeechOptions.Builder	speed(@Nullable Double speed)
OpenAiAudioSpeechOptions.Builder	voice(@Nullable String voice)
OpenAiAudioSpeechOptions.Builder	voice(@Nullable OpenAiAudioSpeechOptions.Voice voice)

Methods inherited from class org.springframework.ai.openai.AbstractOpenAiOptions.AbstractBuilder

apiKey, apiKey, azure, azureOpenAIServiceVersion, baseUrl, credential, customHeaders, deploymentName, gitHubModels, maxRetries, microsoftFoundry, microsoftFoundryServiceVersion, model, organizationId, proxy, self, timeout

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

from

public OpenAiAudioSpeechOptions.Builder from(OpenAiAudioSpeechOptions fromOptions)

merge

public OpenAiAudioSpeechOptions.Builder merge(@Nullable org.springframework.ai.audio.tts.TextToSpeechOptions from)

input

public OpenAiAudioSpeechOptions.Builder input(@Nullable String input)

voice

public OpenAiAudioSpeechOptions.Builder voice(@Nullable String voice)

voice

public OpenAiAudioSpeechOptions.Builder voice(@Nullable OpenAiAudioSpeechOptions.Voice voice)

responseFormat

public OpenAiAudioSpeechOptions.Builder responseFormat(@Nullable String responseFormat)

responseFormat

public OpenAiAudioSpeechOptions.Builder responseFormat(@Nullable OpenAiAudioSpeechOptions.AudioResponseFormat responseFormat)

speed

public OpenAiAudioSpeechOptions.Builder speed(@Nullable Double speed)

instructions

public OpenAiAudioSpeechOptions.Builder instructions(@Nullable String instructions)

Sets control instructions for the voice delivery (e.g. tone, pace). Only supported by models such as gpt-4o-mini-tts; ignored by tts-1 and tts-1-hd.

build

public OpenAiAudioSpeechOptions build()

Specified by:

build in class AbstractOpenAiOptions.AbstractBuilder<OpenAiAudioSpeechOptions,OpenAiAudioSpeechOptions.Builder>