Package org.springframework.ai.audio.tts

Interface TextToSpeechOptions

All Superinterfaces:

ModelOptions

All Known Implementing Classes:

DefaultTextToSpeechOptions, ElevenLabsTextToSpeechOptions

public interface TextToSpeechOptions
extends ModelOptions

Interface for text-to-speech model options. Defines the common, portable options that should be supported by all implementations.

Author:

Alexandros Pappas

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	TextToSpeechOptions.Builder	Builder for TextToSpeechOptions.

Method Summary

Modifier and Type	Method	Description
static TextToSpeechOptions.Builder	builder()	Creates a new TextToSpeechOptions.Builder to create the default TextToSpeechOptions.
<T extends TextToSpeechOptions> T	copy()	Returns a copy of this TextToSpeechOptions.
String	getFormat()	Returns the output format for the generated audio.
String	getModel()	Returns the model to use for text-to-speech.
Double	getSpeed()	Returns the speed of the generated speech.
String	getVoice()	Returns the voice to use for text-to-speech.

Method Details

builder

static TextToSpeechOptions.Builder builder()

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

Returns:

Returns a new TextToSpeechOptions.Builder.

getModel

@Nullable
String getModel()

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

Returns:

The model name.

getVoice

@Nullable
String getVoice()

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

Returns:

The voice identifier.

getFormat

@Nullable
String getFormat()

Returns the output format for the generated audio.

Returns:

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

getSpeed

@Nullable
Double getSpeed()

Returns the speed of the generated speech.

Returns:

The speech speed.

copy

<T extends TextToSpeechOptions> T copy()

Returns a copy of this TextToSpeechOptions.

Returns:

a copy of this TextToSpeechOptions