Package org.springframework.ai.audio.tts

Class DefaultTextToSpeechOptions.Builder

java.lang.Object

org.springframework.ai.audio.tts.DefaultTextToSpeechOptions.Builder

All Implemented Interfaces:

TextToSpeechOptions.Builder

Enclosing class:

DefaultTextToSpeechOptions

public static final class DefaultTextToSpeechOptions.Builder
extends Object
implements TextToSpeechOptions.Builder

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DefaultTextToSpeechOptions	build()	Builds the TextToSpeechOptions.
DefaultTextToSpeechOptions.Builder	format(String format)	Sets the output format for the generated audio.
DefaultTextToSpeechOptions.Builder	model(String model)	Sets the model to use for text-to-speech.
DefaultTextToSpeechOptions.Builder	speed(Double speed)	Sets the speed of the generated speech.
DefaultTextToSpeechOptions.Builder	voice(String voice)	Sets the voice to use for text-to-speech.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

model

public DefaultTextToSpeechOptions.Builder model(String model)

Description copied from interface: TextToSpeechOptions.Builder

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

Specified by:

model in interface TextToSpeechOptions.Builder

Parameters:

model - The model name.

Returns:

This builder.

voice

public DefaultTextToSpeechOptions.Builder voice(String voice)

Description copied from interface: TextToSpeechOptions.Builder

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

Specified by:

voice in interface TextToSpeechOptions.Builder

Parameters:

voice - The voice identifier.

Returns:

This builder.

format

public DefaultTextToSpeechOptions.Builder format(String format)

Description copied from interface: TextToSpeechOptions.Builder

Sets the output format for the generated audio.

Specified by:

format in interface TextToSpeechOptions.Builder

Parameters:

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

Returns:

This builder.

speed

public DefaultTextToSpeechOptions.Builder speed(Double speed)

Description copied from interface: TextToSpeechOptions.Builder

Sets the speed of the generated speech.

Specified by:

speed in interface TextToSpeechOptions.Builder

Parameters:

speed - The speech speed.

Returns:

This builder.

build

public DefaultTextToSpeechOptions build()

Description copied from interface: TextToSpeechOptions.Builder

Builds the TextToSpeechOptions.

Specified by:

build in interface TextToSpeechOptions.Builder

Returns:

The TextToSpeechOptions.