Record Class OpenAiAudioApi.SpeechRequest

java.lang.Object

java.lang.Record

org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest

Record Components:

model - The model to use for generating the audio. One of the available TTS models: tts-1, tts-1-hd, or gpt-4o-mini-tts.

input - The input text to synthesize. Must be at most 4096 tokens long.

voice - The voice to use for synthesis. One of the available voices for the chosen model: 'alloy', 'ash', 'ballad', 'coral', 'echo', 'fable', 'onyx', 'nova', 'sage', 'shimmer', and 'verse'.

responseFormat - The format to audio in. Supported formats are mp3, opus, aac, flac, wav, and pcm. Defaults to mp3.

speed - The speed of the voice synthesis. The acceptable range is from 0.25 (slowest) to 4.0 (fastest). Does not work with gpt-4o-mini-tts.

Enclosing class:

OpenAiAudioApi

public static record OpenAiAudioApi.SpeechRequest(String model, String input, String voice, OpenAiAudioApi.SpeechRequest.AudioResponseFormat responseFormat, Double speed)
extends Record

Request to generates audio from the input text. Reference: Create Speech

Since:

0.8.1

Author:

Christian Tzolov, Ilayaperumal Gopinathan, Jonghoon Park, Filip Hrisafov, Alexandros Pappas

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	OpenAiAudioApi.SpeechRequest.AudioResponseFormat	The format to audio in.
static final class	OpenAiAudioApi.SpeechRequest.Builder	Builder for the SpeechRequest.
static enum	OpenAiAudioApi.SpeechRequest.Voice	The voice to use for synthesis.

Constructor Summary

Constructors

Constructor	Description
SpeechRequest(String model, String input, String voice, OpenAiAudioApi.SpeechRequest.AudioResponseFormat responseFormat, Double speed)	Creates an instance of a SpeechRequest record class.

Method Summary

Modifier and Type	Method	Description
static OpenAiAudioApi.SpeechRequest.Builder	builder()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	input()	Returns the value of the input record component.
String	model()	Returns the value of the model record component.
OpenAiAudioApi.SpeechRequest.AudioResponseFormat	responseFormat()	Returns the value of the responseFormat record component.
Double	speed()	Returns the value of the speed record component.
final String	toString()	Returns a string representation of this record class.
String	voice()	Returns the value of the voice record component.

Methods inherited from class Object

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

Constructor Details

SpeechRequest

public SpeechRequest(String model,
 String input,
 String voice,
 OpenAiAudioApi.SpeechRequest.AudioResponseFormat responseFormat,
 Double speed)

Creates an instance of a SpeechRequest record class.

Parameters:

model - the value for the model record component

input - the value for the input record component

voice - the value for the voice record component

responseFormat - the value for the responseFormat record component

speed - the value for the speed record component

Method Details

builder

public static OpenAiAudioApi.SpeechRequest.Builder builder()

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

model

public String model()

Returns the value of the model record component.

Returns:

the value of the model record component

input

public String input()

Returns the value of the input record component.

Returns:

the value of the input record component

voice

public String voice()

Returns the value of the voice record component.

Returns:

the value of the voice record component

responseFormat

public OpenAiAudioApi.SpeechRequest.AudioResponseFormat responseFormat()

Returns the value of the responseFormat record component.

Returns:

the value of the responseFormat record component

speed

public Double speed()

Returns the value of the speed record component.

Returns:

the value of the speed record component