Package org.springframework.ai.elevenlabs

Class ElevenLabsTextToSpeechModel

java.lang.Object

org.springframework.ai.elevenlabs.ElevenLabsTextToSpeechModel

All Implemented Interfaces:

StreamingTextToSpeechModel, TextToSpeechModel, Model<TextToSpeechPrompt,TextToSpeechResponse>, StreamingModel<TextToSpeechPrompt,TextToSpeechResponse>

public class ElevenLabsTextToSpeechModel
extends Object
implements TextToSpeechModel

Implementation of the TextToSpeechModel interface for ElevenLabs TTS API.

Author:

Alexandros Pappas, Sebastien Deleuze

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ElevenLabsTextToSpeechModel.Builder

Constructor Summary

Constructors

Constructor	Description
ElevenLabsTextToSpeechModel(ElevenLabsApi elevenLabsApi, ElevenLabsTextToSpeechOptions options)
ElevenLabsTextToSpeechModel(ElevenLabsApi elevenLabsApi, ElevenLabsTextToSpeechOptions options, org.springframework.core.retry.RetryTemplate retryTemplate)
ElevenLabsTextToSpeechModel(ElevenLabsApi elevenLabsApi, ElevenLabsTextToSpeechOptions options, org.springframework.core.retry.RetryTemplate retryTemplate, io.micrometer.observation.ObservationRegistry observationRegistry)	Creates a model that reports its calls to the given observation registry.

Method Summary

Modifier and Type	Method	Description
static ElevenLabsTextToSpeechModel.Builder	builder()
TextToSpeechResponse	call(TextToSpeechPrompt prompt)	Executes a method call to the AI model.
ElevenLabsTextToSpeechOptions	getDefaultOptions()	Deprecated, for removal: This API element is subject to removal in a future version. use getOptions() instead.
ElevenLabsTextToSpeechOptions	getOptions()	Gets the options for this model.
void	setObservationConvention(TextToSpeechModelObservationConvention observationConvention)	Use the provided convention for reporting observation data.
reactor.core.publisher.Flux<TextToSpeechResponse>	stream(TextToSpeechPrompt prompt)	Executes a method call to the AI model.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.ai.audio.tts.StreamingTextToSpeechModel

stream, stream

Methods inherited from interface org.springframework.ai.audio.tts.TextToSpeechModel

call

Constructor Details

ElevenLabsTextToSpeechModel

public ElevenLabsTextToSpeechModel(ElevenLabsApi elevenLabsApi,
 ElevenLabsTextToSpeechOptions options)

ElevenLabsTextToSpeechModel

public ElevenLabsTextToSpeechModel(ElevenLabsApi elevenLabsApi,
 ElevenLabsTextToSpeechOptions options,
 org.springframework.core.retry.RetryTemplate retryTemplate)

ElevenLabsTextToSpeechModel

public ElevenLabsTextToSpeechModel(ElevenLabsApi elevenLabsApi,
 ElevenLabsTextToSpeechOptions options,
 org.springframework.core.retry.RetryTemplate retryTemplate,
 io.micrometer.observation.ObservationRegistry observationRegistry)

Creates a model that reports its calls to the given observation registry.

Parameters:

elevenLabsApi - the ElevenLabs API client

options - the default options

retryTemplate - the retry template

observationRegistry - the observation registry, ObservationRegistry.NOOP for none

Since:

2.0.2

Method Details

setObservationConvention

public void setObservationConvention(TextToSpeechModelObservationConvention observationConvention)

Use the provided convention for reporting observation data.

Parameters:

observationConvention - the provided convention

Since:

2.0.2

builder

public static ElevenLabsTextToSpeechModel.Builder builder()

call

public TextToSpeechResponse call(TextToSpeechPrompt prompt)

Description copied from interface: Model

Executes a method call to the AI model.

Specified by:

call in interface Model<TextToSpeechPrompt,TextToSpeechResponse>

Specified by:

call in interface TextToSpeechModel

Parameters:

prompt - the request object to be sent to the AI model

Returns:

the response from the AI model

stream

public reactor.core.publisher.Flux<TextToSpeechResponse> stream(TextToSpeechPrompt prompt)

Description copied from interface: StreamingModel

Executes a method call to the AI model.

Specified by:

stream in interface StreamingModel<TextToSpeechPrompt,TextToSpeechResponse>

Specified by:

stream in interface StreamingTextToSpeechModel

Parameters:

prompt - the request object to be sent to the AI model

Returns:

the streaming response from the AI model

getOptions

public ElevenLabsTextToSpeechOptions getOptions()

Description copied from interface: TextToSpeechModel

Gets the options for this model.

Specified by:

getOptions in interface TextToSpeechModel

Returns:

the options

Since:

2.0.0

getDefaultOptions

@Deprecated(forRemoval=true)
public ElevenLabsTextToSpeechOptions getDefaultOptions()

Deprecated, for removal: This API element is subject to removal in a future version.

use getOptions() instead.

Specified by:

getDefaultOptions in interface TextToSpeechModel