Record Class OpenAiApi.ChatCompletionMessage.MediaContent.InputAudio

java.lang.Object

java.lang.Record

org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.MediaContent.InputAudio

Record Components:

data - Base64 encoded audio data.

format - The format of the encoded audio data. Currently supports "wav" and "mp3".

Enclosing class:

OpenAiApi.ChatCompletionMessage.MediaContent

public static record OpenAiApi.ChatCompletionMessage.MediaContent.InputAudio(String data, OpenAiApi.ChatCompletionMessage.MediaContent.InputAudio.Format format)
extends Record

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.ChatCompletionMessage.MediaContent.InputAudio.Format

Constructor Summary

Constructors

Constructor	Description
InputAudio(String data, OpenAiApi.ChatCompletionMessage.MediaContent.InputAudio.Format format)	Creates an instance of a InputAudio record class.

Method Summary

Modifier and Type	Method	Description
String	data()	Returns the value of the data record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
OpenAiApi.ChatCompletionMessage.MediaContent.InputAudio.Format	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.

Methods inherited from class Object

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

Constructor Details

InputAudio

public InputAudio(String data,
 OpenAiApi.ChatCompletionMessage.MediaContent.InputAudio.Format format)

Creates an instance of a InputAudio record class.

Parameters:

data - the value for the data 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.

data

public String data()

Returns the value of the data record component.

Returns:

the value of the data record component

format

public OpenAiApi.ChatCompletionMessage.MediaContent.InputAudio.Format format()

Returns the value of the format record component.

Returns:

the value of the format record component