Package org.springframework.ai.openai

Class OpenAiAudioSpeechModel

java.lang.Object

org.springframework.ai.openai.OpenAiAudioSpeechModel

All Implemented Interfaces:

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

public final class OpenAiAudioSpeechModel
extends Object
implements TextToSpeechModel

OpenAI audio speech client implementation using the OpenAI Java SDK.

Author:

Ahmed Yousri, Hyunjoon Choi, Thomas Vitale, Jonghoon Park, Ilayaperumal Gopinathan

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OpenAiAudioSpeechModel.Builder	Builder for creating OpenAiAudioSpeechModel instances.

Method Summary

Modifier and Type	Method	Description
static OpenAiAudioSpeechModel.Builder	builder()	Creates a new builder instance with default configuration.
byte[]	call(String text)
TextToSpeechResponse	call(TextToSpeechPrompt prompt)	Executes a method call to the AI model.
TextToSpeechOptions	getDefaultOptions()
OpenAiAudioSpeechModel.Builder	mutate()	Creates a builder initialized with this model's configuration.
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

Method Details

builder

public static OpenAiAudioSpeechModel.Builder builder()

Creates a new builder instance with default configuration.

Returns:

A new builder instance

mutate

public OpenAiAudioSpeechModel.Builder mutate()

Creates a builder initialized with this model's configuration.

Returns:

A builder for creating a modified copy

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)

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

getDefaultOptions

public TextToSpeechOptions getDefaultOptions()

Specified by:

getDefaultOptions in interface TextToSpeechModel