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

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

Constructor	Description
OpenAiAudioSpeechOptions()

Method Summary

Modifier and Type	Method	Description
static OpenAiAudioSpeechOptions.Builder	builder()
OpenAiAudioSpeechOptions	copy()	Returns a copy of this TextToSpeechOptions.
boolean	equals(Object o)
@Nullable String	getFormat()	Returns the output format for the generated audio.
@Nullable String	getInput()
@Nullable String	getModel()	Returns the model to use for text-to-speech.
@Nullable String	getResponseFormat()
@Nullable Double	getSpeed()	Returns the speed of the generated speech.
@Nullable String	getVoice()	Returns the voice to use for text-to-speech.
int	hashCode()
void	setInput(@Nullable String input)
void	setModel(@Nullable String model)
void	setResponseFormat(@Nullable String responseFormat)
void	setResponseFormat(@Nullable OpenAiAudioSpeechOptions.AudioResponseFormat responseFormat)
void	setSpeed(@Nullable Double speed)
void	setVoice(@Nullable String voice)
void	setVoice(@Nullable OpenAiAudioSpeechOptions.Voice voice)
String	toString()

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

getApiKey, getBaseUrl, getCredential, getCustomHeaders, getDeploymentName, getMaxRetries, getMicrosoftDeploymentName, getMicrosoftFoundryServiceVersion, getOrganizationId, getProxy, getTimeout, isGitHubModels, isMicrosoftFoundry, setApiKey, setBaseUrl, setCredential, setCustomHeaders, setDeploymentName, setGitHubModels, setMaxRetries, setMicrosoftDeploymentName, setMicrosoftFoundry, setMicrosoftFoundryServiceVersion, setOrganizationId, setProxy, setTimeout

Methods inherited from class java.lang.Object

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

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

public OpenAiAudioSpeechOptions()

Method Details

builder

public static OpenAiAudioSpeechOptions.Builder builder()

getModel

public @Nullable String getModel()

Description copied from interface: TextToSpeechOptions

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

Specified by:

getModel in interface TextToSpeechOptions

Overrides:

getModel in class AbstractOpenAiOptions

Returns:

The model name.

setModel

public void setModel(@Nullable String model)

Overrides:

setModel in class AbstractOpenAiOptions

getInput

public @Nullable String getInput()

setInput

public void setInput(@Nullable String input)

getVoice

public @Nullable 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.

setVoice

public void setVoice(@Nullable String voice)

setVoice

public void setVoice(@Nullable OpenAiAudioSpeechOptions.Voice voice)

getResponseFormat

public @Nullable String getResponseFormat()

setResponseFormat

public void setResponseFormat(@Nullable String responseFormat)

setResponseFormat

public void setResponseFormat(@Nullable OpenAiAudioSpeechOptions.AudioResponseFormat responseFormat)

getSpeed

public @Nullable Double getSpeed()

Description copied from interface: TextToSpeechOptions

Returns the speed of the generated speech.

Specified by:

getSpeed in interface TextToSpeechOptions

Returns:

The speech speed.

setSpeed

public void setSpeed(@Nullable Double 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").

copy

public OpenAiAudioSpeechOptions copy()

Description copied from interface: TextToSpeechOptions

Returns a copy of this TextToSpeechOptions.

Specified by:

copy in interface TextToSpeechOptions

Returns:

a copy of this TextToSpeechOptions

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object