Packages

final case class CreateSpeechRequest(model: CreateSpeechRequest.Model, input: Input, voice: Voice, responseFormat: Optional[CreateSpeechRequest.ResponseFormat] = Optional.Absent, speed: Optional[Speed] = Optional.Absent) extends Product with Serializable

CreateSpeechRequest model

model

One of the available [TTS models](/docs/models/tts): tts-1 or tts-1-hd

input

The text to generate audio for. The maximum length is 4096 characters.

voice

The voice to use when generating the audio. Supported voices are alloy, echo, fable, onyx, nova, and shimmer. Previews of the voices are available in the [Text to speech guide](/docs/guides/text-to-speech/voice-options).

responseFormat

The format to audio in. Supported formats are mp3, opus, aac, and flac.

speed

The speed of the generated audio. Select a value from 0.25 to 4.0. 1.0 is the default.

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CreateSpeechRequest
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new CreateSpeechRequest(model: CreateSpeechRequest.Model, input: Input, voice: Voice, responseFormat: Optional[CreateSpeechRequest.ResponseFormat] = Optional.Absent, speed: Optional[Speed] = Optional.Absent)

    model

    One of the available [TTS models](/docs/models/tts): tts-1 or tts-1-hd

    input

    The text to generate audio for. The maximum length is 4096 characters.

    voice

    The voice to use when generating the audio. Supported voices are alloy, echo, fable, onyx, nova, and shimmer. Previews of the voices are available in the [Text to speech guide](/docs/guides/text-to-speech/voice-options).

    responseFormat

    The format to audio in. Supported formats are mp3, opus, aac, and flac.

    speed

    The speed of the generated audio. Select a value from 0.25 to 4.0. 1.0 is the default.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  8. val input: Input
  9. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  10. val model: CreateSpeechRequest.Model
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  14. def productElementNames: Iterator[String]
    Definition Classes
    Product
  15. val responseFormat: Optional[CreateSpeechRequest.ResponseFormat]
  16. val speed: Optional[Speed]
  17. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  18. val voice: Voice
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped