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

Class SpeechPrompt

java.lang.Object

org.springframework.ai.openai.audio.speech.SpeechPrompt

All Implemented Interfaces:

org.springframework.ai.model.ModelRequest<SpeechMessage>

public class SpeechPrompt
extends Object
implements org.springframework.ai.model.ModelRequest<SpeechMessage>

The SpeechPrompt class represents a request to the OpenAI Text-to-Speech (TTS) API. It contains a list of SpeechMessage objects, each representing a piece of text to be converted to speech.

Since:

1.0.0-M1

Author:

Ahmed Yousri

Constructor Summary

Constructors

Constructor	Description
SpeechPrompt(String instructions)
SpeechPrompt(String instructions, OpenAiAudioSpeechOptions speechOptions)
SpeechPrompt(SpeechMessage speechMessage)
SpeechPrompt(SpeechMessage speechMessage, OpenAiAudioSpeechOptions speechOptions)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
SpeechMessage	getInstructions()
org.springframework.ai.model.ModelOptions	getOptions()
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Details

SpeechPrompt

public SpeechPrompt(String instructions)

SpeechPrompt

public SpeechPrompt(String instructions,
 OpenAiAudioSpeechOptions speechOptions)

SpeechPrompt

public SpeechPrompt(SpeechMessage speechMessage)

SpeechPrompt

public SpeechPrompt(SpeechMessage speechMessage,
 OpenAiAudioSpeechOptions speechOptions)

Method Details

getInstructions

public SpeechMessage getInstructions()

Specified by:

getInstructions in interface org.springframework.ai.model.ModelRequest<SpeechMessage>

getOptions

public org.springframework.ai.model.ModelOptions getOptions()

Specified by:

getOptions in interface org.springframework.ai.model.ModelRequest<SpeechMessage>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object