openai-2.2.1: Servant bindings to OpenAI

Safe Haskell	None
Language	Haskell2010

OpenAI.V1.Audio.Transcriptions

Contents

Main types
Other types
Servant

Description

/v1/audio/transcriptions

To simplify things, this only supports the verbose_json response format and also only supports the segment granularity

Synopsis

data CreateTranscription = CreateTranscription {
- file :: FilePath
- model :: Model
- language :: Maybe Text
- prompt :: Maybe Text
- temperature :: Maybe Double
}
_CreateTranscription :: CreateTranscription
data TranscriptionObject = TranscriptionObject {
- language :: Maybe Text
- duration :: Maybe Double
- text :: Text
- segments :: Vector Segment
}
data Segment = Segment {
- id :: Integer
- seek :: Integer
- start :: Double
- end :: Double
- text :: Text
- tokens :: Vector Word
- temperature :: Double
- avg_logprob :: Double
- compression_ratio :: Double
- no_speech_prob :: Double
}
type API = "transcriptions" :> (MultipartForm Tmp CreateTranscription :> Post '[JSON] TranscriptionObject)

Main types

data CreateTranscription Source #

Request body for /v1/audio/transcriptions

Constructors

CreateTranscription
Fields file :: FilePath model :: Model language :: Maybe Text prompt :: Maybe Text temperature :: Maybe Double

Instances

Instances details

FromJSON CreateTranscription Source #

Instance details

Defined in OpenAI.V1.Audio.Transcriptions

Methods

parseJSON :: Value -> Parser CreateTranscription #

parseJSONList :: Value -> Parser [CreateTranscription] #

omittedField :: Maybe CreateTranscription #

ToJSON CreateTranscription Source #

Instance details

Defined in OpenAI.V1.Audio.Transcriptions

Methods

toJSON :: CreateTranscription -> Value #

toEncoding :: CreateTranscription -> Encoding #

toJSONList :: [CreateTranscription] -> Value #

toEncodingList :: [CreateTranscription] -> Encoding #

omitField :: CreateTranscription -> Bool #

Generic CreateTranscription Source #

Instance details

Defined in OpenAI.V1.Audio.Transcriptions

Associated Types

type Rep CreateTranscription

Instance details

Defined in OpenAI.V1.Audio.Transcriptions

type Rep CreateTranscription = D1 ('MetaData "CreateTranscription" "OpenAI.V1.Audio.Transcriptions" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "CreateTranscription" 'PrefixI 'True) ((S1 ('MetaSel ('Just "file") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath) :*: S1 ('MetaSel ('Just "model") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Model)) :*: (S1 ('MetaSel ('Just "language") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "prompt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "temperature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Double))))))

Methods

from :: CreateTranscription -> Rep CreateTranscription x #

to :: Rep CreateTranscription x -> CreateTranscription #

Show CreateTranscription Source #

Instance details

Defined in OpenAI.V1.Audio.Transcriptions

Methods

showsPrec :: Int -> CreateTranscription -> ShowS #

show :: CreateTranscription -> String #

showList :: [CreateTranscription] -> ShowS #

ToMultipart Tmp CreateTranscription Source #

Instance details

Defined in OpenAI.V1.Audio.Transcriptions

Methods

toMultipart :: CreateTranscription -> MultipartData Tmp #

type Rep CreateTranscription Source #

Instance details

Defined in OpenAI.V1.Audio.Transcriptions

type Rep CreateTranscription = D1 ('MetaData "CreateTranscription" "OpenAI.V1.Audio.Transcriptions" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "CreateTranscription" 'PrefixI 'True) ((S1 ('MetaSel ('Just "file") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath) :*: S1 ('MetaSel ('Just "model") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Model)) :*: (S1 ('MetaSel ('Just "language") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "prompt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "temperature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Double))))))

_CreateTranscription :: CreateTranscription Source #

Default CreateTranscription

data TranscriptionObject Source #

Represents a verbose json transcription response returned by model, based on the provided input.

Constructors

TranscriptionObject
Fields language :: Maybe Text duration :: Maybe Double text :: Text segments :: Vector Segment

Instances

Instances details

FromJSON TranscriptionObject Source #

Instance details

Defined in OpenAI.V1.Audio.Transcriptions

Methods

parseJSON :: Value -> Parser TranscriptionObject #

parseJSONList :: Value -> Parser [TranscriptionObject] #

omittedField :: Maybe TranscriptionObject #

ToJSON TranscriptionObject Source #

Instance details

Defined in OpenAI.V1.Audio.Transcriptions

Methods

toJSON :: TranscriptionObject -> Value #

toEncoding :: TranscriptionObject -> Encoding #

toJSONList :: [TranscriptionObject] -> Value #

toEncodingList :: [TranscriptionObject] -> Encoding #

omitField :: TranscriptionObject -> Bool #

Generic TranscriptionObject Source #

Instance details

Defined in OpenAI.V1.Audio.Transcriptions

Associated Types

type Rep TranscriptionObject

Instance details

Defined in OpenAI.V1.Audio.Transcriptions

type Rep TranscriptionObject = D1 ('MetaData "TranscriptionObject" "OpenAI.V1.Audio.Transcriptions" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "TranscriptionObject" 'PrefixI 'True) ((S1 ('MetaSel ('Just "language") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "duration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Double))) :*: (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "segments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Segment)))))

Methods

from :: TranscriptionObject -> Rep TranscriptionObject x #

to :: Rep TranscriptionObject x -> TranscriptionObject #

Show TranscriptionObject Source #

Instance details

Defined in OpenAI.V1.Audio.Transcriptions

Methods

showsPrec :: Int -> TranscriptionObject -> ShowS #

show :: TranscriptionObject -> String #

showList :: [TranscriptionObject] -> ShowS #

type Rep TranscriptionObject Source #

Instance details

Defined in OpenAI.V1.Audio.Transcriptions

type Rep TranscriptionObject = D1 ('MetaData "TranscriptionObject" "OpenAI.V1.Audio.Transcriptions" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "TranscriptionObject" 'PrefixI 'True) ((S1 ('MetaSel ('Just "language") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "duration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Double))) :*: (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "segments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Segment)))))

Other types

data Segment Source #

Segment of the transcribed text and its corresponding details

Constructors

Segment
Fields id :: Integer seek :: Integer start :: Double end :: Double text :: Text tokens :: Vector Word temperature :: Double avg_logprob :: Double compression_ratio :: Double no_speech_prob :: Double

Instances

Instances details

FromJSON Segment Source #

Instance details

Defined in OpenAI.V1.Audio.Transcriptions

Methods

parseJSON :: Value -> Parser Segment #

parseJSONList :: Value -> Parser [Segment] #

omittedField :: Maybe Segment #

ToJSON Segment Source #

Instance details

Defined in OpenAI.V1.Audio.Transcriptions

Methods

toJSON :: Segment -> Value #

toEncoding :: Segment -> Encoding #

toJSONList :: [Segment] -> Value #

toEncodingList :: [Segment] -> Encoding #

omitField :: Segment -> Bool #

Generic Segment Source #

Instance details

Defined in OpenAI.V1.Audio.Transcriptions

Associated Types

type Rep Segment

Instance details

Defined in OpenAI.V1.Audio.Transcriptions

type Rep Segment = D1 ('MetaData "Segment" "OpenAI.V1.Audio.Transcriptions" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "Segment" 'PrefixI 'True) (((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer) :*: S1 ('MetaSel ('Just "seek") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer)) :*: (S1 ('MetaSel ('Just "start") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: (S1 ('MetaSel ('Just "end") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))) :*: ((S1 ('MetaSel ('Just "tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Word)) :*: S1 ('MetaSel ('Just "temperature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double)) :*: (S1 ('MetaSel ('Just "avg_logprob") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: (S1 ('MetaSel ('Just "compression_ratio") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: S1 ('MetaSel ('Just "no_speech_prob") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double))))))

Methods

from :: Segment -> Rep Segment x #

to :: Rep Segment x -> Segment #

Show Segment Source #

Instance details

Defined in OpenAI.V1.Audio.Transcriptions

Methods

showsPrec :: Int -> Segment -> ShowS #

show :: Segment -> String #

showList :: [Segment] -> ShowS #

type Rep Segment Source #

Instance details

Defined in OpenAI.V1.Audio.Transcriptions

type Rep Segment = D1 ('MetaData "Segment" "OpenAI.V1.Audio.Transcriptions" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "Segment" 'PrefixI 'True) (((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer) :*: S1 ('MetaSel ('Just "seek") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer)) :*: (S1 ('MetaSel ('Just "start") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: (S1 ('MetaSel ('Just "end") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))) :*: ((S1 ('MetaSel ('Just "tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Word)) :*: S1 ('MetaSel ('Just "temperature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double)) :*: (S1 ('MetaSel ('Just "avg_logprob") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: (S1 ('MetaSel ('Just "compression_ratio") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: S1 ('MetaSel ('Just "no_speech_prob") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double))))))

Servant

type API = "transcriptions" :> (MultipartForm Tmp CreateTranscription :> Post '[JSON] TranscriptionObject) Source #

Servant API