Record Class OpenAiAudioApi.StructuredResponse

java.lang.Object

java.lang.Record

org.springframework.ai.openai.api.OpenAiAudioApi.StructuredResponse

Record Components:

language - The language of the transcribed text.

duration - The duration of the audio in seconds.

text - The transcribed text.

words - The extracted words and their timestamps.

segments - The segments of the transcribed text and their corresponding details.

Enclosing class:

OpenAiAudioApi

public static record OpenAiAudioApi.StructuredResponse(String language, Float duration, String text, List<OpenAiAudioApi.StructuredResponse.Word> words, List<OpenAiAudioApi.StructuredResponse.Segment> segments)
extends Record

The Transcription Object represents a verbose json transcription response returned by model, based on the provided input.

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 final record	OpenAiAudioApi.StructuredResponse.Segment	Segment of the transcribed text and its corresponding details.
static final record	OpenAiAudioApi.StructuredResponse.Word	Extracted word and it corresponding timestamps.

Constructor Summary

Constructors

Constructor	Description
StructuredResponse(String language, Float duration, String text, List<OpenAiAudioApi.StructuredResponse.Word> words, List<OpenAiAudioApi.StructuredResponse.Segment> segments)	Creates an instance of a StructuredResponse record class.

Method Summary

Modifier and Type	Method	Description
Float	duration()	Returns the value of the duration record component.
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	language()	Returns the value of the language record component.
List<OpenAiAudioApi.StructuredResponse.Segment>	segments()	Returns the value of the segments record component.
String	text()	Returns the value of the text record component.
final String	toString()	Returns a string representation of this record class.
List<OpenAiAudioApi.StructuredResponse.Word>	words()	Returns the value of the words record component.

Methods inherited from class Object

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

Constructor Details

StructuredResponse

public StructuredResponse(String language,
 Float duration,
 String text,
 List<OpenAiAudioApi.StructuredResponse.Word> words,
 List<OpenAiAudioApi.StructuredResponse.Segment> segments)

Creates an instance of a StructuredResponse record class.

Parameters:

language - the value for the language record component

duration - the value for the duration record component

text - the value for the text record component

words - the value for the words record component

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

language

public String language()

Returns the value of the language record component.

Returns:

the value of the language record component

duration

public Float duration()

Returns the value of the duration record component.

Returns:

the value of the duration record component

text

public String text()

Returns the value of the text record component.

Returns:

the value of the text record component

words

public List<OpenAiAudioApi.StructuredResponse.Word> words()

Returns the value of the words record component.

Returns:

the value of the words record component

segments

public List<OpenAiAudioApi.StructuredResponse.Segment> segments()

Returns the value of the segments record component.

Returns:

the value of the segments record component