Safe Haskell	Safe-Inferred
Language	GHC2021

Data.Ollama.Chat

Contents

Chat APIs

Synopsis

chat :: ChatOps -> IO (Either String ChatResponse)
data Message = Message {
- role :: Role
- content :: Text
- images :: Maybe [Text]
}
data Role
- = System
- | User
- | Assistant
- | Tool
defaultChatOps :: ChatOps
data ChatOps = ChatOps {
- chatModelName :: Text
- messages :: NonEmpty Message
- tools :: Maybe Text
- format :: Maybe Text
- stream :: Maybe (ChatResponse -> IO (), IO ())
- keepAlive :: Maybe Text
}
data ChatResponse = ChatResponse {
- model :: Text
- createdAt :: UTCTime
- message :: Maybe Message
- done :: Bool
- totalDuration :: Maybe Int64
- loadDuration :: Maybe Int64
- promptEvalCount :: Maybe Int64
- promptEvalDuration :: Maybe Int64
- evalCount :: Maybe Int64
- evalDuration :: Maybe Int64
}

Chat APIs

chat :: ChatOps -> IO (Either String ChatResponse) Source #

Initiates a chat session with the specified ChatOps configuration and returns either a ChatResponse or an error message.

This function sends a request to the Ollama chat API with the given options.

Example:

let ops = defaultChatOps
result <- chat ops
case result of
  Left errorMsg -> putStrLn ("Error: " ++ errorMsg)
  Right response -> print response

data Message Source #

Represents a message within a chat, including its role and content.

Constructors

Message
Fields role :: Role The role of the entity sending the message (e.g., `User`, `Assistant`). content :: Text The textual content of the message. images :: Maybe [Text] Optional list of base64 encoded images that accompany the message.

Instances

Instances details

FromJSON Message Source #
Instance details Defined in Data.Ollama.Chat Methods parseJSON :: Value -> Parser Message # parseJSONList :: Value -> Parser [Message] # omittedField :: Maybe Message #
ToJSON Message Source #
Instance details Defined in Data.Ollama.Chat Methods toJSON :: Message -> Value # toEncoding :: Message -> Encoding # toJSONList :: [Message] -> Value # toEncodingList :: [Message] -> Encoding # omitField :: Message -> Bool #
Generic Message Source #
Instance details Defined in Data.Ollama.Chat 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 Data.Ollama.Chat Methods showsPrec :: Int -> Message -> ShowS # show :: Message -> String # showList :: [Message] -> ShowS #
Eq Message Source #
Instance details Defined in Data.Ollama.Chat Methods (==) :: Message -> Message -> Bool # (/=) :: Message -> Message -> Bool #
type Rep Message Source #
Instance details Defined in Data.Ollama.Chat type Rep Message = D1 ('MetaData "Message" "Data.Ollama.Chat" "ollama-haskell-0.1.0.0-Hhs8YtljEqoGZTH1LFF25l" 'False) (C1 ('MetaCons "Message" 'PrefixI 'True) (S1 ('MetaSel ('Just "role") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Role) :: (S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "images") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Text])))))

data Role Source #

Enumerated roles that can participate in a chat.

Constructors

System
User
Assistant
Tool

Instances

Instances details

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

defaultChatOps :: ChatOps Source #

A default configuration for initiating a chat with a model. This can be used as a starting point and modified as needed.

Example:

let ops = defaultChatOps { chatModelName = "customModel" }
chat ops

data ChatOps Source #

Constructors

ChatOps

Fields

chatModelName :: Text
The name of the chat model to be used.
messages :: NonEmpty Message
A non-empty list of messages forming the conversation context.
tools :: Maybe Text
Optional tools that may be used in the chat.
format :: Maybe Text
An optional format for the chat response.
stream :: Maybe (ChatResponse -> IO (), IO ())
Optional streaming functions where the first handles each chunk of the response, and the second flushes the stream.
keepAlive :: Maybe Text
Optional text to specify keep-alive behavior.

Instances

Instances details

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

data ChatResponse Source #

Constructors

ChatResponse

Fields

model :: Text
The name of the model that generated this response.
createdAt :: UTCTime
The timestamp when the response was created.
message :: Maybe Message
The message content of the response, if any.
done :: Bool
Indicates whether the chat process has completed.
totalDuration :: Maybe Int64
Optional total duration in milliseconds for the chat process.
loadDuration :: Maybe Int64
Optional load duration in milliseconds for loading the model.
promptEvalCount :: Maybe Int64
Optional count of prompt evaluations during the chat process.
promptEvalDuration :: Maybe Int64
Optional duration in milliseconds for evaluating the prompt.
evalCount :: Maybe Int64
Optional count of evaluations during the chat process.
evalDuration :: Maybe Int64
Optional duration in milliseconds for evaluations during the chat process.

Instances

Instances details

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