Package org.springframework.ai.openai

Class OpenAiAudioSpeechOptions

java.lang.Object

org.springframework.ai.openai.AbstractOpenAiOptions

org.springframework.ai.openai.OpenAiAudioSpeechOptions

All Implemented Interfaces:

TextToSpeechOptions, ModelOptions

public class OpenAiAudioSpeechOptions
extends AbstractOpenAiOptions
implements TextToSpeechOptions

Configuration options for OpenAI text-to-speech using the OpenAI Java SDK.

Author:

Ahmed Yousri, Hyunjoon Choi, Jonghoon Park, Ilayaperumal Gopinathan

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	OpenAiAudioSpeechOptions.AudioResponseFormat
static final class	OpenAiAudioSpeechOptions.Builder
static enum	OpenAiAudioSpeechOptions.Voice

Nested classes/interfaces inherited from class org.springframework.ai.openai.AbstractOpenAiOptions

AbstractOpenAiOptions.AbstractBuilder<O extends AbstractOpenAiOptions,B extends AbstractOpenAiOptions.AbstractBuilder<O,B>>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_RESPONSE_FORMAT
static final String	DEFAULT_SPEECH_MODEL
static final Double	DEFAULT_SPEED
static final String	DEFAULT_VOICE

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

DEFAULT_MAX_RETRIES, DEFAULT_TIMEOUT

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OpenAiAudioSpeechOptions(@Nullable String baseUrl, @Nullable String apiKey, @Nullable com.openai.credential.Credential credential, @Nullable String model, @Nullable String microsoftDeploymentName, @Nullable com.openai.azure.AzureOpenAIServiceVersion microsoftFoundryServiceVersion, @Nullable String organizationId, @Nullable Boolean isMicrosoftFoundry, @Nullable Boolean isGitHubModels, @Nullable Duration timeout, @Nullable Integer maxRetries, @Nullable Proxy proxy, @Nullable Map<String,String> customHeaders, @Nullable String input, @Nullable String voice, @Nullable String responseFormat, @Nullable Double speed)

Method Summary

Modifier and Type	Method	Description
static OpenAiAudioSpeechOptions.Builder	builder()	Creates a new TextToSpeechOptions.Builder to create the default TextToSpeechOptions.
boolean	equals(@Nullable Object o)
@Nullable String	getFormat()	Returns the output format for the generated audio.
@Nullable String	getInput()
String	getResponseFormat()
Double	getSpeed()	Returns the speed of the generated speech.
String	getVoice()	Returns the voice to use for text-to-speech.
int	hashCode()

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

getApiKey, getBaseUrl, getCredential, getCustomHeaders, getDeploymentName, getMaxRetries, getMicrosoftDeploymentName, getMicrosoftFoundryServiceVersion, getModel, getOrganizationId, getProxy, getTimeout, isGitHubModels, isMicrosoftFoundry

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.ai.audio.tts.TextToSpeechOptions

getModel

Field Details

DEFAULT_SPEECH_MODEL

public static final String DEFAULT_SPEECH_MODEL

See Also:

• Constant Field Values

DEFAULT_VOICE

public static final String DEFAULT_VOICE

DEFAULT_RESPONSE_FORMAT

public static final String DEFAULT_RESPONSE_FORMAT

DEFAULT_SPEED

public static final Double DEFAULT_SPEED

Constructor Details

OpenAiAudioSpeechOptions

protected OpenAiAudioSpeechOptions(@Nullable String baseUrl,
 @Nullable String apiKey,
 @Nullable com.openai.credential.Credential credential,
 @Nullable String model,
 @Nullable String microsoftDeploymentName,
 @Nullable com.openai.azure.AzureOpenAIServiceVersion microsoftFoundryServiceVersion,
 @Nullable String organizationId,
 @Nullable Boolean isMicrosoftFoundry,
 @Nullable Boolean isGitHubModels,
 @Nullable Duration timeout,
 @Nullable Integer maxRetries,
 @Nullable Proxy proxy,
 @Nullable Map<String,String> customHeaders,
 @Nullable String input,
 @Nullable String voice,
 @Nullable String responseFormat,
 @Nullable Double speed)

Method Details

builder

public static OpenAiAudioSpeechOptions.Builder builder()

Description copied from interface: TextToSpeechOptions

Creates a new TextToSpeechOptions.Builder to create the default TextToSpeechOptions.

Returns:

Returns a new TextToSpeechOptions.Builder.

getInput

public @Nullable String getInput()

getVoice

public String getVoice()

Description copied from interface: TextToSpeechOptions

Returns the voice to use for text-to-speech.

Specified by:

getVoice in interface TextToSpeechOptions

Returns:

The voice identifier.

getResponseFormat

public String getResponseFormat()

getSpeed

public Double getSpeed()

Description copied from interface: TextToSpeechOptions

Returns the speed of the generated speech.

Specified by:

getSpeed in interface TextToSpeechOptions

Returns:

The speech speed.

getFormat

public @Nullable String getFormat()

Description copied from interface: TextToSpeechOptions

Returns the output format for the generated audio.

Specified by:

getFormat in interface TextToSpeechOptions

Returns:

The output format (e.g., "mp3", "wav").

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object