OpenAI.V1.Audio.Speech

/v1/audio/speech

Main types

data CreateSpeech

Request body for /v1/audio/speech

Constructors

CreateSpeech

Fields

• model :: Model
• input :: Text
• voice :: Voice
• response_format :: Maybe Format
• speed :: Maybe Double

Instances

ToJSON CreateSpeech

Defined in OpenAI.V1.Audio.Speech

Methods

toJSON :: CreateSpeech -> Value

toEncoding :: CreateSpeech -> Encoding

toJSONList :: [CreateSpeech] -> Value

toEncodingList :: [CreateSpeech] -> Encoding

omitField :: CreateSpeech -> Bool

Generic CreateSpeech

Defined in OpenAI.V1.Audio.Speech

Associated Types

type Rep CreateSpeech :: Type -> Type

Methods

from :: CreateSpeech -> Rep CreateSpeech x

to :: Rep CreateSpeech x -> CreateSpeech

Show CreateSpeech

Defined in OpenAI.V1.Audio.Speech

Methods

showsPrec :: Int -> CreateSpeech -> ShowS

show :: CreateSpeech -> String

showList :: [CreateSpeech] -> ShowS

type Rep CreateSpeech

Defined in OpenAI.V1.Audio.Speech

type Rep CreateSpeech = D1 ('MetaData "CreateSpeech" "OpenAI.V1.Audio.Speech" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "CreateSpeech" 'PrefixI 'True) ((S1 ('MetaSel ('Just "model") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Model) :*: S1 ('MetaSel ('Just "input") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "voice") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Voice) :*: (S1 ('MetaSel ('Just "response_format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Format)) :*: S1 ('MetaSel ('Just "speed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Double))))))

_CreateSpeech :: CreateSpeech

Default CreateSpeech

Other types

data Voice

The voice to use when generating the audio

Previews of the voices are available in the Text to speech guide.

Constructors

Alloy

Echo

Fable

Onyx

Nova

Shimmer

Instances

ToJSON Voice

Defined in OpenAI.V1.Audio.Speech

Methods

toJSON :: Voice -> Value

toEncoding :: Voice -> Encoding

toJSONList :: [Voice] -> Value

toEncodingList :: [Voice] -> Encoding

omitField :: Voice -> Bool

Bounded Voice

Defined in OpenAI.V1.Audio.Speech

Methods

minBound :: Voice

maxBound :: Voice

Enum Voice

Defined in OpenAI.V1.Audio.Speech

Methods

succ :: Voice -> Voice

pred :: Voice -> Voice

toEnum :: Int -> Voice

fromEnum :: Voice -> Int

enumFrom :: Voice -> [Voice]

enumFromThen :: Voice -> Voice -> [Voice]

enumFromTo :: Voice -> Voice -> [Voice]

enumFromThenTo :: Voice -> Voice -> Voice -> [Voice]

Generic Voice

Defined in OpenAI.V1.Audio.Speech

Associated Types

type Rep Voice :: Type -> Type

Methods

from :: Voice -> Rep Voice x

to :: Rep Voice x -> Voice

Show Voice

Defined in OpenAI.V1.Audio.Speech

Methods

showsPrec :: Int -> Voice -> ShowS

show :: Voice -> String

showList :: [Voice] -> ShowS

type Rep Voice

Defined in OpenAI.V1.Audio.Speech

type Rep Voice = D1 ('MetaData "Voice" "OpenAI.V1.Audio.Speech" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) ((C1 ('MetaCons "Alloy" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Echo" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Fable" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "Onyx" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Nova" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Shimmer" 'PrefixI 'False) (U1 :: Type -> Type))))

data Format

The format to audio in

Constructors

MP3

Opus

AAC

FLAC

WAV

PCM

Instances

ToJSON Format

Defined in OpenAI.V1.Audio.Speech

Methods

toJSON :: Format -> Value

toEncoding :: Format -> Encoding

toJSONList :: [Format] -> Value

toEncodingList :: [Format] -> Encoding

omitField :: Format -> Bool

Bounded Format

Defined in OpenAI.V1.Audio.Speech

Methods

minBound :: Format

maxBound :: Format

Enum Format

Defined in OpenAI.V1.Audio.Speech

Methods

succ :: Format -> Format

pred :: Format -> Format

toEnum :: Int -> Format

fromEnum :: Format -> Int

enumFrom :: Format -> [Format]

enumFromThen :: Format -> Format -> [Format]

enumFromTo :: Format -> Format -> [Format]

enumFromThenTo :: Format -> Format -> Format -> [Format]

Generic Format

Defined in OpenAI.V1.Audio.Speech

Associated Types

type Rep Format :: Type -> Type

Methods

from :: Format -> Rep Format x

to :: Rep Format x -> Format

Show Format

Defined in OpenAI.V1.Audio.Speech

Methods

showsPrec :: Int -> Format -> ShowS

show :: Format -> String

showList :: [Format] -> ShowS

type Rep Format

Defined in OpenAI.V1.Audio.Speech

type Rep Format = D1 ('MetaData "Format" "OpenAI.V1.Audio.Speech" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) ((C1 ('MetaCons "MP3" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Opus" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "AAC" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "FLAC" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "WAV" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PCM" 'PrefixI 'False) (U1 :: Type -> Type))))

Servant

data ContentType

Content type

Constructors

ContentType

Instances

Accept ContentType

Defined in OpenAI.V1.Audio.Speech

Methods

contentType :: Proxy ContentType -> MediaType

contentTypes :: Proxy ContentType -> NonEmpty MediaType

MimeUnrender ContentType ByteString

Defined in OpenAI.V1.Audio.Speech

Methods

mimeUnrender :: Proxy ContentType -> ByteString -> Either String ByteString

mimeUnrenderWithType :: Proxy ContentType -> MediaType -> ByteString -> Either String ByteString

type API = "speech" :> (ReqBody '[JSON] CreateSpeech :> Post '[ContentType] ByteString)

Servant API