Package org.springframework.ai.elevenlabs

Class ElevenLabsTextToSpeechOptions

java.lang.Object

org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechOptions

All Implemented Interfaces:

TextToSpeechOptions, ModelOptions

public class ElevenLabsTextToSpeechOptions
extends Object
implements TextToSpeechOptions

Options for ElevenLabs text-to-speech.

Author:

Alexandros Pappas, Sebastien Deleuze

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ElevenLabsTextToSpeechOptions.Builder

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ElevenLabsTextToSpeechOptions(@Nullable String modelId, @Nullable String voiceId, @Nullable Boolean enableLogging, @Nullable String outputFormat, @Nullable ElevenLabsApi.SpeechRequest.VoiceSettings voiceSettings, @Nullable String languageCode, @Nullable List<ElevenLabsApi.SpeechRequest.PronunciationDictionaryLocator> pronunciationDictionaryLocators, @Nullable Integer seed, @Nullable String previousText, @Nullable String nextText, @Nullable List<String> previousRequestIds, @Nullable List<String> nextRequestIds, @Nullable ElevenLabsApi.SpeechRequest.TextNormalizationMode applyTextNormalization, @Nullable Boolean applyLanguageTextNormalization)

Method Summary

Modifier and Type	Method	Description
static ElevenLabsTextToSpeechOptions.Builder	builder()	Creates a new TextToSpeechOptions.Builder to create the default TextToSpeechOptions.
boolean	equals(@Nullable Object o)
@Nullable Boolean	getApplyLanguageTextNormalization()
@Nullable ElevenLabsApi.SpeechRequest.TextNormalizationMode	getApplyTextNormalization()
@Nullable Boolean	getEnableLogging()
@Nullable String	getFormat()	Returns the output format for the generated audio.
@Nullable String	getLanguageCode()
@Nullable String	getModel()	Returns the model to use for text-to-speech.
@Nullable String	getModelId()
@Nullable List<String>	getNextRequestIds()
@Nullable String	getNextText()
@Nullable String	getOutputFormat()
@Nullable List<String>	getPreviousRequestIds()
@Nullable String	getPreviousText()
@Nullable List<ElevenLabsApi.SpeechRequest.PronunciationDictionaryLocator>	getPronunciationDictionaryLocators()
@Nullable Integer	getSeed()
@Nullable Double	getSpeed()	Returns the speed of the generated speech.
@Nullable String	getVoice()	Returns the voice to use for text-to-speech.
@Nullable String	getVoiceId()
@Nullable ElevenLabsApi.SpeechRequest.VoiceSettings	getVoiceSettings()
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Details

ElevenLabsTextToSpeechOptions

protected ElevenLabsTextToSpeechOptions(@Nullable String modelId,
 @Nullable String voiceId,
 @Nullable Boolean enableLogging,
 @Nullable String outputFormat,
 @Nullable ElevenLabsApi.SpeechRequest.VoiceSettings voiceSettings,
 @Nullable String languageCode,
 @Nullable List<ElevenLabsApi.SpeechRequest.PronunciationDictionaryLocator> pronunciationDictionaryLocators,
 @Nullable Integer seed,
 @Nullable String previousText,
 @Nullable String nextText,
 @Nullable List<String> previousRequestIds,
 @Nullable List<String> nextRequestIds,
 @Nullable ElevenLabsApi.SpeechRequest.TextNormalizationMode applyTextNormalization,
 @Nullable Boolean applyLanguageTextNormalization)

Method Details

builder

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

getModelId

public @Nullable String getModelId()

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.

getVoiceId

public @Nullable String getVoiceId()

getEnableLogging

public @Nullable Boolean getEnableLogging()

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").

getOutputFormat

public @Nullable String getOutputFormat()

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.

getVoiceSettings

public @Nullable ElevenLabsApi.SpeechRequest.VoiceSettings getVoiceSettings()

getLanguageCode

public @Nullable String getLanguageCode()

getPronunciationDictionaryLocators

public @Nullable List<ElevenLabsApi.SpeechRequest.PronunciationDictionaryLocator> getPronunciationDictionaryLocators()

getSeed

public @Nullable Integer getSeed()

getPreviousText

public @Nullable String getPreviousText()

getNextText

public @Nullable String getNextText()

getPreviousRequestIds

public @Nullable List<String> getPreviousRequestIds()

getNextRequestIds

public @Nullable List<String> getNextRequestIds()

getApplyTextNormalization

public @Nullable ElevenLabsApi.SpeechRequest.TextNormalizationMode getApplyTextNormalization()

getApplyLanguageTextNormalization

public @Nullable Boolean getApplyLanguageTextNormalization()

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object