Safe Haskell	Safe-Inferred
Language	Haskell2010

OpenAI.V1.Chat.Completions

Contents

Main types
Other types
Servant

Description

/v1/chat/completions

Streaming results are not yet supported

Synopsis

data CreateChatCompletion = CreateChatCompletion {
- messages :: Vector (Message (Vector Content))
- model :: Model
- store :: Maybe Bool
- metadata :: Maybe (Map Text Text)
- frequency_penalty :: Maybe Double
- logit_bias :: Maybe (Map Word Int)
- logprobs :: Maybe Bool
- top_logprobs :: Maybe Word
- max_completion_tokens :: Maybe Natural
- n :: Maybe Natural
- modalities :: Maybe (Vector Modality)
- prediction :: Maybe Prediction
- audio :: Maybe AudioParameters
- presence_penalty :: Maybe Double
- response_format :: Maybe ResponseFormat
- seed :: Maybe Integer
- service_tier :: Maybe (AutoOr ServiceTier)
- stop :: Maybe (Vector Text)
- temperature :: Maybe Double
- top_p :: Maybe Double
- tools :: Maybe (Vector Tool)
- tool_choice :: Maybe ToolChoice
- parallel_tool_calls :: Maybe Bool
- user :: Maybe Text
}
_CreateChatCompletion :: CreateChatCompletion
data ChatCompletionObject = ChatCompletionObject {
- id :: Text
- choices :: Vector Choice
- created :: POSIXTime
- model :: Model
- service_tier :: Maybe ServiceTier
- system_fingerprint :: Text
- object :: Text
- usage :: Usage CompletionTokensDetails PromptTokensDetails
}
data Choice = Choice {
- finish_reason :: Text
- index :: Natural
- message :: Message Text
- logprobs :: Maybe LogProbs
}
data Message content
- = System {
  - content :: content
  - name :: Maybe Text
  }
- | User {
  - content :: content
  - name :: Maybe Text
  }
- | Assistant {
  - assistant_content :: Maybe content
  - refusal :: Maybe Text
  - name :: Maybe Text
  - assistant_audio :: Maybe AudioData
  - tool_calls :: Maybe (Vector ToolCall)
  }
- | Tool {
  - content :: content
  - tool_call_id :: Text
  }
messageToContent :: Monoid content => Message content -> content
data Content
- = Text {
  - text :: Text
  }
- | Image_URL {
  - image_url :: ImageURL
  }
- | Input_Audio {
  - input_audio :: InputAudio
  }
data InputAudio = InputAudio {
- data_ :: Text
- format :: AudioFormat
}
data ImageURL = ImageURL {
- url :: Text
- detail :: Maybe (AutoOr Text)
}
data AudioData = AudioData {
- id :: Text
}
data Modality
- = Modality_Text
- | Modality_Audio
data Prediction = Content {
- content :: Text
}
data Voice
- = Ash
- | Ballad
- | Coral
- | Sage
- | Verse
data AudioFormat
- = WAV
- | MP3
- | FLAC
- | Opus
- | PCM16
data AudioParameters = AudioParameters {
- voice :: Voice
- format :: AudioFormat
}
data ResponseFormat
- = ResponseFormat_Text
- | JSON_Object
- | JSON_Schema {
  - json_schema :: JSONSchema
  }
data ServiceTier = Default
data FinishReason
- = Stop
- | Length
- | Content_Filter
- | Tool_Calls
data Token = Token {
- token :: Text
- logprob :: Double
- bytes :: Maybe (Vector Word8)
- top_logprobs :: Maybe (Vector Token)
}
data LogProbs = LogProbs {
- content :: Maybe (Vector Token)
- refusal :: Maybe (Vector Token)
}
type API = "chat" :> ("completions" :> (ReqBody '[JSON] CreateChatCompletion :> Post '[JSON] ChatCompletionObject))

Main types

data CreateChatCompletion Source #

Request body for /v1/chat/completions

Constructors

CreateChatCompletion

Fields

messages :: Vector (Message (Vector Content))
model :: Model
store :: Maybe Bool
metadata :: Maybe (Map Text Text)
frequency_penalty :: Maybe Double
logit_bias :: Maybe (Map Word Int)
logprobs :: Maybe Bool
top_logprobs :: Maybe Word
max_completion_tokens :: Maybe Natural
n :: Maybe Natural
modalities :: Maybe (Vector Modality)
prediction :: Maybe Prediction
audio :: Maybe AudioParameters
presence_penalty :: Maybe Double
response_format :: Maybe ResponseFormat
seed :: Maybe Integer
service_tier :: Maybe (AutoOr ServiceTier)
stop :: Maybe (Vector Text)
temperature :: Maybe Double
top_p :: Maybe Double
tools :: Maybe (Vector Tool)
tool_choice :: Maybe ToolChoice
parallel_tool_calls :: Maybe Bool
user :: Maybe Text

Instances

Instances details

ToJSON CreateChatCompletion Source #
Instance details Defined in OpenAI.V1.Chat.Completions Methods toJSON :: CreateChatCompletion -> Value # toEncoding :: CreateChatCompletion -> Encoding # toJSONList :: [CreateChatCompletion] -> Value # toEncodingList :: [CreateChatCompletion] -> Encoding # omitField :: CreateChatCompletion -> Bool #
Generic CreateChatCompletion Source #
Instance details Defined in OpenAI.V1.Chat.Completions Associated Types type Rep CreateChatCompletion :: Type -> Type # Methods from :: CreateChatCompletion -> Rep CreateChatCompletion x # to :: Rep CreateChatCompletion x -> CreateChatCompletion #
Show CreateChatCompletion Source #
Instance details Defined in OpenAI.V1.Chat.Completions Methods showsPrec :: Int -> CreateChatCompletion -> ShowS # show :: CreateChatCompletion -> String # showList :: [CreateChatCompletion] -> ShowS #
type Rep CreateChatCompletion Source #
Instance details Defined in OpenAI.V1.Chat.Completions type Rep CreateChatCompletion = D1 ('MetaData "CreateChatCompletion" "OpenAI.V1.Chat.Completions" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "CreateChatCompletion" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "messages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector (Message (Vector Content)))) :: (S1 ('MetaSel ('Just "model") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Model) :: S1 ('MetaSel ('Just "store") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))) :: (S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text Text))) :: (S1 ('MetaSel ('Just "frequency_penalty") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Double)) :: S1 ('MetaSel ('Just "logit_bias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Word Int)))))) :: ((S1 ('MetaSel ('Just "logprobs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "top_logprobs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Word)) :: S1 ('MetaSel ('Just "max_completion_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)))) :: (S1 ('MetaSel ('Just "n") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "modalities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector Modality))) :: S1 ('MetaSel ('Just "prediction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Prediction)))))) :: (((S1 ('MetaSel ('Just "audio") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe AudioParameters)) :: (S1 ('MetaSel ('Just "presence_penalty") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Double)) :: S1 ('MetaSel ('Just "response_format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ResponseFormat)))) :: (S1 ('MetaSel ('Just "seed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Integer)) :: (S1 ('MetaSel ('Just "service_tier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (AutoOr ServiceTier))) :: S1 ('MetaSel ('Just "stop") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector Text)))))) :: ((S1 ('MetaSel ('Just "temperature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Double)) :: (S1 ('MetaSel ('Just "top_p") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Double)) :: S1 ('MetaSel ('Just "tools") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector Tool))))) :: (S1 ('MetaSel ('Just "tool_choice") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ToolChoice)) :: (S1 ('MetaSel ('Just "parallel_tool_calls") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "user") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))))))

_CreateChatCompletion :: CreateChatCompletion Source #

Default CreateChatCompletion

data ChatCompletionObject Source #

ChatCompletion body

Constructors

ChatCompletionObject
Fields id :: Text choices :: Vector Choice created :: POSIXTime model :: Model service_tier :: Maybe ServiceTier system_fingerprint :: Text object :: Text usage :: Usage CompletionTokensDetails PromptTokensDetails

Instances

Instances details

FromJSON ChatCompletionObject Source #
Instance details Defined in OpenAI.V1.Chat.Completions Methods parseJSON :: Value -> Parser ChatCompletionObject # parseJSONList :: Value -> Parser [ChatCompletionObject] # omittedField :: Maybe ChatCompletionObject #
Generic ChatCompletionObject Source #
Instance details Defined in OpenAI.V1.Chat.Completions Associated Types type Rep ChatCompletionObject :: Type -> Type # Methods from :: ChatCompletionObject -> Rep ChatCompletionObject x # to :: Rep ChatCompletionObject x -> ChatCompletionObject #
Show ChatCompletionObject Source #
Instance details Defined in OpenAI.V1.Chat.Completions Methods showsPrec :: Int -> ChatCompletionObject -> ShowS # show :: ChatCompletionObject -> String # showList :: [ChatCompletionObject] -> ShowS #
type Rep ChatCompletionObject Source #
Instance details Defined in OpenAI.V1.Chat.Completions type Rep ChatCompletionObject = D1 ('MetaData "ChatCompletionObject" "OpenAI.V1.Chat.Completions" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "ChatCompletionObject" 'PrefixI 'True) (((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "choices") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Choice))) :: (S1 ('MetaSel ('Just "created") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 POSIXTime) :: S1 ('MetaSel ('Just "model") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Model))) :: ((S1 ('MetaSel ('Just "service_tier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ServiceTier)) :: S1 ('MetaSel ('Just "system_fingerprint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :: (S1 ('MetaSel ('Just "object") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "usage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Usage CompletionTokensDetails PromptTokensDetails))))))

data Choice Source #

A chat completion choice

Constructors

Choice
Fields finish_reason :: Text index :: Natural message :: Message Text logprobs :: Maybe LogProbs

Instances

Instances details

FromJSON Choice Source #
Instance details Defined in OpenAI.V1.Chat.Completions Methods parseJSON :: Value -> Parser Choice # parseJSONList :: Value -> Parser [Choice] # omittedField :: Maybe Choice #
Generic Choice Source #
Instance details Defined in OpenAI.V1.Chat.Completions Associated Types type Rep Choice :: Type -> Type # Methods from :: Choice -> Rep Choice x # to :: Rep Choice x -> Choice #
Show Choice Source #
Instance details Defined in OpenAI.V1.Chat.Completions Methods showsPrec :: Int -> Choice -> ShowS # show :: Choice -> String # showList :: [Choice] -> ShowS #
type Rep Choice Source #
Instance details Defined in OpenAI.V1.Chat.Completions type Rep Choice = D1 ('MetaData "Choice" "OpenAI.V1.Chat.Completions" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "Choice" 'PrefixI 'True) ((S1 ('MetaSel ('Just "finish_reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "index") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)) :: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Message Text)) :*: S1 ('MetaSel ('Just "logprobs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe LogProbs)))))

data Message content Source #

A message from the conversation so far

Constructors

System
Fields content :: content name :: Maybe Text
User
Fields content :: content name :: Maybe Text
Assistant
Fields assistant_content :: Maybe content refusal :: Maybe Text name :: Maybe Text assistant_audio :: Maybe AudioData tool_calls :: Maybe (Vector ToolCall)
Tool
Fields content :: content tool_call_id :: Text

Instances

Instances details

FromJSON content => FromJSON (Message content) Source #
Instance details Defined in OpenAI.V1.Chat.Completions Methods parseJSON :: Value -> Parser (Message content) # parseJSONList :: Value -> Parser [Message content] # omittedField :: Maybe (Message content) #
ToJSON content => ToJSON (Message content) Source #
Instance details Defined in OpenAI.V1.Chat.Completions Methods toJSON :: Message content -> Value # toEncoding :: Message content -> Encoding # toJSONList :: [Message content] -> Value # toEncodingList :: [Message content] -> Encoding # omitField :: Message content -> Bool #
Generic (Message content) Source #
Instance details Defined in OpenAI.V1.Chat.Completions Associated Types type Rep (Message content) :: Type -> Type # Methods from :: Message content -> Rep (Message content) x # to :: Rep (Message content) x -> Message content #
Show content => Show (Message content) Source #
Instance details Defined in OpenAI.V1.Chat.Completions Methods showsPrec :: Int -> Message content -> ShowS # show :: Message content -> String # showList :: [Message content] -> ShowS #
type Rep (Message content) Source #
Instance details Defined in OpenAI.V1.Chat.Completions type Rep (Message content) = D1 ('MetaData "Message" "OpenAI.V1.Chat.Completions" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) ((C1 ('MetaCons "System" 'PrefixI 'True) (S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 content) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :+: C1 ('MetaCons "User" 'PrefixI 'True) (S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 content) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))) :+: (C1 ('MetaCons "Assistant" 'PrefixI 'True) ((S1 ('MetaSel ('Just "assistant_content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe content)) :: S1 ('MetaSel ('Just "refusal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "assistant_audio") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe AudioData)) :: S1 ('MetaSel ('Just "tool_calls") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector ToolCall)))))) :+: C1 ('MetaCons "Tool" 'PrefixI 'True) (S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 content) :*: S1 ('MetaSel ('Just "tool_call_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))

messageToContent :: Monoid content => Message content -> content Source #

Extract the message body from a Message

Normally this would just be the content field selector, but the problem is that the content field for the Assistant constructor is not required to be present, so we provide a utility function to default to extract the content field for all constructors, defaulting to mempty for the special case where the Message is an Assistant constructor with a missing content field

data Content Source #

A content part

Constructors

Text
Fields text :: Text
Image_URL
Fields image_url :: ImageURL
Input_Audio
Fields input_audio :: InputAudio

Instances

Instances details

ToJSON Content Source #
Instance details Defined in OpenAI.V1.Chat.Completions Methods toJSON :: Content -> Value # toEncoding :: Content -> Encoding # toJSONList :: [Content] -> Value # toEncodingList :: [Content] -> Encoding # omitField :: Content -> Bool #
IsString Content Source #
Instance details Defined in OpenAI.V1.Chat.Completions Methods fromString :: String -> Content #
Generic Content Source #
Instance details Defined in OpenAI.V1.Chat.Completions Associated Types type Rep Content :: Type -> Type # Methods from :: Content -> Rep Content x # to :: Rep Content x -> Content #
Show Content Source #
Instance details Defined in OpenAI.V1.Chat.Completions Methods showsPrec :: Int -> Content -> ShowS # show :: Content -> String # showList :: [Content] -> ShowS #
type Rep Content Source #
Instance details Defined in OpenAI.V1.Chat.Completions type Rep Content = D1 ('MetaData "Content" "OpenAI.V1.Chat.Completions" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "Text" 'PrefixI 'True) (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: (C1 ('MetaCons "Image_URL" 'PrefixI 'True) (S1 ('MetaSel ('Just "image_url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ImageURL)) :+: C1 ('MetaCons "Input_Audio" 'PrefixI 'True) (S1 ('MetaSel ('Just "input_audio") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 InputAudio))))

Other types

data InputAudio Source #

Audio content part

Constructors

InputAudio
Fields data_ :: Text format :: AudioFormat

Instances

Instances details

ToJSON InputAudio Source #
Instance details Defined in OpenAI.V1.Chat.Completions Methods toJSON :: InputAudio -> Value # toEncoding :: InputAudio -> Encoding # toJSONList :: [InputAudio] -> Value # toEncodingList :: [InputAudio] -> Encoding # omitField :: InputAudio -> Bool #
Generic InputAudio Source #
Instance details Defined in OpenAI.V1.Chat.Completions Associated Types type Rep InputAudio :: Type -> Type # Methods from :: InputAudio -> Rep InputAudio x # to :: Rep InputAudio x -> InputAudio #
Show InputAudio Source #
Instance details Defined in OpenAI.V1.Chat.Completions Methods showsPrec :: Int -> InputAudio -> ShowS # show :: InputAudio -> String # showList :: [InputAudio] -> ShowS #
type Rep InputAudio Source #
Instance details Defined in OpenAI.V1.Chat.Completions type Rep InputAudio = D1 ('MetaData "InputAudio" "OpenAI.V1.Chat.Completions" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "InputAudio" 'PrefixI 'True) (S1 ('MetaSel ('Just "data_") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AudioFormat)))

data ImageURL Source #

Image content part

Constructors

ImageURL
Fields url :: Text detail :: Maybe (AutoOr Text)

Instances

Instances details

ToJSON ImageURL Source #
Instance details Defined in OpenAI.V1.Chat.Completions Methods toJSON :: ImageURL -> Value # toEncoding :: ImageURL -> Encoding # toJSONList :: [ImageURL] -> Value # toEncodingList :: [ImageURL] -> Encoding # omitField :: ImageURL -> Bool #
Generic ImageURL Source #
Instance details Defined in OpenAI.V1.Chat.Completions Associated Types type Rep ImageURL :: Type -> Type # Methods from :: ImageURL -> Rep ImageURL x # to :: Rep ImageURL x -> ImageURL #
Show ImageURL Source #
Instance details Defined in OpenAI.V1.Chat.Completions Methods showsPrec :: Int -> ImageURL -> ShowS # show :: ImageURL -> String # showList :: [ImageURL] -> ShowS #
type Rep ImageURL Source #
Instance details Defined in OpenAI.V1.Chat.Completions type Rep ImageURL = D1 ('MetaData "ImageURL" "OpenAI.V1.Chat.Completions" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "ImageURL" 'PrefixI 'True) (S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "detail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (AutoOr Text)))))

data AudioData Source #

Data about a previous audio response from the model. Learn more

Constructors

AudioData
Fields id :: Text

Instances

Instances details

FromJSON AudioData Source #
Instance details Defined in OpenAI.V1.Chat.Completions Methods parseJSON :: Value -> Parser AudioData # parseJSONList :: Value -> Parser [AudioData] # omittedField :: Maybe AudioData #
ToJSON AudioData Source #
Instance details Defined in OpenAI.V1.Chat.Completions Methods toJSON :: AudioData -> Value # toEncoding :: AudioData -> Encoding # toJSONList :: [AudioData] -> Value # toEncodingList :: [AudioData] -> Encoding # omitField :: AudioData -> Bool #
Generic AudioData Source #
Instance details Defined in OpenAI.V1.Chat.Completions Associated Types type Rep AudioData :: Type -> Type # Methods from :: AudioData -> Rep AudioData x # to :: Rep AudioData x -> AudioData #
Show AudioData Source #
Instance details Defined in OpenAI.V1.Chat.Completions Methods showsPrec :: Int -> AudioData -> ShowS # show :: AudioData -> String # showList :: [AudioData] -> ShowS #
type Rep AudioData Source #
Instance details Defined in OpenAI.V1.Chat.Completions type Rep AudioData = D1 ('MetaData "AudioData" "OpenAI.V1.Chat.Completions" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "AudioData" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data Modality Source #

Output types that you would like the model to generate for this request

Constructors

Modality_Text
Modality_Audio

Instances

Instances details

ToJSON Modality Source #
Instance details Defined in OpenAI.V1.Chat.Completions Methods toJSON :: Modality -> Value # toEncoding :: Modality -> Encoding # toJSONList :: [Modality] -> Value # toEncodingList :: [Modality] -> Encoding # omitField :: Modality -> Bool #
Generic Modality Source #
Instance details Defined in OpenAI.V1.Chat.Completions Associated Types type Rep Modality :: Type -> Type # Methods from :: Modality -> Rep Modality x # to :: Rep Modality x -> Modality #
Show Modality Source #
Instance details Defined in OpenAI.V1.Chat.Completions Methods showsPrec :: Int -> Modality -> ShowS # show :: Modality -> String # showList :: [Modality] -> ShowS #
type Rep Modality Source #
Instance details Defined in OpenAI.V1.Chat.Completions type Rep Modality = D1 ('MetaData "Modality" "OpenAI.V1.Chat.Completions" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "Modality_Text" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Modality_Audio" 'PrefixI 'False) (U1 :: Type -> Type))

data Prediction Source #

Configuration for a Predicted Output, which can greatly improve response times when large parts of the model response are known ahead of time. This is most common when you are regenerating a file with only minor changes to most of the content

Constructors

Content
Fields content :: Text

Instances

Instances details

ToJSON Prediction Source #
Instance details Defined in OpenAI.V1.Chat.Completions Methods toJSON :: Prediction -> Value # toEncoding :: Prediction -> Encoding # toJSONList :: [Prediction] -> Value # toEncodingList :: [Prediction] -> Encoding # omitField :: Prediction -> Bool #
Generic Prediction Source #
Instance details Defined in OpenAI.V1.Chat.Completions Associated Types type Rep Prediction :: Type -> Type # Methods from :: Prediction -> Rep Prediction x # to :: Rep Prediction x -> Prediction #
Show Prediction Source #
Instance details Defined in OpenAI.V1.Chat.Completions Methods showsPrec :: Int -> Prediction -> ShowS # show :: Prediction -> String # showList :: [Prediction] -> ShowS #
type Rep Prediction Source #
Instance details Defined in OpenAI.V1.Chat.Completions type Rep Prediction = D1 ('MetaData "Prediction" "OpenAI.V1.Chat.Completions" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "Content" 'PrefixI 'True) (S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data Voice Source #

The voice the model uses to respond

Constructors

Ash
Ballad
Coral
Sage
Verse

Instances

Instances details

ToJSON Voice Source #
Instance details Defined in OpenAI.V1.Chat.Completions Methods toJSON :: Voice -> Value # toEncoding :: Voice -> Encoding # toJSONList :: [Voice] -> Value # toEncodingList :: [Voice] -> Encoding # omitField :: Voice -> Bool #
Generic Voice Source #
Instance details Defined in OpenAI.V1.Chat.Completions Associated Types type Rep Voice :: Type -> Type # Methods from :: Voice -> Rep Voice x # to :: Rep Voice x -> Voice #
Show Voice Source #
Instance details Defined in OpenAI.V1.Chat.Completions Methods showsPrec :: Int -> Voice -> ShowS # show :: Voice -> String # showList :: [Voice] -> ShowS #
type Rep Voice Source #
Instance details Defined in OpenAI.V1.Chat.Completions type Rep Voice = D1 ('MetaData "Voice" "OpenAI.V1.Chat.Completions" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) ((C1 ('MetaCons "Ash" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Ballad" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Coral" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Sage" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Verse" 'PrefixI 'False) (U1 :: Type -> Type))))

data AudioFormat Source #

Specifies the output audio format

Constructors

WAV
MP3
FLAC
Opus
PCM16

Instances

Instances details

ToJSON AudioFormat Source #
Instance details Defined in OpenAI.V1.Chat.Completions Methods toJSON :: AudioFormat -> Value # toEncoding :: AudioFormat -> Encoding # toJSONList :: [AudioFormat] -> Value # toEncodingList :: [AudioFormat] -> Encoding # omitField :: AudioFormat -> Bool #
Generic AudioFormat Source #
Instance details Defined in OpenAI.V1.Chat.Completions Associated Types type Rep AudioFormat :: Type -> Type # Methods from :: AudioFormat -> Rep AudioFormat x # to :: Rep AudioFormat x -> AudioFormat #
Show AudioFormat Source #
Instance details Defined in OpenAI.V1.Chat.Completions Methods showsPrec :: Int -> AudioFormat -> ShowS # show :: AudioFormat -> String # showList :: [AudioFormat] -> ShowS #
type Rep AudioFormat Source #
Instance details Defined in OpenAI.V1.Chat.Completions type Rep AudioFormat = D1 ('MetaData "AudioFormat" "OpenAI.V1.Chat.Completions" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) ((C1 ('MetaCons "WAV" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MP3" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "FLAC" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Opus" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PCM16" 'PrefixI 'False) (U1 :: Type -> Type))))

data AudioParameters Source #

Parameters for audio output

Constructors

AudioParameters
Fields voice :: Voice format :: AudioFormat

Instances

Instances details

ToJSON AudioParameters Source #
Instance details Defined in OpenAI.V1.Chat.Completions Methods toJSON :: AudioParameters -> Value # toEncoding :: AudioParameters -> Encoding # toJSONList :: [AudioParameters] -> Value # toEncodingList :: [AudioParameters] -> Encoding # omitField :: AudioParameters -> Bool #
Generic AudioParameters Source #
Instance details Defined in OpenAI.V1.Chat.Completions Associated Types type Rep AudioParameters :: Type -> Type # Methods from :: AudioParameters -> Rep AudioParameters x # to :: Rep AudioParameters x -> AudioParameters #
Show AudioParameters Source #
Instance details Defined in OpenAI.V1.Chat.Completions Methods showsPrec :: Int -> AudioParameters -> ShowS # show :: AudioParameters -> String # showList :: [AudioParameters] -> ShowS #
type Rep AudioParameters Source #
Instance details Defined in OpenAI.V1.Chat.Completions type Rep AudioParameters = D1 ('MetaData "AudioParameters" "OpenAI.V1.Chat.Completions" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "AudioParameters" 'PrefixI 'True) (S1 ('MetaSel ('Just "voice") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Voice) :*: S1 ('MetaSel ('Just "format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AudioFormat)))

data ResponseFormat Source #

An object specifying the format that the model must output

Constructors

ResponseFormat_Text
JSON_Object
JSON_Schema
Fields json_schema :: JSONSchema

Instances

Instances details

FromJSON ResponseFormat Source #
Instance details Defined in OpenAI.V1.ResponseFormat Methods parseJSON :: Value -> Parser ResponseFormat # parseJSONList :: Value -> Parser [ResponseFormat] # omittedField :: Maybe ResponseFormat #
ToJSON ResponseFormat Source #
Instance details Defined in OpenAI.V1.ResponseFormat Methods toJSON :: ResponseFormat -> Value # toEncoding :: ResponseFormat -> Encoding # toJSONList :: [ResponseFormat] -> Value # toEncodingList :: [ResponseFormat] -> Encoding # omitField :: ResponseFormat -> Bool #
Generic ResponseFormat Source #
Instance details Defined in OpenAI.V1.ResponseFormat Associated Types type Rep ResponseFormat :: Type -> Type # Methods from :: ResponseFormat -> Rep ResponseFormat x # to :: Rep ResponseFormat x -> ResponseFormat #
Show ResponseFormat Source #
Instance details Defined in OpenAI.V1.ResponseFormat Methods showsPrec :: Int -> ResponseFormat -> ShowS # show :: ResponseFormat -> String # showList :: [ResponseFormat] -> ShowS #
type Rep ResponseFormat Source #
Instance details Defined in OpenAI.V1.ResponseFormat type Rep ResponseFormat = D1 ('MetaData "ResponseFormat" "OpenAI.V1.ResponseFormat" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "ResponseFormat_Text" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "JSON_Object" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "JSON_Schema" 'PrefixI 'True) (S1 ('MetaSel ('Just "json_schema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 JSONSchema))))

data ServiceTier Source #

Specifies the latency tier to use for processing the request

Constructors

Default

Instances

Instances details

FromJSON ServiceTier Source #
Instance details Defined in OpenAI.V1.Chat.Completions Methods parseJSON :: Value -> Parser ServiceTier # parseJSONList :: Value -> Parser [ServiceTier] # omittedField :: Maybe ServiceTier #
ToJSON ServiceTier Source #
Instance details Defined in OpenAI.V1.Chat.Completions Methods toJSON :: ServiceTier -> Value # toEncoding :: ServiceTier -> Encoding # toJSONList :: [ServiceTier] -> Value # toEncodingList :: [ServiceTier] -> Encoding # omitField :: ServiceTier -> Bool #
Generic ServiceTier Source #
Instance details Defined in OpenAI.V1.Chat.Completions Associated Types type Rep ServiceTier :: Type -> Type # Methods from :: ServiceTier -> Rep ServiceTier x # to :: Rep ServiceTier x -> ServiceTier #
Show ServiceTier Source #
Instance details Defined in OpenAI.V1.Chat.Completions Methods showsPrec :: Int -> ServiceTier -> ShowS # show :: ServiceTier -> String # showList :: [ServiceTier] -> ShowS #
type Rep ServiceTier Source #
Instance details Defined in OpenAI.V1.Chat.Completions type Rep ServiceTier = D1 ('MetaData "ServiceTier" "OpenAI.V1.Chat.Completions" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "Default" 'PrefixI 'False) (U1 :: Type -> Type))

data FinishReason Source #

The reason the model stopped generating tokens

Constructors

Stop
Length
Content_Filter
Tool_Calls

Instances

Instances details

FromJSON FinishReason Source #
Instance details Defined in OpenAI.V1.Chat.Completions Methods parseJSON :: Value -> Parser FinishReason # parseJSONList :: Value -> Parser [FinishReason] # omittedField :: Maybe FinishReason #
Generic FinishReason Source #
Instance details Defined in OpenAI.V1.Chat.Completions Associated Types type Rep FinishReason :: Type -> Type # Methods from :: FinishReason -> Rep FinishReason x # to :: Rep FinishReason x -> FinishReason #
Show FinishReason Source #
Instance details Defined in OpenAI.V1.Chat.Completions Methods showsPrec :: Int -> FinishReason -> ShowS # show :: FinishReason -> String # showList :: [FinishReason] -> ShowS #
type Rep FinishReason Source #
Instance details Defined in OpenAI.V1.Chat.Completions type Rep FinishReason = D1 ('MetaData "FinishReason" "OpenAI.V1.Chat.Completions" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) ((C1 ('MetaCons "Stop" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Length" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Content_Filter" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Tool_Calls" 'PrefixI 'False) (U1 :: Type -> Type)))

data Token Source #

Message tokens with log probability information

Constructors

Token
Fields token :: Text logprob :: Double bytes :: Maybe (Vector Word8) top_logprobs :: Maybe (Vector Token)

Instances

Instances details

FromJSON Token Source #
Instance details Defined in OpenAI.V1.Chat.Completions Methods parseJSON :: Value -> Parser Token # parseJSONList :: Value -> Parser [Token] # omittedField :: Maybe Token #
Generic Token Source #
Instance details Defined in OpenAI.V1.Chat.Completions Associated Types type Rep Token :: Type -> Type # Methods from :: Token -> Rep Token x # to :: Rep Token x -> Token #
Show Token Source #
Instance details Defined in OpenAI.V1.Chat.Completions Methods showsPrec :: Int -> Token -> ShowS # show :: Token -> String # showList :: [Token] -> ShowS #
type Rep Token Source #
Instance details Defined in OpenAI.V1.Chat.Completions type Rep Token = D1 ('MetaData "Token" "OpenAI.V1.Chat.Completions" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "Token" 'PrefixI 'True) ((S1 ('MetaSel ('Just "token") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "logprob") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double)) :: (S1 ('MetaSel ('Just "bytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector Word8))) :*: S1 ('MetaSel ('Just "top_logprobs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector Token))))))

data LogProbs Source #

Log probability information for the choice

Constructors

LogProbs
Fields content :: Maybe (Vector Token) refusal :: Maybe (Vector Token)

Instances

Instances details

FromJSON LogProbs Source #
Instance details Defined in OpenAI.V1.Chat.Completions Methods parseJSON :: Value -> Parser LogProbs # parseJSONList :: Value -> Parser [LogProbs] # omittedField :: Maybe LogProbs #
Generic LogProbs Source #
Instance details Defined in OpenAI.V1.Chat.Completions Associated Types type Rep LogProbs :: Type -> Type # Methods from :: LogProbs -> Rep LogProbs x # to :: Rep LogProbs x -> LogProbs #
Show LogProbs Source #
Instance details Defined in OpenAI.V1.Chat.Completions Methods showsPrec :: Int -> LogProbs -> ShowS # show :: LogProbs -> String # showList :: [LogProbs] -> ShowS #
type Rep LogProbs Source #
Instance details Defined in OpenAI.V1.Chat.Completions type Rep LogProbs = D1 ('MetaData "LogProbs" "OpenAI.V1.Chat.Completions" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "LogProbs" 'PrefixI 'True) (S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector Token))) :*: S1 ('MetaSel ('Just "refusal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector Token)))))

Servant

type API = "chat" :> ("completions" :> (ReqBody '[JSON] CreateChatCompletion :> Post '[JSON] ChatCompletionObject)) Source #

Servant API