Package org.springframework.ai.openai

Class OpenAiAudioSpeechOptions

java.lang.Object

org.springframework.ai.openai.OpenAiAudioSpeechOptions

All Implemented Interfaces:

TextToSpeechOptions, ModelOptions

public class OpenAiAudioSpeechOptions
extends Object
implements TextToSpeechOptions

Options for OpenAI text to audio - speech synthesis.

Since:

1.0.0-M1

Author:

Ahmed Yousri, Hyunjoon Choi, Ilayaperumal Gopinathan, Jonghoon Park

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OpenAiAudioSpeechOptions.Builder

Constructor Summary

Constructors

Constructor	Description
OpenAiAudioSpeechOptions()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

OpenAiAudioSpeechOptions

public OpenAiAudioSpeechOptions()

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.

getModel

public String getModel()

Description copied from interface: TextToSpeechOptions

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

Specified by:

getModel in interface TextToSpeechOptions

Returns:

The model name.

setModel

public void setModel(String model)

getInput

public String getInput()

setInput

public void setInput(String input)

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.

setVoice

public void setVoice(String voice)

setVoice

public void setVoice(OpenAiAudioApi.SpeechRequest.Voice voice)

getResponseFormat

public OpenAiAudioApi.SpeechRequest.AudioResponseFormat getResponseFormat()

setResponseFormat

public void setResponseFormat(OpenAiAudioApi.SpeechRequest.AudioResponseFormat responseFormat)

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.

setSpeed

public void setSpeed(Double speed)

getFormat

public 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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object