Copyright	(c) 2025 Tushar Adhatrao
License	MIT
Maintainer	Tushar Adhatrao <tusharadhatrao@gmail.com>
Stability	experimental
Safe Haskell	Safe-Inferred
Language	Haskell2010

Langchain.LLM.OpenAI

Contents

Data Types
Functions

Description

OpenAI implementation of LangChain's LLM interface. Not tested

Synopsis

data OpenAI = OpenAI {
- apiKey :: Text
- openAIModelName :: Text
- callbacks :: [Callback]
}
data ChatCompletionRequest = ChatCompletionRequest {
- messages :: [Message]
- model :: Text
- frequencyPenalty :: Maybe Double
- logitBias :: Maybe (Map Text Double)
- logprobs :: Maybe Bool
- maxCompletionTokens :: Maybe Int
- maxTokens :: Maybe Int
- metadata :: Maybe (Map Text Text)
- modalities :: Maybe [Modality]
- n :: Maybe Int
- parallelToolCalls :: Maybe Bool
- prediction :: Maybe PredictionOutput
- presencePenalty :: Maybe Double
- reasoningEffort :: Maybe ReasoningEffort
- responseFormat :: Maybe ResponseFormat
- seed :: Maybe Int
- serviceTier :: Maybe Text
- stop :: Maybe (Either Text [Text])
- store :: Maybe Bool
- stream :: Maybe Bool
- streamOptions :: Maybe StreamOptions
- temperature :: Maybe Double
- toolChoice :: Maybe ToolChoice
- tools :: Maybe [Tool_]
- topLogprobs :: Maybe Int
- topP :: Maybe Double
- user :: Maybe Text
- webSearchOptions :: Maybe WebSearchOptions
- audio :: Maybe AudioConfig
}
data ChatCompletionResponse = ChatCompletionResponse {
- choices :: [Choice]
- created :: Integer
- id_ :: Text
- responseModel :: Text
- object_ :: Text
- serviceTier :: Maybe Text
- systemFingerprint :: Text
- usage :: Usage
}
data Message = Message {
- role :: Role
- content :: Maybe MessageContent
- name :: Maybe Text
- functionCall :: Maybe FunctionCall_
- toolCalls :: Maybe [ToolCall]
- toolCallId :: Maybe Text
- audio :: Maybe AudioResponse
- refusal :: Maybe Text
}
data Role
- = User
- | Assistant
- | System
- | Developer
- | Tool
- | Function
data MessageContent
- = StringContent Text
- | ContentParts [TextContent]
data TextContent = TextContent {
- text_ :: Text
- contentType :: Text
}
data Tool_ = Tool_ {
- toolType :: Text
- function :: Function_
}
data Function_ = Function_ {
- name :: Text
- description :: Maybe Text
- parameters :: Maybe Value
- strict :: Maybe Bool
}
data ToolCall = ToolCall {
- id_ :: Text
- toolType :: Text
- function :: FunctionCall_
}
data FunctionCall_ = FunctionCall_ {
- name :: Text
- arguments :: Text
}
data Usage = Usage {
- completionTokens :: Int
- promptTokens :: Int
- totalTokens :: Int
- completionTokensDetails :: Maybe CompletionTokensDetails
- promptTokensDetails :: Maybe PromptTokensDetails
}
data Choice = Choice {
- finishReason :: FinishReason
- index :: Int
- logprobs :: Maybe LogProbs
- message :: Message
}
data FinishReason
- = Stop
- | Length
- | ContentFilter
- | ToolCalls
- | FunctionCall
data LogProbs = LogProbs {
- content :: Maybe [LogProbContent]
- refusal :: Maybe [LogProbContent]
}
data LogProbContent = LogProbContent {
- bytes :: Maybe [Int]
- logprob :: Double
- token :: Text
- topLogprobs :: [TopLogProb]
}
data TopLogProb = TopLogProb {
- bytes :: Maybe [Int]
- logprob :: Double
- token :: Text
}
data AudioConfig = AudioConfig {
- format :: Text
- voice :: Text
}
data AudioResponse = AudioResponse {
- data_ :: Text
- expiresAt :: Integer
- id_ :: Text
- transcript :: Text
}
data Modality
- = TextModality
- | AudioModality
data ToolChoice
- = None
- | Auto
- | Required
- | SpecificTool SpecificToolChoice
data SpecificToolChoice = SpecificToolChoice {
- toolType :: Text
- function :: Value
}
data ReasoningEffort
- = Low
- | Medium
- | High
data PredictionOutput = PredictionOutput {
- predictionType :: Text
- content :: MessageContent
}
data PredictionContent = PredictionContent {
- content :: MessageContent
- contentType :: Text
}
data ResponseFormat
- = JsonObjectFormat
- | JsonSchemaFormat Value
data StreamOptions = StreamOptions {
- includeUsage :: Bool
}
data WebSearchOptions = WebSearchOptions {
- searchContextSize :: Maybe Text
- userLocation :: Maybe UserLocation
}
data UserLocation = UserLocation {
- approximate :: ApproximateLocation
}
data ApproximateLocation = ApproximateLocation {
- locationType :: Text
}
data CompletionTokensDetails = CompletionTokensDetails {
- acceptedPredictionTokens :: Int
- audioTokens :: Int
- reasoningTokens :: Int
- rejectedPredictionTokens :: Int
}
data PromptTokensDetails = PromptTokensDetails {
- audioTokens :: Int
- cachedTokens :: Int
}
createChatCompletion :: Text -> ChatCompletionRequest -> IO (Either String ChatCompletionResponse)
defaultChatCompletionRequest :: ChatCompletionRequest
defaultMessage :: Message

Documentation

data OpenAI Source #

Constructors

OpenAI
Fields apiKey :: Text openAIModelName :: Text callbacks :: [Callback]

Instances

Instances details

Show OpenAI Source #
Instance details Defined in Langchain.LLM.OpenAI Methods showsPrec :: Int -> OpenAI -> ShowS # show :: OpenAI -> String # showList :: [OpenAI] -> ShowS #
LLM OpenAI Source #
Instance details Defined in Langchain.LLM.OpenAI Methods generate :: OpenAI -> Text -> Maybe Params -> IO (Either String Text) Source # chat :: OpenAI -> ChatMessage -> Maybe Params -> IO (Either String Text) Source # stream :: OpenAI -> ChatMessage -> StreamHandler -> Maybe Params -> IO (Either String ()) Source #

Data Types

data ChatCompletionRequest Source #

Main request type for chat completions Contains all parameters for configuring the OpenAI chat completion API call.

Constructors

ChatCompletionRequest

Fields

messages :: [Message]
model :: Text
frequencyPenalty :: Maybe Double
logitBias :: Maybe (Map Text Double)
logprobs :: Maybe Bool
maxCompletionTokens :: Maybe Int
maxTokens :: Maybe Int
metadata :: Maybe (Map Text Text)
modalities :: Maybe [Modality]
n :: Maybe Int
parallelToolCalls :: Maybe Bool
prediction :: Maybe PredictionOutput
presencePenalty :: Maybe Double
reasoningEffort :: Maybe ReasoningEffort
responseFormat :: Maybe ResponseFormat
seed :: Maybe Int
serviceTier :: Maybe Text
stop :: Maybe (Either Text [Text])
store :: Maybe Bool
stream :: Maybe Bool
streamOptions :: Maybe StreamOptions
temperature :: Maybe Double
toolChoice :: Maybe ToolChoice
tools :: Maybe [Tool_]
topLogprobs :: Maybe Int
topP :: Maybe Double
user :: Maybe Text
webSearchOptions :: Maybe WebSearchOptions
audio :: Maybe AudioConfig

Instances

Instances details

ToJSON ChatCompletionRequest Source #
Instance details Defined in Langchain.LLM.OpenAI Methods toJSON :: ChatCompletionRequest -> Value # toEncoding :: ChatCompletionRequest -> Encoding # toJSONList :: [ChatCompletionRequest] -> Value # toEncodingList :: [ChatCompletionRequest] -> Encoding # omitField :: ChatCompletionRequest -> Bool #
Generic ChatCompletionRequest Source #
Instance details Defined in Langchain.LLM.OpenAI Associated Types type Rep ChatCompletionRequest :: Type -> Type # Methods from :: ChatCompletionRequest -> Rep ChatCompletionRequest x # to :: Rep ChatCompletionRequest x -> ChatCompletionRequest #
Show ChatCompletionRequest Source #
Instance details Defined in Langchain.LLM.OpenAI Methods showsPrec :: Int -> ChatCompletionRequest -> ShowS # show :: ChatCompletionRequest -> String # showList :: [ChatCompletionRequest] -> ShowS #
Eq ChatCompletionRequest Source #
Instance details Defined in Langchain.LLM.OpenAI Methods (==) :: ChatCompletionRequest -> ChatCompletionRequest -> Bool # (/=) :: ChatCompletionRequest -> ChatCompletionRequest -> Bool #
type Rep ChatCompletionRequest Source #
Instance details Defined in Langchain.LLM.OpenAI type Rep ChatCompletionRequest = D1 ('MetaData "ChatCompletionRequest" "Langchain.LLM.OpenAI" "langchain-hs-0.0.1.0-inplace" 'False) (C1 ('MetaCons "ChatCompletionRequest" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "messages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Message]) :: (S1 ('MetaSel ('Just "model") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "frequencyPenalty") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Double)))) :: ((S1 ('MetaSel ('Just "logitBias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text Double))) :: S1 ('MetaSel ('Just "logprobs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "maxCompletionTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "maxTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int))))) :: ((S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text Text))) :: (S1 ('MetaSel ('Just "modalities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Modality])) :: S1 ('MetaSel ('Just "n") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)))) :: ((S1 ('MetaSel ('Just "parallelToolCalls") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "prediction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe PredictionOutput))) :: (S1 ('MetaSel ('Just "presencePenalty") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Double)) :: S1 ('MetaSel ('Just "reasoningEffort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ReasoningEffort)))))) :: (((S1 ('MetaSel ('Just "responseFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ResponseFormat)) :: (S1 ('MetaSel ('Just "seed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "serviceTier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "stop") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Either Text [Text]))) :: S1 ('MetaSel ('Just "store") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "stream") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "streamOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe StreamOptions))))) :: (((S1 ('MetaSel ('Just "temperature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Double)) :: S1 ('MetaSel ('Just "toolChoice") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ToolChoice))) :: (S1 ('MetaSel ('Just "tools") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Tool_])) :: S1 ('MetaSel ('Just "topLogprobs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)))) :: ((S1 ('MetaSel ('Just "topP") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Double)) :: S1 ('MetaSel ('Just "user") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "webSearchOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe WebSearchOptions)) :: S1 ('MetaSel ('Just "audio") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe AudioConfig))))))))

data ChatCompletionResponse Source #

Constructors

ChatCompletionResponse
Fields choices :: [Choice] created :: Integer id_ :: Text responseModel :: Text object_ :: Text serviceTier :: Maybe Text systemFingerprint :: Text usage :: Usage

Instances

Instances details

FromJSON ChatCompletionResponse Source #
Instance details Defined in Langchain.LLM.OpenAI Methods parseJSON :: Value -> Parser ChatCompletionResponse # parseJSONList :: Value -> Parser [ChatCompletionResponse] # omittedField :: Maybe ChatCompletionResponse #
Generic ChatCompletionResponse Source #
Instance details Defined in Langchain.LLM.OpenAI Associated Types type Rep ChatCompletionResponse :: Type -> Type # Methods from :: ChatCompletionResponse -> Rep ChatCompletionResponse x # to :: Rep ChatCompletionResponse x -> ChatCompletionResponse #
Show ChatCompletionResponse Source #
Instance details Defined in Langchain.LLM.OpenAI Methods showsPrec :: Int -> ChatCompletionResponse -> ShowS # show :: ChatCompletionResponse -> String # showList :: [ChatCompletionResponse] -> ShowS #
Eq ChatCompletionResponse Source #
Instance details Defined in Langchain.LLM.OpenAI Methods (==) :: ChatCompletionResponse -> ChatCompletionResponse -> Bool # (/=) :: ChatCompletionResponse -> ChatCompletionResponse -> Bool #
type Rep ChatCompletionResponse Source #
Instance details Defined in Langchain.LLM.OpenAI type Rep ChatCompletionResponse = D1 ('MetaData "ChatCompletionResponse" "Langchain.LLM.OpenAI" "langchain-hs-0.0.1.0-inplace" 'False) (C1 ('MetaCons "ChatCompletionResponse" 'PrefixI 'True) (((S1 ('MetaSel ('Just "choices") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Choice]) :: S1 ('MetaSel ('Just "created") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer)) :: (S1 ('MetaSel ('Just "id_") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "responseModel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))) :: ((S1 ('MetaSel ('Just "object_") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "serviceTier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "systemFingerprint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "usage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Usage)))))

data Message Source #

Represents a single message in a conversation Contains role, content, and optional metadata like function calls or audio responses.

Constructors

Message
Fields role :: Role content :: Maybe MessageContent name :: Maybe Text functionCall :: Maybe FunctionCall_ toolCalls :: Maybe [ToolCall] toolCallId :: Maybe Text audio :: Maybe AudioResponse refusal :: Maybe Text

Instances

Instances details

FromJSON Message Source #
Instance details Defined in Langchain.LLM.OpenAI Methods parseJSON :: Value -> Parser Message # parseJSONList :: Value -> Parser [Message] # omittedField :: Maybe Message #
ToJSON Message Source #
Instance details Defined in Langchain.LLM.OpenAI Methods toJSON :: Message -> Value # toEncoding :: Message -> Encoding # toJSONList :: [Message] -> Value # toEncodingList :: [Message] -> Encoding # omitField :: Message -> Bool #
Generic Message Source #
Instance details Defined in Langchain.LLM.OpenAI Associated Types type Rep Message :: Type -> Type # Methods from :: Message -> Rep Message x # to :: Rep Message x -> Message #
Show Message Source #
Instance details Defined in Langchain.LLM.OpenAI Methods showsPrec :: Int -> Message -> ShowS # show :: Message -> String # showList :: [Message] -> ShowS #
Eq Message Source #
Instance details Defined in Langchain.LLM.OpenAI Methods (==) :: Message -> Message -> Bool # (/=) :: Message -> Message -> Bool #
type Rep Message Source #
Instance details Defined in Langchain.LLM.OpenAI type Rep Message = D1 ('MetaData "Message" "Langchain.LLM.OpenAI" "langchain-hs-0.0.1.0-inplace" 'False) (C1 ('MetaCons "Message" 'PrefixI 'True) (((S1 ('MetaSel ('Just "role") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Role) :: S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageContent))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "functionCall") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FunctionCall_)))) :: ((S1 ('MetaSel ('Just "toolCalls") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [ToolCall])) :: S1 ('MetaSel ('Just "toolCallId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "audio") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe AudioResponse)) :*: S1 ('MetaSel ('Just "refusal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))))

data Role Source #

Represents different roles in a conversation User: Human user input Assistant: AI-generated response System: System-level instructions Developer: Special role for developer messages Tool: Tool interaction messages Function: Function call messages

Constructors

User
Assistant
System
Developer
Tool
Function

Instances

Instances details

FromJSON Role Source #
Instance details Defined in Langchain.LLM.OpenAI Methods parseJSON :: Value -> Parser Role # parseJSONList :: Value -> Parser [Role] # omittedField :: Maybe Role #
ToJSON Role Source #
Instance details Defined in Langchain.LLM.OpenAI Methods toJSON :: Role -> Value # toEncoding :: Role -> Encoding # toJSONList :: [Role] -> Value # toEncodingList :: [Role] -> Encoding # omitField :: Role -> Bool #
Generic Role Source #
Instance details Defined in Langchain.LLM.OpenAI Associated Types type Rep Role :: Type -> Type # Methods from :: Role -> Rep Role x # to :: Rep Role x -> Role #
Show Role Source #
Instance details Defined in Langchain.LLM.OpenAI Methods showsPrec :: Int -> Role -> ShowS # show :: Role -> String # showList :: [Role] -> ShowS #
Eq Role Source #
Instance details Defined in Langchain.LLM.OpenAI Methods (==) :: Role -> Role -> Bool # (/=) :: Role -> Role -> Bool #
type Rep Role Source #
Instance details Defined in Langchain.LLM.OpenAI type Rep Role = D1 ('MetaData "Role" "Langchain.LLM.OpenAI" "langchain-hs-0.0.1.0-inplace" 'False) ((C1 ('MetaCons "User" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Assistant" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "System" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "Developer" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Tool" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Function" 'PrefixI 'False) (U1 :: Type -> Type))))

data MessageContent Source #

Constructors

StringContent Text
ContentParts [TextContent]

Instances

Instances details

FromJSON MessageContent Source #
Instance details Defined in Langchain.LLM.OpenAI Methods parseJSON :: Value -> Parser MessageContent # parseJSONList :: Value -> Parser [MessageContent] # omittedField :: Maybe MessageContent #
ToJSON MessageContent Source #
Instance details Defined in Langchain.LLM.OpenAI Methods toJSON :: MessageContent -> Value # toEncoding :: MessageContent -> Encoding # toJSONList :: [MessageContent] -> Value # toEncodingList :: [MessageContent] -> Encoding # omitField :: MessageContent -> Bool #
Generic MessageContent Source #
Instance details Defined in Langchain.LLM.OpenAI Associated Types type Rep MessageContent :: Type -> Type # Methods from :: MessageContent -> Rep MessageContent x # to :: Rep MessageContent x -> MessageContent #
Show MessageContent Source #
Instance details Defined in Langchain.LLM.OpenAI Methods showsPrec :: Int -> MessageContent -> ShowS # show :: MessageContent -> String # showList :: [MessageContent] -> ShowS #
Eq MessageContent Source #
Instance details Defined in Langchain.LLM.OpenAI Methods (==) :: MessageContent -> MessageContent -> Bool # (/=) :: MessageContent -> MessageContent -> Bool #
type Rep MessageContent Source #
Instance details Defined in Langchain.LLM.OpenAI type Rep MessageContent = D1 ('MetaData "MessageContent" "Langchain.LLM.OpenAI" "langchain-hs-0.0.1.0-inplace" 'False) (C1 ('MetaCons "StringContent" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "ContentParts" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [TextContent])))

data TextContent Source #

Constructors

TextContent
Fields text_ :: Text contentType :: Text

Instances

Instances details

FromJSON TextContent Source #
Instance details Defined in Langchain.LLM.OpenAI Methods parseJSON :: Value -> Parser TextContent # parseJSONList :: Value -> Parser [TextContent] # omittedField :: Maybe TextContent #
ToJSON TextContent Source #
Instance details Defined in Langchain.LLM.OpenAI Methods toJSON :: TextContent -> Value # toEncoding :: TextContent -> Encoding # toJSONList :: [TextContent] -> Value # toEncodingList :: [TextContent] -> Encoding # omitField :: TextContent -> Bool #
Generic TextContent Source #
Instance details Defined in Langchain.LLM.OpenAI Associated Types type Rep TextContent :: Type -> Type # Methods from :: TextContent -> Rep TextContent x # to :: Rep TextContent x -> TextContent #
Show TextContent Source #
Instance details Defined in Langchain.LLM.OpenAI Methods showsPrec :: Int -> TextContent -> ShowS # show :: TextContent -> String # showList :: [TextContent] -> ShowS #
Eq TextContent Source #
Instance details Defined in Langchain.LLM.OpenAI Methods (==) :: TextContent -> TextContent -> Bool # (/=) :: TextContent -> TextContent -> Bool #
type Rep TextContent Source #
Instance details Defined in Langchain.LLM.OpenAI type Rep TextContent = D1 ('MetaData "TextContent" "Langchain.LLM.OpenAI" "langchain-hs-0.0.1.0-inplace" 'False) (C1 ('MetaCons "TextContent" 'PrefixI 'True) (S1 ('MetaSel ('Just "text_") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "contentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data Tool_ Source #

Constructors

Tool_
Fields toolType :: Text function :: Function_

Instances

Instances details

FromJSON Tool_ Source #
Instance details Defined in Langchain.LLM.OpenAI Methods parseJSON :: Value -> Parser Tool_ # parseJSONList :: Value -> Parser [Tool_] # omittedField :: Maybe Tool_ #
ToJSON Tool_ Source #
Instance details Defined in Langchain.LLM.OpenAI Methods toJSON :: Tool_ -> Value # toEncoding :: Tool_ -> Encoding # toJSONList :: [Tool_] -> Value # toEncodingList :: [Tool_] -> Encoding # omitField :: Tool_ -> Bool #
Generic Tool_ Source #
Instance details Defined in Langchain.LLM.OpenAI Associated Types type Rep Tool_ :: Type -> Type # Methods from :: Tool_ -> Rep Tool_ x # to :: Rep Tool_ x -> Tool_ #
Show Tool_ Source #
Instance details Defined in Langchain.LLM.OpenAI Methods showsPrec :: Int -> Tool_ -> ShowS # show :: Tool_ -> String # showList :: [Tool_] -> ShowS #
Eq Tool_ Source #
Instance details Defined in Langchain.LLM.OpenAI Methods (==) :: Tool_ -> Tool_ -> Bool # (/=) :: Tool_ -> Tool_ -> Bool #
type Rep Tool_ Source #
Instance details Defined in Langchain.LLM.OpenAI type Rep Tool_ = D1 ('MetaData "Tool_" "Langchain.LLM.OpenAI" "langchain-hs-0.0.1.0-inplace" 'False) (C1 ('MetaCons "Tool_" 'PrefixI 'True) (S1 ('MetaSel ('Just "toolType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "function") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Function_)))

data Function_ Source #

Constructors

Function_
Fields name :: Text description :: Maybe Text parameters :: Maybe Value strict :: Maybe Bool

Instances

Instances details

FromJSON Function_ Source #
Instance details Defined in Langchain.LLM.OpenAI Methods parseJSON :: Value -> Parser Function_ # parseJSONList :: Value -> Parser [Function_] # omittedField :: Maybe Function_ #
ToJSON Function_ Source #
Instance details Defined in Langchain.LLM.OpenAI Methods toJSON :: Function_ -> Value # toEncoding :: Function_ -> Encoding # toJSONList :: [Function_] -> Value # toEncodingList :: [Function_] -> Encoding # omitField :: Function_ -> Bool #
Generic Function_ Source #
Instance details Defined in Langchain.LLM.OpenAI Associated Types type Rep Function_ :: Type -> Type # Methods from :: Function_ -> Rep Function_ x # to :: Rep Function_ x -> Function_ #
Show Function_ Source #
Instance details Defined in Langchain.LLM.OpenAI Methods showsPrec :: Int -> Function_ -> ShowS # show :: Function_ -> String # showList :: [Function_] -> ShowS #
Eq Function_ Source #
Instance details Defined in Langchain.LLM.OpenAI Methods (==) :: Function_ -> Function_ -> Bool # (/=) :: Function_ -> Function_ -> Bool #
type Rep Function_ Source #
Instance details Defined in Langchain.LLM.OpenAI type Rep Function_ = D1 ('MetaData "Function_" "Langchain.LLM.OpenAI" "langchain-hs-0.0.1.0-inplace" 'False) (C1 ('MetaCons "Function_" 'PrefixI 'True) ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Value)) :*: S1 ('MetaSel ('Just "strict") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))))

data ToolCall Source #

Constructors

ToolCall
Fields id_ :: Text toolType :: Text function :: FunctionCall_

Instances

Instances details

FromJSON ToolCall Source #
Instance details Defined in Langchain.LLM.OpenAI Methods parseJSON :: Value -> Parser ToolCall # parseJSONList :: Value -> Parser [ToolCall] # omittedField :: Maybe ToolCall #
ToJSON ToolCall Source #
Instance details Defined in Langchain.LLM.OpenAI Methods toJSON :: ToolCall -> Value # toEncoding :: ToolCall -> Encoding # toJSONList :: [ToolCall] -> Value # toEncodingList :: [ToolCall] -> Encoding # omitField :: ToolCall -> Bool #
Generic ToolCall Source #
Instance details Defined in Langchain.LLM.OpenAI Associated Types type Rep ToolCall :: Type -> Type # Methods from :: ToolCall -> Rep ToolCall x # to :: Rep ToolCall x -> ToolCall #
Show ToolCall Source #
Instance details Defined in Langchain.LLM.OpenAI Methods showsPrec :: Int -> ToolCall -> ShowS # show :: ToolCall -> String # showList :: [ToolCall] -> ShowS #
Eq ToolCall Source #
Instance details Defined in Langchain.LLM.OpenAI Methods (==) :: ToolCall -> ToolCall -> Bool # (/=) :: ToolCall -> ToolCall -> Bool #
type Rep ToolCall Source #
Instance details Defined in Langchain.LLM.OpenAI type Rep ToolCall = D1 ('MetaData "ToolCall" "Langchain.LLM.OpenAI" "langchain-hs-0.0.1.0-inplace" 'False) (C1 ('MetaCons "ToolCall" 'PrefixI 'True) (S1 ('MetaSel ('Just "id_") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: (S1 ('MetaSel ('Just "toolType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "function") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FunctionCall_))))

data FunctionCall_ Source #

Constructors

FunctionCall_
Fields name :: Text arguments :: Text

Instances

Instances details

FromJSON FunctionCall_ Source #
Instance details Defined in Langchain.LLM.OpenAI Methods parseJSON :: Value -> Parser FunctionCall_ # parseJSONList :: Value -> Parser [FunctionCall_] # omittedField :: Maybe FunctionCall_ #
ToJSON FunctionCall_ Source #
Instance details Defined in Langchain.LLM.OpenAI Methods toJSON :: FunctionCall_ -> Value # toEncoding :: FunctionCall_ -> Encoding # toJSONList :: [FunctionCall_] -> Value # toEncodingList :: [FunctionCall_] -> Encoding # omitField :: FunctionCall_ -> Bool #
Generic FunctionCall_ Source #
Instance details Defined in Langchain.LLM.OpenAI Associated Types type Rep FunctionCall_ :: Type -> Type # Methods from :: FunctionCall_ -> Rep FunctionCall_ x # to :: Rep FunctionCall_ x -> FunctionCall_ #
Show FunctionCall_ Source #
Instance details Defined in Langchain.LLM.OpenAI Methods showsPrec :: Int -> FunctionCall_ -> ShowS # show :: FunctionCall_ -> String # showList :: [FunctionCall_] -> ShowS #
Eq FunctionCall_ Source #
Instance details Defined in Langchain.LLM.OpenAI Methods (==) :: FunctionCall_ -> FunctionCall_ -> Bool # (/=) :: FunctionCall_ -> FunctionCall_ -> Bool #
type Rep FunctionCall_ Source #
Instance details Defined in Langchain.LLM.OpenAI type Rep FunctionCall_ = D1 ('MetaData "FunctionCall_" "Langchain.LLM.OpenAI" "langchain-hs-0.0.1.0-inplace" 'False) (C1 ('MetaCons "FunctionCall_" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "arguments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data Usage Source #

Constructors

Usage
Fields completionTokens :: Int promptTokens :: Int totalTokens :: Int completionTokensDetails :: Maybe CompletionTokensDetails promptTokensDetails :: Maybe PromptTokensDetails

Instances

Instances details

FromJSON Usage Source #
Instance details Defined in Langchain.LLM.OpenAI Methods parseJSON :: Value -> Parser Usage # parseJSONList :: Value -> Parser [Usage] # omittedField :: Maybe Usage #
Generic Usage Source #
Instance details Defined in Langchain.LLM.OpenAI Associated Types type Rep Usage :: Type -> Type # Methods from :: Usage -> Rep Usage x # to :: Rep Usage x -> Usage #
Show Usage Source #
Instance details Defined in Langchain.LLM.OpenAI Methods showsPrec :: Int -> Usage -> ShowS # show :: Usage -> String # showList :: [Usage] -> ShowS #
Eq Usage Source #
Instance details Defined in Langchain.LLM.OpenAI Methods (==) :: Usage -> Usage -> Bool # (/=) :: Usage -> Usage -> Bool #
type Rep Usage Source #
Instance details Defined in Langchain.LLM.OpenAI type Rep Usage = D1 ('MetaData "Usage" "Langchain.LLM.OpenAI" "langchain-hs-0.0.1.0-inplace" 'False) (C1 ('MetaCons "Usage" 'PrefixI 'True) ((S1 ('MetaSel ('Just "completionTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :: S1 ('MetaSel ('Just "promptTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)) :: (S1 ('MetaSel ('Just "totalTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :: (S1 ('MetaSel ('Just "completionTokensDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe CompletionTokensDetails)) :: S1 ('MetaSel ('Just "promptTokensDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe PromptTokensDetails))))))

data Choice Source #

Constructors

Choice
Fields finishReason :: FinishReason index :: Int logprobs :: Maybe LogProbs message :: Message

Instances

Instances details

FromJSON Choice Source #
Instance details Defined in Langchain.LLM.OpenAI Methods parseJSON :: Value -> Parser Choice # parseJSONList :: Value -> Parser [Choice] # omittedField :: Maybe Choice #
Generic Choice Source #
Instance details Defined in Langchain.LLM.OpenAI 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 Langchain.LLM.OpenAI Methods showsPrec :: Int -> Choice -> ShowS # show :: Choice -> String # showList :: [Choice] -> ShowS #
Eq Choice Source #
Instance details Defined in Langchain.LLM.OpenAI Methods (==) :: Choice -> Choice -> Bool # (/=) :: Choice -> Choice -> Bool #
type Rep Choice Source #
Instance details Defined in Langchain.LLM.OpenAI type Rep Choice = D1 ('MetaData "Choice" "Langchain.LLM.OpenAI" "langchain-hs-0.0.1.0-inplace" 'False) (C1 ('MetaCons "Choice" 'PrefixI 'True) ((S1 ('MetaSel ('Just "finishReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FinishReason) :: S1 ('MetaSel ('Just "index") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)) :: (S1 ('MetaSel ('Just "logprobs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe LogProbs)) :*: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Message))))

data FinishReason Source #

Constructors

Stop
Length
ContentFilter
ToolCalls
FunctionCall

Instances

Instances details

FromJSON FinishReason Source #
Instance details Defined in Langchain.LLM.OpenAI Methods parseJSON :: Value -> Parser FinishReason # parseJSONList :: Value -> Parser [FinishReason] # omittedField :: Maybe FinishReason #
Generic FinishReason Source #
Instance details Defined in Langchain.LLM.OpenAI 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 Langchain.LLM.OpenAI Methods showsPrec :: Int -> FinishReason -> ShowS # show :: FinishReason -> String # showList :: [FinishReason] -> ShowS #
Eq FinishReason Source #
Instance details Defined in Langchain.LLM.OpenAI Methods (==) :: FinishReason -> FinishReason -> Bool # (/=) :: FinishReason -> FinishReason -> Bool #
type Rep FinishReason Source #
Instance details Defined in Langchain.LLM.OpenAI type Rep FinishReason = D1 ('MetaData "FinishReason" "Langchain.LLM.OpenAI" "langchain-hs-0.0.1.0-inplace" 'False) ((C1 ('MetaCons "Stop" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Length" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "ContentFilter" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ToolCalls" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "FunctionCall" 'PrefixI 'False) (U1 :: Type -> Type))))

data LogProbs Source #

Constructors

LogProbs
Fields content :: Maybe [LogProbContent] refusal :: Maybe [LogProbContent]

Instances

Instances details

FromJSON LogProbs Source #
Instance details Defined in Langchain.LLM.OpenAI Methods parseJSON :: Value -> Parser LogProbs # parseJSONList :: Value -> Parser [LogProbs] # omittedField :: Maybe LogProbs #
Generic LogProbs Source #
Instance details Defined in Langchain.LLM.OpenAI 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 Langchain.LLM.OpenAI Methods showsPrec :: Int -> LogProbs -> ShowS # show :: LogProbs -> String # showList :: [LogProbs] -> ShowS #
Eq LogProbs Source #
Instance details Defined in Langchain.LLM.OpenAI Methods (==) :: LogProbs -> LogProbs -> Bool # (/=) :: LogProbs -> LogProbs -> Bool #
type Rep LogProbs Source #
Instance details Defined in Langchain.LLM.OpenAI type Rep LogProbs = D1 ('MetaData "LogProbs" "Langchain.LLM.OpenAI" "langchain-hs-0.0.1.0-inplace" 'False) (C1 ('MetaCons "LogProbs" 'PrefixI 'True) (S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [LogProbContent])) :*: S1 ('MetaSel ('Just "refusal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [LogProbContent]))))

data LogProbContent Source #

Constructors

LogProbContent
Fields bytes :: Maybe [Int] logprob :: Double token :: Text topLogprobs :: [TopLogProb]

Instances

Instances details

FromJSON LogProbContent Source #
Instance details Defined in Langchain.LLM.OpenAI Methods parseJSON :: Value -> Parser LogProbContent # parseJSONList :: Value -> Parser [LogProbContent] # omittedField :: Maybe LogProbContent #
Generic LogProbContent Source #
Instance details Defined in Langchain.LLM.OpenAI Associated Types type Rep LogProbContent :: Type -> Type # Methods from :: LogProbContent -> Rep LogProbContent x # to :: Rep LogProbContent x -> LogProbContent #
Show LogProbContent Source #
Instance details Defined in Langchain.LLM.OpenAI Methods showsPrec :: Int -> LogProbContent -> ShowS # show :: LogProbContent -> String # showList :: [LogProbContent] -> ShowS #
Eq LogProbContent Source #
Instance details Defined in Langchain.LLM.OpenAI Methods (==) :: LogProbContent -> LogProbContent -> Bool # (/=) :: LogProbContent -> LogProbContent -> Bool #
type Rep LogProbContent Source #
Instance details Defined in Langchain.LLM.OpenAI type Rep LogProbContent = D1 ('MetaData "LogProbContent" "Langchain.LLM.OpenAI" "langchain-hs-0.0.1.0-inplace" 'False) (C1 ('MetaCons "LogProbContent" 'PrefixI 'True) ((S1 ('MetaSel ('Just "bytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Int])) :: S1 ('MetaSel ('Just "logprob") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double)) :: (S1 ('MetaSel ('Just "token") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "topLogprobs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [TopLogProb]))))

data TopLogProb Source #

Constructors

TopLogProb
Fields bytes :: Maybe [Int] logprob :: Double token :: Text

Instances

Instances details

FromJSON TopLogProb Source #
Instance details Defined in Langchain.LLM.OpenAI Methods parseJSON :: Value -> Parser TopLogProb # parseJSONList :: Value -> Parser [TopLogProb] # omittedField :: Maybe TopLogProb #
Generic TopLogProb Source #
Instance details Defined in Langchain.LLM.OpenAI Associated Types type Rep TopLogProb :: Type -> Type # Methods from :: TopLogProb -> Rep TopLogProb x # to :: Rep TopLogProb x -> TopLogProb #
Show TopLogProb Source #
Instance details Defined in Langchain.LLM.OpenAI Methods showsPrec :: Int -> TopLogProb -> ShowS # show :: TopLogProb -> String # showList :: [TopLogProb] -> ShowS #
Eq TopLogProb Source #
Instance details Defined in Langchain.LLM.OpenAI Methods (==) :: TopLogProb -> TopLogProb -> Bool # (/=) :: TopLogProb -> TopLogProb -> Bool #
type Rep TopLogProb Source #
Instance details Defined in Langchain.LLM.OpenAI type Rep TopLogProb = D1 ('MetaData "TopLogProb" "Langchain.LLM.OpenAI" "langchain-hs-0.0.1.0-inplace" 'False) (C1 ('MetaCons "TopLogProb" 'PrefixI 'True) (S1 ('MetaSel ('Just "bytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Int])) :: (S1 ('MetaSel ('Just "logprob") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :: S1 ('MetaSel ('Just "token") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))

data AudioConfig Source #

Configuration for audio processing Specifies format and voice preferences for text-to-speech

Constructors

AudioConfig
Fields format :: Text voice :: Text

Instances

Instances details

FromJSON AudioConfig Source #
Instance details Defined in Langchain.LLM.OpenAI Methods parseJSON :: Value -> Parser AudioConfig # parseJSONList :: Value -> Parser [AudioConfig] # omittedField :: Maybe AudioConfig #
ToJSON AudioConfig Source #
Instance details Defined in Langchain.LLM.OpenAI Methods toJSON :: AudioConfig -> Value # toEncoding :: AudioConfig -> Encoding # toJSONList :: [AudioConfig] -> Value # toEncodingList :: [AudioConfig] -> Encoding # omitField :: AudioConfig -> Bool #
Generic AudioConfig Source #
Instance details Defined in Langchain.LLM.OpenAI Associated Types type Rep AudioConfig :: Type -> Type # Methods from :: AudioConfig -> Rep AudioConfig x # to :: Rep AudioConfig x -> AudioConfig #
Show AudioConfig Source #
Instance details Defined in Langchain.LLM.OpenAI Methods showsPrec :: Int -> AudioConfig -> ShowS # show :: AudioConfig -> String # showList :: [AudioConfig] -> ShowS #
Eq AudioConfig Source #
Instance details Defined in Langchain.LLM.OpenAI Methods (==) :: AudioConfig -> AudioConfig -> Bool # (/=) :: AudioConfig -> AudioConfig -> Bool #
type Rep AudioConfig Source #
Instance details Defined in Langchain.LLM.OpenAI type Rep AudioConfig = D1 ('MetaData "AudioConfig" "Langchain.LLM.OpenAI" "langchain-hs-0.0.1.0-inplace" 'False) (C1 ('MetaCons "AudioConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "voice") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data AudioResponse Source #

Constructors

AudioResponse
Fields data_ :: Text expiresAt :: Integer id_ :: Text transcript :: Text

Instances

Instances details

FromJSON AudioResponse Source #
Instance details Defined in Langchain.LLM.OpenAI Methods parseJSON :: Value -> Parser AudioResponse # parseJSONList :: Value -> Parser [AudioResponse] # omittedField :: Maybe AudioResponse #
ToJSON AudioResponse Source #
Instance details Defined in Langchain.LLM.OpenAI Methods toJSON :: AudioResponse -> Value # toEncoding :: AudioResponse -> Encoding # toJSONList :: [AudioResponse] -> Value # toEncodingList :: [AudioResponse] -> Encoding # omitField :: AudioResponse -> Bool #
Generic AudioResponse Source #
Instance details Defined in Langchain.LLM.OpenAI Associated Types type Rep AudioResponse :: Type -> Type # Methods from :: AudioResponse -> Rep AudioResponse x # to :: Rep AudioResponse x -> AudioResponse #
Show AudioResponse Source #
Instance details Defined in Langchain.LLM.OpenAI Methods showsPrec :: Int -> AudioResponse -> ShowS # show :: AudioResponse -> String # showList :: [AudioResponse] -> ShowS #
Eq AudioResponse Source #
Instance details Defined in Langchain.LLM.OpenAI Methods (==) :: AudioResponse -> AudioResponse -> Bool # (/=) :: AudioResponse -> AudioResponse -> Bool #
type Rep AudioResponse Source #
Instance details Defined in Langchain.LLM.OpenAI type Rep AudioResponse = D1 ('MetaData "AudioResponse" "Langchain.LLM.OpenAI" "langchain-hs-0.0.1.0-inplace" 'False) (C1 ('MetaCons "AudioResponse" 'PrefixI 'True) ((S1 ('MetaSel ('Just "data_") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "expiresAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer)) :: (S1 ('MetaSel ('Just "id_") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "transcript") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))

data Modality Source #

Constructors

TextModality
AudioModality

Instances

Instances details

FromJSON Modality Source #
Instance details Defined in Langchain.LLM.OpenAI Methods parseJSON :: Value -> Parser Modality # parseJSONList :: Value -> Parser [Modality] # omittedField :: Maybe Modality #
ToJSON Modality Source #
Instance details Defined in Langchain.LLM.OpenAI Methods toJSON :: Modality -> Value # toEncoding :: Modality -> Encoding # toJSONList :: [Modality] -> Value # toEncodingList :: [Modality] -> Encoding # omitField :: Modality -> Bool #
Generic Modality Source #
Instance details Defined in Langchain.LLM.OpenAI 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 Langchain.LLM.OpenAI Methods showsPrec :: Int -> Modality -> ShowS # show :: Modality -> String # showList :: [Modality] -> ShowS #
Eq Modality Source #
Instance details Defined in Langchain.LLM.OpenAI Methods (==) :: Modality -> Modality -> Bool # (/=) :: Modality -> Modality -> Bool #
type Rep Modality Source #
Instance details Defined in Langchain.LLM.OpenAI type Rep Modality = D1 ('MetaData "Modality" "Langchain.LLM.OpenAI" "langchain-hs-0.0.1.0-inplace" 'False) (C1 ('MetaCons "TextModality" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "AudioModality" 'PrefixI 'False) (U1 :: Type -> Type))

data ToolChoice Source #

Constructors

None
Auto
Required
SpecificTool SpecificToolChoice

Instances

Instances details

FromJSON ToolChoice Source #
Instance details Defined in Langchain.LLM.OpenAI Methods parseJSON :: Value -> Parser ToolChoice # parseJSONList :: Value -> Parser [ToolChoice] # omittedField :: Maybe ToolChoice #
ToJSON ToolChoice Source #
Instance details Defined in Langchain.LLM.OpenAI Methods toJSON :: ToolChoice -> Value # toEncoding :: ToolChoice -> Encoding # toJSONList :: [ToolChoice] -> Value # toEncodingList :: [ToolChoice] -> Encoding # omitField :: ToolChoice -> Bool #
Generic ToolChoice Source #
Instance details Defined in Langchain.LLM.OpenAI Associated Types type Rep ToolChoice :: Type -> Type # Methods from :: ToolChoice -> Rep ToolChoice x # to :: Rep ToolChoice x -> ToolChoice #
Show ToolChoice Source #
Instance details Defined in Langchain.LLM.OpenAI Methods showsPrec :: Int -> ToolChoice -> ShowS # show :: ToolChoice -> String # showList :: [ToolChoice] -> ShowS #
Eq ToolChoice Source #
Instance details Defined in Langchain.LLM.OpenAI Methods (==) :: ToolChoice -> ToolChoice -> Bool # (/=) :: ToolChoice -> ToolChoice -> Bool #
type Rep ToolChoice Source #
Instance details Defined in Langchain.LLM.OpenAI type Rep ToolChoice = D1 ('MetaData "ToolChoice" "Langchain.LLM.OpenAI" "langchain-hs-0.0.1.0-inplace" 'False) ((C1 ('MetaCons "None" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Auto" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Required" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SpecificTool" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SpecificToolChoice))))

data SpecificToolChoice Source #

Constructors

SpecificToolChoice
Fields toolType :: Text function :: Value

Instances

Instances details

FromJSON SpecificToolChoice Source #
Instance details Defined in Langchain.LLM.OpenAI Methods parseJSON :: Value -> Parser SpecificToolChoice # parseJSONList :: Value -> Parser [SpecificToolChoice] # omittedField :: Maybe SpecificToolChoice #
ToJSON SpecificToolChoice Source #
Instance details Defined in Langchain.LLM.OpenAI Methods toJSON :: SpecificToolChoice -> Value # toEncoding :: SpecificToolChoice -> Encoding # toJSONList :: [SpecificToolChoice] -> Value # toEncodingList :: [SpecificToolChoice] -> Encoding # omitField :: SpecificToolChoice -> Bool #
Generic SpecificToolChoice Source #
Instance details Defined in Langchain.LLM.OpenAI Associated Types type Rep SpecificToolChoice :: Type -> Type # Methods from :: SpecificToolChoice -> Rep SpecificToolChoice x # to :: Rep SpecificToolChoice x -> SpecificToolChoice #
Show SpecificToolChoice Source #
Instance details Defined in Langchain.LLM.OpenAI Methods showsPrec :: Int -> SpecificToolChoice -> ShowS # show :: SpecificToolChoice -> String # showList :: [SpecificToolChoice] -> ShowS #
Eq SpecificToolChoice Source #
Instance details Defined in Langchain.LLM.OpenAI Methods (==) :: SpecificToolChoice -> SpecificToolChoice -> Bool # (/=) :: SpecificToolChoice -> SpecificToolChoice -> Bool #
type Rep SpecificToolChoice Source #
Instance details Defined in Langchain.LLM.OpenAI type Rep SpecificToolChoice = D1 ('MetaData "SpecificToolChoice" "Langchain.LLM.OpenAI" "langchain-hs-0.0.1.0-inplace" 'False) (C1 ('MetaCons "SpecificToolChoice" 'PrefixI 'True) (S1 ('MetaSel ('Just "toolType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "function") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Value)))

data ReasoningEffort Source #

Constructors

Low
Medium
High

Instances

Instances details

FromJSON ReasoningEffort Source #
Instance details Defined in Langchain.LLM.OpenAI Methods parseJSON :: Value -> Parser ReasoningEffort # parseJSONList :: Value -> Parser [ReasoningEffort] # omittedField :: Maybe ReasoningEffort #
ToJSON ReasoningEffort Source #
Instance details Defined in Langchain.LLM.OpenAI Methods toJSON :: ReasoningEffort -> Value # toEncoding :: ReasoningEffort -> Encoding # toJSONList :: [ReasoningEffort] -> Value # toEncodingList :: [ReasoningEffort] -> Encoding # omitField :: ReasoningEffort -> Bool #
Generic ReasoningEffort Source #
Instance details Defined in Langchain.LLM.OpenAI Associated Types type Rep ReasoningEffort :: Type -> Type # Methods from :: ReasoningEffort -> Rep ReasoningEffort x # to :: Rep ReasoningEffort x -> ReasoningEffort #
Show ReasoningEffort Source #
Instance details Defined in Langchain.LLM.OpenAI Methods showsPrec :: Int -> ReasoningEffort -> ShowS # show :: ReasoningEffort -> String # showList :: [ReasoningEffort] -> ShowS #
Eq ReasoningEffort Source #
Instance details Defined in Langchain.LLM.OpenAI Methods (==) :: ReasoningEffort -> ReasoningEffort -> Bool # (/=) :: ReasoningEffort -> ReasoningEffort -> Bool #
type Rep ReasoningEffort Source #
Instance details Defined in Langchain.LLM.OpenAI type Rep ReasoningEffort = D1 ('MetaData "ReasoningEffort" "Langchain.LLM.OpenAI" "langchain-hs-0.0.1.0-inplace" 'False) (C1 ('MetaCons "Low" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Medium" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "High" 'PrefixI 'False) (U1 :: Type -> Type)))

data PredictionOutput Source #

Constructors

PredictionOutput
Fields predictionType :: Text content :: MessageContent

Instances

Instances details

FromJSON PredictionOutput Source #
Instance details Defined in Langchain.LLM.OpenAI Methods parseJSON :: Value -> Parser PredictionOutput # parseJSONList :: Value -> Parser [PredictionOutput] # omittedField :: Maybe PredictionOutput #
ToJSON PredictionOutput Source #
Instance details Defined in Langchain.LLM.OpenAI Methods toJSON :: PredictionOutput -> Value # toEncoding :: PredictionOutput -> Encoding # toJSONList :: [PredictionOutput] -> Value # toEncodingList :: [PredictionOutput] -> Encoding # omitField :: PredictionOutput -> Bool #
Generic PredictionOutput Source #
Instance details Defined in Langchain.LLM.OpenAI Associated Types type Rep PredictionOutput :: Type -> Type # Methods from :: PredictionOutput -> Rep PredictionOutput x # to :: Rep PredictionOutput x -> PredictionOutput #
Show PredictionOutput Source #
Instance details Defined in Langchain.LLM.OpenAI Methods showsPrec :: Int -> PredictionOutput -> ShowS # show :: PredictionOutput -> String # showList :: [PredictionOutput] -> ShowS #
Eq PredictionOutput Source #
Instance details Defined in Langchain.LLM.OpenAI Methods (==) :: PredictionOutput -> PredictionOutput -> Bool # (/=) :: PredictionOutput -> PredictionOutput -> Bool #
type Rep PredictionOutput Source #
Instance details Defined in Langchain.LLM.OpenAI type Rep PredictionOutput = D1 ('MetaData "PredictionOutput" "Langchain.LLM.OpenAI" "langchain-hs-0.0.1.0-inplace" 'False) (C1 ('MetaCons "PredictionOutput" 'PrefixI 'True) (S1 ('MetaSel ('Just "predictionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MessageContent)))

data PredictionContent Source #

Constructors

PredictionContent
Fields content :: MessageContent contentType :: Text

Instances

Instances details

FromJSON PredictionContent Source #
Instance details Defined in Langchain.LLM.OpenAI Methods parseJSON :: Value -> Parser PredictionContent # parseJSONList :: Value -> Parser [PredictionContent] # omittedField :: Maybe PredictionContent #
ToJSON PredictionContent Source #
Instance details Defined in Langchain.LLM.OpenAI Methods toJSON :: PredictionContent -> Value # toEncoding :: PredictionContent -> Encoding # toJSONList :: [PredictionContent] -> Value # toEncodingList :: [PredictionContent] -> Encoding # omitField :: PredictionContent -> Bool #
Generic PredictionContent Source #
Instance details Defined in Langchain.LLM.OpenAI Associated Types type Rep PredictionContent :: Type -> Type # Methods from :: PredictionContent -> Rep PredictionContent x # to :: Rep PredictionContent x -> PredictionContent #
Show PredictionContent Source #
Instance details Defined in Langchain.LLM.OpenAI Methods showsPrec :: Int -> PredictionContent -> ShowS # show :: PredictionContent -> String # showList :: [PredictionContent] -> ShowS #
Eq PredictionContent Source #
Instance details Defined in Langchain.LLM.OpenAI Methods (==) :: PredictionContent -> PredictionContent -> Bool # (/=) :: PredictionContent -> PredictionContent -> Bool #
type Rep PredictionContent Source #
Instance details Defined in Langchain.LLM.OpenAI type Rep PredictionContent = D1 ('MetaData "PredictionContent" "Langchain.LLM.OpenAI" "langchain-hs-0.0.1.0-inplace" 'False) (C1 ('MetaCons "PredictionContent" 'PrefixI 'True) (S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MessageContent) :*: S1 ('MetaSel ('Just "contentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data ResponseFormat Source #

Constructors

JsonObjectFormat
JsonSchemaFormat Value

Instances

Instances details

FromJSON ResponseFormat Source #
Instance details Defined in Langchain.LLM.OpenAI Methods parseJSON :: Value -> Parser ResponseFormat # parseJSONList :: Value -> Parser [ResponseFormat] # omittedField :: Maybe ResponseFormat #
ToJSON ResponseFormat Source #
Instance details Defined in Langchain.LLM.OpenAI Methods toJSON :: ResponseFormat -> Value # toEncoding :: ResponseFormat -> Encoding # toJSONList :: [ResponseFormat] -> Value # toEncodingList :: [ResponseFormat] -> Encoding # omitField :: ResponseFormat -> Bool #
Generic ResponseFormat Source #
Instance details Defined in Langchain.LLM.OpenAI 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 Langchain.LLM.OpenAI Methods showsPrec :: Int -> ResponseFormat -> ShowS # show :: ResponseFormat -> String # showList :: [ResponseFormat] -> ShowS #
Eq ResponseFormat Source #
Instance details Defined in Langchain.LLM.OpenAI Methods (==) :: ResponseFormat -> ResponseFormat -> Bool # (/=) :: ResponseFormat -> ResponseFormat -> Bool #
type Rep ResponseFormat Source #
Instance details Defined in Langchain.LLM.OpenAI type Rep ResponseFormat = D1 ('MetaData "ResponseFormat" "Langchain.LLM.OpenAI" "langchain-hs-0.0.1.0-inplace" 'False) (C1 ('MetaCons "JsonObjectFormat" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "JsonSchemaFormat" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Value)))

data StreamOptions Source #

Constructors

StreamOptions
Fields includeUsage :: Bool

Instances

Instances details

FromJSON StreamOptions Source #
Instance details Defined in Langchain.LLM.OpenAI Methods parseJSON :: Value -> Parser StreamOptions # parseJSONList :: Value -> Parser [StreamOptions] # omittedField :: Maybe StreamOptions #
ToJSON StreamOptions Source #
Instance details Defined in Langchain.LLM.OpenAI Methods toJSON :: StreamOptions -> Value # toEncoding :: StreamOptions -> Encoding # toJSONList :: [StreamOptions] -> Value # toEncodingList :: [StreamOptions] -> Encoding # omitField :: StreamOptions -> Bool #
Generic StreamOptions Source #
Instance details Defined in Langchain.LLM.OpenAI Associated Types type Rep StreamOptions :: Type -> Type # Methods from :: StreamOptions -> Rep StreamOptions x # to :: Rep StreamOptions x -> StreamOptions #
Show StreamOptions Source #
Instance details Defined in Langchain.LLM.OpenAI Methods showsPrec :: Int -> StreamOptions -> ShowS # show :: StreamOptions -> String # showList :: [StreamOptions] -> ShowS #
Eq StreamOptions Source #
Instance details Defined in Langchain.LLM.OpenAI Methods (==) :: StreamOptions -> StreamOptions -> Bool # (/=) :: StreamOptions -> StreamOptions -> Bool #
type Rep StreamOptions Source #
Instance details Defined in Langchain.LLM.OpenAI type Rep StreamOptions = D1 ('MetaData "StreamOptions" "Langchain.LLM.OpenAI" "langchain-hs-0.0.1.0-inplace" 'False) (C1 ('MetaCons "StreamOptions" 'PrefixI 'True) (S1 ('MetaSel ('Just "includeUsage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))

data WebSearchOptions Source #

Constructors

WebSearchOptions
Fields searchContextSize :: Maybe Text userLocation :: Maybe UserLocation

Instances

Instances details

FromJSON WebSearchOptions Source #
Instance details Defined in Langchain.LLM.OpenAI Methods parseJSON :: Value -> Parser WebSearchOptions # parseJSONList :: Value -> Parser [WebSearchOptions] # omittedField :: Maybe WebSearchOptions #
ToJSON WebSearchOptions Source #
Instance details Defined in Langchain.LLM.OpenAI Methods toJSON :: WebSearchOptions -> Value # toEncoding :: WebSearchOptions -> Encoding # toJSONList :: [WebSearchOptions] -> Value # toEncodingList :: [WebSearchOptions] -> Encoding # omitField :: WebSearchOptions -> Bool #
Generic WebSearchOptions Source #
Instance details Defined in Langchain.LLM.OpenAI Associated Types type Rep WebSearchOptions :: Type -> Type # Methods from :: WebSearchOptions -> Rep WebSearchOptions x # to :: Rep WebSearchOptions x -> WebSearchOptions #
Show WebSearchOptions Source #
Instance details Defined in Langchain.LLM.OpenAI Methods showsPrec :: Int -> WebSearchOptions -> ShowS # show :: WebSearchOptions -> String # showList :: [WebSearchOptions] -> ShowS #
Eq WebSearchOptions Source #
Instance details Defined in Langchain.LLM.OpenAI Methods (==) :: WebSearchOptions -> WebSearchOptions -> Bool # (/=) :: WebSearchOptions -> WebSearchOptions -> Bool #
type Rep WebSearchOptions Source #
Instance details Defined in Langchain.LLM.OpenAI type Rep WebSearchOptions = D1 ('MetaData "WebSearchOptions" "Langchain.LLM.OpenAI" "langchain-hs-0.0.1.0-inplace" 'False) (C1 ('MetaCons "WebSearchOptions" 'PrefixI 'True) (S1 ('MetaSel ('Just "searchContextSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "userLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe UserLocation))))

data UserLocation Source #

Constructors

UserLocation
Fields approximate :: ApproximateLocation

Instances

Instances details

FromJSON UserLocation Source #
Instance details Defined in Langchain.LLM.OpenAI Methods parseJSON :: Value -> Parser UserLocation # parseJSONList :: Value -> Parser [UserLocation] # omittedField :: Maybe UserLocation #
ToJSON UserLocation Source #
Instance details Defined in Langchain.LLM.OpenAI Methods toJSON :: UserLocation -> Value # toEncoding :: UserLocation -> Encoding # toJSONList :: [UserLocation] -> Value # toEncodingList :: [UserLocation] -> Encoding # omitField :: UserLocation -> Bool #
Generic UserLocation Source #
Instance details Defined in Langchain.LLM.OpenAI Associated Types type Rep UserLocation :: Type -> Type # Methods from :: UserLocation -> Rep UserLocation x # to :: Rep UserLocation x -> UserLocation #
Show UserLocation Source #
Instance details Defined in Langchain.LLM.OpenAI Methods showsPrec :: Int -> UserLocation -> ShowS # show :: UserLocation -> String # showList :: [UserLocation] -> ShowS #
Eq UserLocation Source #
Instance details Defined in Langchain.LLM.OpenAI Methods (==) :: UserLocation -> UserLocation -> Bool # (/=) :: UserLocation -> UserLocation -> Bool #
type Rep UserLocation Source #
Instance details Defined in Langchain.LLM.OpenAI type Rep UserLocation = D1 ('MetaData "UserLocation" "Langchain.LLM.OpenAI" "langchain-hs-0.0.1.0-inplace" 'False) (C1 ('MetaCons "UserLocation" 'PrefixI 'True) (S1 ('MetaSel ('Just "approximate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ApproximateLocation)))

data ApproximateLocation Source #

Constructors

ApproximateLocation
Fields locationType :: Text

Instances

Instances details

FromJSON ApproximateLocation Source #
Instance details Defined in Langchain.LLM.OpenAI Methods parseJSON :: Value -> Parser ApproximateLocation # parseJSONList :: Value -> Parser [ApproximateLocation] # omittedField :: Maybe ApproximateLocation #
ToJSON ApproximateLocation Source #
Instance details Defined in Langchain.LLM.OpenAI Methods toJSON :: ApproximateLocation -> Value # toEncoding :: ApproximateLocation -> Encoding # toJSONList :: [ApproximateLocation] -> Value # toEncodingList :: [ApproximateLocation] -> Encoding # omitField :: ApproximateLocation -> Bool #
Generic ApproximateLocation Source #
Instance details Defined in Langchain.LLM.OpenAI Associated Types type Rep ApproximateLocation :: Type -> Type # Methods from :: ApproximateLocation -> Rep ApproximateLocation x # to :: Rep ApproximateLocation x -> ApproximateLocation #
Show ApproximateLocation Source #
Instance details Defined in Langchain.LLM.OpenAI Methods showsPrec :: Int -> ApproximateLocation -> ShowS # show :: ApproximateLocation -> String # showList :: [ApproximateLocation] -> ShowS #
Eq ApproximateLocation Source #
Instance details Defined in Langchain.LLM.OpenAI Methods (==) :: ApproximateLocation -> ApproximateLocation -> Bool # (/=) :: ApproximateLocation -> ApproximateLocation -> Bool #
type Rep ApproximateLocation Source #
Instance details Defined in Langchain.LLM.OpenAI type Rep ApproximateLocation = D1 ('MetaData "ApproximateLocation" "Langchain.LLM.OpenAI" "langchain-hs-0.0.1.0-inplace" 'False) (C1 ('MetaCons "ApproximateLocation" 'PrefixI 'True) (S1 ('MetaSel ('Just "locationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data CompletionTokensDetails Source #

Constructors

CompletionTokensDetails
Fields acceptedPredictionTokens :: Int audioTokens :: Int reasoningTokens :: Int rejectedPredictionTokens :: Int

Instances

Instances details

FromJSON CompletionTokensDetails Source #
Instance details Defined in Langchain.LLM.OpenAI Methods parseJSON :: Value -> Parser CompletionTokensDetails # parseJSONList :: Value -> Parser [CompletionTokensDetails] # omittedField :: Maybe CompletionTokensDetails #
Generic CompletionTokensDetails Source #
Instance details Defined in Langchain.LLM.OpenAI Associated Types type Rep CompletionTokensDetails :: Type -> Type # Methods from :: CompletionTokensDetails -> Rep CompletionTokensDetails x # to :: Rep CompletionTokensDetails x -> CompletionTokensDetails #
Show CompletionTokensDetails Source #
Instance details Defined in Langchain.LLM.OpenAI Methods showsPrec :: Int -> CompletionTokensDetails -> ShowS # show :: CompletionTokensDetails -> String # showList :: [CompletionTokensDetails] -> ShowS #
Eq CompletionTokensDetails Source #
Instance details Defined in Langchain.LLM.OpenAI Methods (==) :: CompletionTokensDetails -> CompletionTokensDetails -> Bool # (/=) :: CompletionTokensDetails -> CompletionTokensDetails -> Bool #
type Rep CompletionTokensDetails Source #
Instance details Defined in Langchain.LLM.OpenAI type Rep CompletionTokensDetails = D1 ('MetaData "CompletionTokensDetails" "Langchain.LLM.OpenAI" "langchain-hs-0.0.1.0-inplace" 'False) (C1 ('MetaCons "CompletionTokensDetails" 'PrefixI 'True) ((S1 ('MetaSel ('Just "acceptedPredictionTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :: S1 ('MetaSel ('Just "audioTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)) :: (S1 ('MetaSel ('Just "reasoningTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Just "rejectedPredictionTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int))))

data PromptTokensDetails Source #

Constructors

PromptTokensDetails
Fields audioTokens :: Int cachedTokens :: Int

Instances

Instances details

FromJSON PromptTokensDetails Source #
Instance details Defined in Langchain.LLM.OpenAI Methods parseJSON :: Value -> Parser PromptTokensDetails # parseJSONList :: Value -> Parser [PromptTokensDetails] # omittedField :: Maybe PromptTokensDetails #
Generic PromptTokensDetails Source #
Instance details Defined in Langchain.LLM.OpenAI Associated Types type Rep PromptTokensDetails :: Type -> Type # Methods from :: PromptTokensDetails -> Rep PromptTokensDetails x # to :: Rep PromptTokensDetails x -> PromptTokensDetails #
Show PromptTokensDetails Source #
Instance details Defined in Langchain.LLM.OpenAI Methods showsPrec :: Int -> PromptTokensDetails -> ShowS # show :: PromptTokensDetails -> String # showList :: [PromptTokensDetails] -> ShowS #
Eq PromptTokensDetails Source #
Instance details Defined in Langchain.LLM.OpenAI Methods (==) :: PromptTokensDetails -> PromptTokensDetails -> Bool # (/=) :: PromptTokensDetails -> PromptTokensDetails -> Bool #
type Rep PromptTokensDetails Source #
Instance details Defined in Langchain.LLM.OpenAI type Rep PromptTokensDetails = D1 ('MetaData "PromptTokensDetails" "Langchain.LLM.OpenAI" "langchain-hs-0.0.1.0-inplace" 'False) (C1 ('MetaCons "PromptTokensDetails" 'PrefixI 'True) (S1 ('MetaSel ('Just "audioTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Just "cachedTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

Functions

createChatCompletion :: Text -> ChatCompletionRequest -> IO (Either String ChatCompletionResponse) Source #

Creates a chat completion request Sends the request to OpenAI API and returns the parsed response.

Example usage: response <- createChatCompletion "your-api-key" request case response of Right res -> print (choices res) Left err -> putStrLn err

defaultChatCompletionRequest :: ChatCompletionRequest Source #

Default chat completion request Uses "gpt-4o-mini-2024-07-18" as the default model. All other parameters are set to Nothing.

defaultMessage :: Message Source #