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

Class Speech

java.lang.Object

org.springframework.ai.openai.audio.speech.Speech

All Implemented Interfaces:

ModelResult<byte[]>

public class Speech
extends Object
implements ModelResult<byte[]>

The Speech class represents the result of speech synthesis from an AI model. It implements the ModelResult interface with the output type of byte array.

Since:

1.0.0-M1

Author:

Ahmed Yousri

Constructor Summary

Constructors

Constructor	Description
Speech(byte[] audio)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
OpenAiAudioSpeechMetadata	getMetadata()	Retrieves the metadata associated with the result of an AI model.
byte[]	getOutput()	Retrieves the output generated by the AI model.
int	hashCode()
String	toString()
Speech	withSpeechMetadata(OpenAiAudioSpeechMetadata speechMetadata)

Methods inherited from class java.lang.Object

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

Constructor Details

Speech

public Speech(byte[] audio)

Method Details

getOutput

public byte[] getOutput()

Description copied from interface: ModelResult

Retrieves the output generated by the AI model.

Specified by:

getOutput in interface ModelResult<byte[]>

Returns:

the output generated by the AI model

getMetadata

public OpenAiAudioSpeechMetadata getMetadata()

Description copied from interface: ModelResult

Retrieves the metadata associated with the result of an AI model.

Specified by:

getMetadata in interface ModelResult<byte[]>

Returns:

the metadata associated with the result

withSpeechMetadata

public Speech withSpeechMetadata(@Nullable
 OpenAiAudioSpeechMetadata speechMetadata)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object