Class OpenAiAudioSpeechModel

java.lang.Object

org.springframework.ai.openai.OpenAiAudioSpeechModel

All Implemented Interfaces:

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

public class OpenAiAudioSpeechModel
extends Object
implements TextToSpeechModel

OpenAI audio speech client implementation for backed by OpenAiAudioApi.

Since:

1.0.0-M1

Author:

Ahmed Yousri, Hyunjoon Choi, Thomas Vitale, Jonghoon Park

See Also:

• OpenAiAudioApi

Constructor Summary

Constructors

Constructor	Description
OpenAiAudioSpeechModel(OpenAiAudioApi audioApi)	Initializes a new instance of the OpenAiAudioSpeechModel class with the provided OpenAiAudioApi.
OpenAiAudioSpeechModel(OpenAiAudioApi audioApi, OpenAiAudioSpeechOptions options)	Initializes a new instance of the OpenAiAudioSpeechModel class with the provided OpenAiAudioApi and options.
OpenAiAudioSpeechModel(OpenAiAudioApi audioApi, OpenAiAudioSpeechOptions options, org.springframework.core.retry.RetryTemplate retryTemplate)	Initializes a new instance of the OpenAiAudioSpeechModel class with the provided OpenAiAudioApi and options.

Method Summary

Modifier and Type	Method	Description
byte[]	call(String text)
TextToSpeechResponse	call(TextToSpeechPrompt prompt)	Executes a method call to the AI model.
TextToSpeechOptions	getDefaultOptions()
reactor.core.publisher.Flux<TextToSpeechResponse>	stream(TextToSpeechPrompt prompt)	Streams the audio response for the given speech prompt.

Methods inherited from class Object

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

Methods inherited from interface StreamingTextToSpeechModel

stream, stream

Constructor Details

OpenAiAudioSpeechModel

public OpenAiAudioSpeechModel(OpenAiAudioApi audioApi)

Initializes a new instance of the OpenAiAudioSpeechModel class with the provided OpenAiAudioApi. It uses the model tts-1, response format mp3, voice alloy, and the default speed of 1.0.

Parameters:

audioApi - The OpenAiAudioApi to use for speech synthesis.

OpenAiAudioSpeechModel

public OpenAiAudioSpeechModel(OpenAiAudioApi audioApi,
 OpenAiAudioSpeechOptions options)

Initializes a new instance of the OpenAiAudioSpeechModel class with the provided OpenAiAudioApi and options.

Parameters:

audioApi - The OpenAiAudioApi to use for speech synthesis.

options - The OpenAiAudioSpeechOptions containing the speech synthesis options.

OpenAiAudioSpeechModel

public OpenAiAudioSpeechModel(OpenAiAudioApi audioApi,
 OpenAiAudioSpeechOptions options,
 org.springframework.core.retry.RetryTemplate retryTemplate)

Initializes a new instance of the OpenAiAudioSpeechModel class with the provided OpenAiAudioApi and options.

Parameters:

audioApi - The OpenAiAudioApi to use for speech synthesis.

options - The OpenAiAudioSpeechOptions containing the speech synthesis options.

retryTemplate - The retry template.

Method Details

call

public byte[] call(String text)

Specified by:

call in interface TextToSpeechModel

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)

Streams the audio response for the given speech prompt.

Specified by:

stream in interface StreamingModel<TextToSpeechPrompt, TextToSpeechResponse>

Specified by:

stream in interface StreamingTextToSpeechModel

Parameters:

prompt - The speech prompt containing the text and options for speech synthesis.

Returns:

A Flux of TextToSpeechResponse objects containing the streamed audio and metadata.

getDefaultOptions

public TextToSpeechOptions getDefaultOptions()

Specified by:

getDefaultOptions in interface TextToSpeechModel