Record Class OpenAiApi.ChatCompletionRequest.AudioParameters

java.lang.Object

java.lang.Record

org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.AudioParameters

Record Components:

voice - Specifies the voice type.

format - Specifies the output audio format.

Enclosing class:

OpenAiApi.ChatCompletionRequest

public static record OpenAiApi.ChatCompletionRequest.AudioParameters(OpenAiApi.ChatCompletionRequest.AudioParameters.Voice voice, OpenAiApi.ChatCompletionRequest.AudioParameters.AudioResponseFormat format)
extends Record

Parameters for audio output. Required when audio output is requested with outputModalities: ["audio"].

Author:

Christian Tzolov, Michael Lavelle, Mariusz Bernacki, Thomas Vitale, David Frizelle, Alexandros Pappas, Filip Hrisafov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	OpenAiApi.ChatCompletionRequest.AudioParameters.AudioResponseFormat	Specifies the output audio format.
static enum	OpenAiApi.ChatCompletionRequest.AudioParameters.Voice	Specifies the voice type.

Constructor Summary

Constructors

Constructor	Description
AudioParameters(OpenAiApi.ChatCompletionRequest.AudioParameters.Voice voice, OpenAiApi.ChatCompletionRequest.AudioParameters.AudioResponseFormat format)	Creates an instance of a AudioParameters record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
OpenAiApi.ChatCompletionRequest.AudioParameters.AudioResponseFormat	format()	Returns the value of the format record component.
final int	hashCode()	Returns a hash code value for this object.
final String	toString()	Returns a string representation of this record class.
OpenAiApi.ChatCompletionRequest.AudioParameters.Voice	voice()	Returns the value of the voice record component.

Methods inherited from class Object

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

Constructor Details

AudioParameters

public AudioParameters(OpenAiApi.ChatCompletionRequest.AudioParameters.Voice voice,
 OpenAiApi.ChatCompletionRequest.AudioParameters.AudioResponseFormat format)

Creates an instance of a AudioParameters record class.

Parameters:

voice - the value for the voice record component

format - the value for the format record component

Method Details

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.

voice

public OpenAiApi.ChatCompletionRequest.AudioParameters.Voice voice()

Returns the value of the voice record component.

Returns:

the value of the voice record component

format

public OpenAiApi.ChatCompletionRequest.AudioParameters.AudioResponseFormat format()

Returns the value of the format record component.

Returns:

the value of the format record component