Safe Haskell	Safe-Inferred
Language	Haskell2010

IHP.OpenAI

Documentation

data CompletionRequest Source #

Constructors

CompletionRequest
Fields messages :: ![Message] model :: !Text maxTokens :: !(Maybe Int) temperature :: !(Maybe Double) presencePenalty :: !(Maybe Double) frequencePenalty :: !(Maybe Double) stream :: !Bool responseFormat :: !(Maybe ResponseFormat) tools :: ![Tool]

Instances

Instances details

ToJSON CompletionRequest Source #
Instance details Defined in IHP.OpenAI Methods toJSON :: CompletionRequest -> Value # toEncoding :: CompletionRequest -> Encoding # toJSONList :: [CompletionRequest] -> Value # toEncodingList :: [CompletionRequest] -> Encoding # omitField :: CompletionRequest -> Bool #
Show CompletionRequest Source #
Instance details Defined in IHP.OpenAI Methods showsPrec :: Int -> CompletionRequest -> ShowS # show :: CompletionRequest -> String # showList :: [CompletionRequest] -> ShowS #
Eq CompletionRequest Source #
Instance details Defined in IHP.OpenAI Methods (==) :: CompletionRequest -> CompletionRequest -> Bool # (/=) :: CompletionRequest -> CompletionRequest -> Bool #

data Message Source #

Constructors

Message
Fields role :: !Role content :: !Text name :: !(Maybe Text) toolCallId :: !(Maybe Text) toolCalls :: ![ToolCall]

Instances

Instances details

ToJSON Message Source #
Instance details Defined in IHP.OpenAI Methods toJSON :: Message -> Value # toEncoding :: Message -> Encoding # toJSONList :: [Message] -> Value # toEncodingList :: [Message] -> Encoding # omitField :: Message -> Bool #
Show Message Source #
Instance details Defined in IHP.OpenAI Methods showsPrec :: Int -> Message -> ShowS # show :: Message -> String # showList :: [Message] -> ShowS #
Eq Message Source #
Instance details Defined in IHP.OpenAI Methods (==) :: Message -> Message -> Bool # (/=) :: Message -> Message -> Bool #

data Role Source #

Constructors

UserRole
SystemRole
AssistantRole
ToolRole

Instances

Instances details

FromJSON Role Source #
Instance details Defined in IHP.OpenAI Methods parseJSON :: Value -> Parser Role # parseJSONList :: Value -> Parser [Role] # omittedField :: Maybe Role #
ToJSON Role Source #
Instance details Defined in IHP.OpenAI Methods toJSON :: Role -> Value # toEncoding :: Role -> Encoding # toJSONList :: [Role] -> Value # toEncodingList :: [Role] -> Encoding # omitField :: Role -> Bool #
Show Role Source #
Instance details Defined in IHP.OpenAI Methods showsPrec :: Int -> Role -> ShowS # show :: Role -> String # showList :: [Role] -> ShowS #
Eq Role Source #
Instance details Defined in IHP.OpenAI Methods (==) :: Role -> Role -> Bool # (/=) :: Role -> Role -> Bool #

data ResponseFormat Source #

Constructors

Text
JsonObject

Instances

Instances details

ToJSON ResponseFormat Source #
Instance details Defined in IHP.OpenAI Methods toJSON :: ResponseFormat -> Value # toEncoding :: ResponseFormat -> Encoding # toJSONList :: [ResponseFormat] -> Value # toEncodingList :: [ResponseFormat] -> Encoding # omitField :: ResponseFormat -> Bool #
Show ResponseFormat Source #
Instance details Defined in IHP.OpenAI Methods showsPrec :: Int -> ResponseFormat -> ShowS # show :: ResponseFormat -> String # showList :: [ResponseFormat] -> ShowS #
Eq ResponseFormat Source #
Instance details Defined in IHP.OpenAI Methods (==) :: ResponseFormat -> ResponseFormat -> Bool # (/=) :: ResponseFormat -> ResponseFormat -> Bool #

data Tool Source #

Constructors

Function
Fields description :: !(Maybe Text) name :: !Text parameters :: !(Maybe JsonSchema)

Instances

Instances details

ToJSON Tool Source #
Instance details Defined in IHP.OpenAI Methods toJSON :: Tool -> Value # toEncoding :: Tool -> Encoding # toJSONList :: [Tool] -> Value # toEncodingList :: [Tool] -> Encoding # omitField :: Tool -> Bool #
Show Tool Source #
Instance details Defined in IHP.OpenAI Methods showsPrec :: Int -> Tool -> ShowS # show :: Tool -> String # showList :: [Tool] -> ShowS #
Eq Tool Source #
Instance details Defined in IHP.OpenAI Methods (==) :: Tool -> Tool -> Bool # (/=) :: Tool -> Tool -> Bool #

data JsonSchema Source #

Constructors

JsonSchemaObject ![Property]
JsonSchemaString
JsonSchemaInteger
JsonSchemaNumber
JsonSchemaArray !JsonSchema
JsonSchemaEnum ![Text]

Instances

Instances details

ToJSON JsonSchema Source #
Instance details Defined in IHP.OpenAI Methods toJSON :: JsonSchema -> Value # toEncoding :: JsonSchema -> Encoding # toJSONList :: [JsonSchema] -> Value # toEncodingList :: [JsonSchema] -> Encoding # omitField :: JsonSchema -> Bool #
Show JsonSchema Source #
Instance details Defined in IHP.OpenAI Methods showsPrec :: Int -> JsonSchema -> ShowS # show :: JsonSchema -> String # showList :: [JsonSchema] -> ShowS #
Eq JsonSchema Source #
Instance details Defined in IHP.OpenAI Methods (==) :: JsonSchema -> JsonSchema -> Bool # (/=) :: JsonSchema -> JsonSchema -> Bool #

data Property Source #

Constructors

Property
Fields propertyName :: !Text type_ :: !JsonSchema required :: !Bool description :: !(Maybe Text)

Instances

Instances details

Show Property Source #
Instance details Defined in IHP.OpenAI Methods showsPrec :: Int -> Property -> ShowS # show :: Property -> String # showList :: [Property] -> ShowS #
Eq Property Source #
Instance details Defined in IHP.OpenAI Methods (==) :: Property -> Property -> Bool # (/=) :: Property -> Property -> Bool #

userMessage :: Text -> Message Source #

systemMessage :: Text -> Message Source #

assistantMessage :: Text -> Message Source #

toolMessage :: Text -> Message Source #

newCompletionRequest :: CompletionRequest Source #

data CompletionResult Source #

Constructors

CompletionResult
Fields choices :: [Choice]
CompletionError
Fields message :: !Text

Instances

Instances details

FromJSON CompletionResult Source #
Instance details Defined in IHP.OpenAI Methods parseJSON :: Value -> Parser CompletionResult # parseJSONList :: Value -> Parser [CompletionResult] # omittedField :: Maybe CompletionResult #
Show CompletionResult Source #
Instance details Defined in IHP.OpenAI Methods showsPrec :: Int -> CompletionResult -> ShowS # show :: CompletionResult -> String # showList :: [CompletionResult] -> ShowS #
Eq CompletionResult Source #
Instance details Defined in IHP.OpenAI Methods (==) :: CompletionResult -> CompletionResult -> Bool # (/=) :: CompletionResult -> CompletionResult -> Bool #

data Choice Source #

Constructors

Choice
Fields text :: !Text

Instances

Instances details

FromJSON Choice Source #
Instance details Defined in IHP.OpenAI Methods parseJSON :: Value -> Parser Choice # parseJSONList :: Value -> Parser [Choice] # omittedField :: Maybe Choice #
Show Choice Source #
Instance details Defined in IHP.OpenAI Methods showsPrec :: Int -> Choice -> ShowS # show :: Choice -> String # showList :: [Choice] -> ShowS #
Eq Choice Source #
Instance details Defined in IHP.OpenAI Methods (==) :: Choice -> Choice -> Bool # (/=) :: Choice -> Choice -> Bool #

streamCompletion :: ByteString -> CompletionRequest -> IO () -> (CompletionChunk -> IO ()) -> IO [CompletionChunk] Source #

streamCompletionWithoutRetry :: ByteString -> CompletionRequest -> IO () -> (CompletionChunk -> IO ()) -> IO (Either Text [CompletionChunk]) Source #

data ParserState Source #

Constructors

ParserState
Fields curBuffer :: !ByteString emptyLineFound :: !Bool chunks :: ![CompletionChunk]

Instances

Instances details

Show ParserState Source #
Instance details Defined in IHP.OpenAI Methods showsPrec :: Int -> ParserState -> ShowS # show :: ParserState -> String # showList :: [ParserState] -> ShowS #
Eq ParserState Source #
Instance details Defined in IHP.OpenAI Methods (==) :: ParserState -> ParserState -> Bool # (/=) :: ParserState -> ParserState -> Bool #

data ParserResult Source #

Constructors

ParserResult
Fields chunk :: !(Maybe CompletionChunk) state :: ParserState

Instances

Instances details

Show ParserResult Source #
Instance details Defined in IHP.OpenAI Methods showsPrec :: Int -> ParserResult -> ShowS # show :: ParserResult -> String # showList :: [ParserResult] -> ShowS #
Eq ParserResult Source #
Instance details Defined in IHP.OpenAI Methods (==) :: ParserResult -> ParserResult -> Bool # (/=) :: ParserResult -> ParserResult -> Bool #

emptyParserState :: ParserState Source #

parseResponseChunk :: ParserState -> ByteString -> ParserResult Source #

fetchCompletion :: ByteString -> CompletionRequest -> IO Text Source #

fetchCompletionWithoutRetry :: ByteString -> CompletionRequest -> IO CompletionResult Source #

enableStream :: CompletionRequest -> CompletionRequest Source #

data CompletionChunk Source #

Constructors

CompletionChunk
Fields id :: !Text choices :: [CompletionChunkChoice] created :: Int model :: !Text systemFingerprint :: !(Maybe Text)

Instances

Instances details

FromJSON CompletionChunk Source #
Instance details Defined in IHP.OpenAI Methods parseJSON :: Value -> Parser CompletionChunk # parseJSONList :: Value -> Parser [CompletionChunk] # omittedField :: Maybe CompletionChunk #
Show CompletionChunk Source #
Instance details Defined in IHP.OpenAI Methods showsPrec :: Int -> CompletionChunk -> ShowS # show :: CompletionChunk -> String # showList :: [CompletionChunk] -> ShowS #
Eq CompletionChunk Source #
Instance details Defined in IHP.OpenAI Methods (==) :: CompletionChunk -> CompletionChunk -> Bool # (/=) :: CompletionChunk -> CompletionChunk -> Bool #

data CompletionChunkChoice Source #

Constructors

CompletionChunkChoice
Fields delta :: !Delta

Instances

Instances details

FromJSON CompletionChunkChoice Source #
Instance details Defined in IHP.OpenAI Methods parseJSON :: Value -> Parser CompletionChunkChoice # parseJSONList :: Value -> Parser [CompletionChunkChoice] # omittedField :: Maybe CompletionChunkChoice #
Show CompletionChunkChoice Source #
Instance details Defined in IHP.OpenAI Methods showsPrec :: Int -> CompletionChunkChoice -> ShowS # show :: CompletionChunkChoice -> String # showList :: [CompletionChunkChoice] -> ShowS #
Eq CompletionChunkChoice Source #
Instance details Defined in IHP.OpenAI Methods (==) :: CompletionChunkChoice -> CompletionChunkChoice -> Bool # (/=) :: CompletionChunkChoice -> CompletionChunkChoice -> Bool #

data Delta Source #

Constructors

Delta
Fields content :: !(Maybe Text) toolCalls :: !(Maybe [ToolCall]) role :: !(Maybe Role)

Instances

Instances details

FromJSON Delta Source #
Instance details Defined in IHP.OpenAI Methods parseJSON :: Value -> Parser Delta # parseJSONList :: Value -> Parser [Delta] # omittedField :: Maybe Delta #
Show Delta Source #
Instance details Defined in IHP.OpenAI Methods showsPrec :: Int -> Delta -> ShowS # show :: Delta -> String # showList :: [Delta] -> ShowS #
Eq Delta Source #
Instance details Defined in IHP.OpenAI Methods (==) :: Delta -> Delta -> Bool # (/=) :: Delta -> Delta -> Bool #

data ToolCall Source #

Constructors

FunctionCall
Fields index :: !Int id :: !(Maybe Text) name :: !(Maybe Text) arguments :: !Text

Instances

Instances details

FromJSON ToolCall Source #
Instance details Defined in IHP.OpenAI Methods parseJSON :: Value -> Parser ToolCall # parseJSONList :: Value -> Parser [ToolCall] # omittedField :: Maybe ToolCall #
ToJSON ToolCall Source #
Instance details Defined in IHP.OpenAI Methods toJSON :: ToolCall -> Value # toEncoding :: ToolCall -> Encoding # toJSONList :: [ToolCall] -> Value # toEncodingList :: [ToolCall] -> Encoding # omitField :: ToolCall -> Bool #
Show ToolCall Source #
Instance details Defined in IHP.OpenAI Methods showsPrec :: Int -> ToolCall -> ShowS # show :: ToolCall -> String # showList :: [ToolCall] -> ShowS #
Eq ToolCall Source #
Instance details Defined in IHP.OpenAI Methods (==) :: ToolCall -> ToolCall -> Bool # (/=) :: ToolCall -> ToolCall -> Bool #

emptyListToNothing :: [value] -> Maybe [value] Source #