Package org.springframework.ai.openai.audio.speech

Class SpeechResponse

java.lang.Object

org.springframework.ai.openai.audio.speech.SpeechResponse

All Implemented Interfaces:

ModelResponse<Speech>

public class SpeechResponse
extends Object
implements ModelResponse<Speech>

Creates a new instance of SpeechResponse with the given speech result.

Since:

1.0.0-M1

Author:

Ahmed Yousri

Constructor Summary

Constructors

Constructor	Description
SpeechResponse(Speech speech)	Creates a new instance of SpeechResponse with the given speech result.
SpeechResponse(Speech speech, OpenAiAudioSpeechResponseMetadata speechResponseMetadata)	Creates a new instance of SpeechResponse with the given speech result and speech response metadata.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
OpenAiAudioSpeechResponseMetadata	getMetadata()	Retrieves the response metadata associated with the AI model's response.
Speech	getResult()	Retrieves the result of the AI model.
List<Speech>	getResults()	Retrieves the list of generated outputs by the AI model.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Details

SpeechResponse

public SpeechResponse(Speech speech)

Creates a new instance of SpeechResponse with the given speech result.

Parameters:

speech - the speech result to be set in the SpeechResponse

See Also:

• Speech

SpeechResponse

public SpeechResponse(Speech speech,
 OpenAiAudioSpeechResponseMetadata speechResponseMetadata)

Creates a new instance of SpeechResponse with the given speech result and speech response metadata.

Parameters:

speech - the speech result to be set in the SpeechResponse

speechResponseMetadata - the speech response metadata to be set in the SpeechResponse

See Also:

• Speech
• OpenAiAudioSpeechResponseMetadata

Method Details

getResult

public Speech getResult()

Description copied from interface: ModelResponse

Retrieves the result of the AI model.

Specified by:

getResult in interface ModelResponse<Speech>

Returns:

the result generated by the AI model

getResults

public List<Speech> getResults()

Description copied from interface: ModelResponse

Retrieves the list of generated outputs by the AI model.

Specified by:

getResults in interface ModelResponse<Speech>

Returns:

the list of generated outputs

getMetadata

public OpenAiAudioSpeechResponseMetadata getMetadata()

Description copied from interface: ModelResponse

Retrieves the response metadata associated with the AI model's response.

Specified by:

getMetadata in interface ModelResponse<Speech>

Returns:

the response metadata

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object