Data.Ollama.Chat

Chat APIs

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

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

chatJson

Arguments

:: (FromJSON jsonResult, ToJSON jsonResult)

=> ChatOps

-> jsonResult

Haskell type that you want your result in

-> Maybe Int

Max retries

-> IO (Either String jsonResult)

chatJson is a higher level function that takes ChatOps (similar to chat) and also takes a Haskell type (that has To and From JSON instance) and returns the response in provided type.

This function simply calls chat with extra prompt appended to it, telling LLM to return the response in certain JSON format and serializes the response. This function will be helpful when you want to use the LLM to do something programmatic.

For Example: > let expectedJsonStrucutre = Example { > sortedList = ["sorted List here"] > , wasListAlreadSorted = False > } > let msg0 = Ollama.Message User "Sort given list: [4, 2 , 3, 67]. Also tell whether list was already sorted or not." Nothing > eRes3 <- > chatJson > defaultChatOps > { Chat.chatModelName = "llama3.2" > , Chat.messages = msg0 :| [] > } > expectedJsonStrucutre > (Just 2) > print eRes3 Output: > Example {sortedList = ["1","2","3","4"], wasListAlreadSorted = False}

Note: While Passing the type, construct the type that will help LLM understand the field better. For example, in the above example, the sortedList's value is written as "Sorted List here". This will help LLM understand context better.

You can also provide number of retries in case the LLM field to return the response in correct JSON in first attempt.

data Message

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

FromJSON Message

Defined in Data.Ollama.Chat

Methods

parseJSON :: Value -> Parser Message

parseJSONList :: Value -> Parser [Message]

omittedField :: Maybe Message

ToJSON Message

Defined in Data.Ollama.Chat

Methods

toJSON :: Message -> Value

toEncoding :: Message -> Encoding

toJSONList :: [Message] -> Value

toEncodingList :: [Message] -> Encoding

omitField :: Message -> Bool

Generic Message

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

Defined in Data.Ollama.Chat

Methods

showsPrec :: Int -> Message -> ShowS

show :: Message -> String

showList :: [Message] -> ShowS

Eq Message

Defined in Data.Ollama.Chat

Methods

(==) :: Message -> Message -> Bool

(/=) :: Message -> Message -> Bool

type Rep Message

Defined in Data.Ollama.Chat

type Rep Message = D1 ('MetaData "Message" "Data.Ollama.Chat" "ollama-haskell-0.1.2.0-FhW2R5HBnzqI9p8FACrOm4" '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

Enumerated roles that can participate in a chat.

Constructors

System

User

Assistant

Tool

Instances

FromJSON Role

Defined in Data.Ollama.Chat

Methods

parseJSON :: Value -> Parser Role

parseJSONList :: Value -> Parser [Role]

omittedField :: Maybe Role

ToJSON Role

Defined in Data.Ollama.Chat

Methods

toJSON :: Role -> Value

toEncoding :: Role -> Encoding

toJSONList :: [Role] -> Value

toEncodingList :: [Role] -> Encoding

omitField :: Role -> Bool

Show Role

Defined in Data.Ollama.Chat

Methods

showsPrec :: Int -> Role -> ShowS

show :: Role -> String

showList :: [Role] -> ShowS

Eq Role

Defined in Data.Ollama.Chat

Methods

(==) :: Role -> Role -> Bool

(/=) :: Role -> Role -> Bool

defaultChatOps :: ChatOps

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

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.

• hostUrl :: Maybe Text

  Override default Ollama host url. Default url = "http://127.0.0.1:11434"

• responseTimeOut :: Maybe Int

  Override default response timeout in minutes. Default = 15 minutes

Instances

ToJSON ChatOps

Defined in Data.Ollama.Chat

Methods

toJSON :: ChatOps -> Value

toEncoding :: ChatOps -> Encoding

toJSONList :: [ChatOps] -> Value

toEncodingList :: [ChatOps] -> Encoding

omitField :: ChatOps -> Bool

Show ChatOps

Defined in Data.Ollama.Chat

Methods

showsPrec :: Int -> ChatOps -> ShowS

show :: ChatOps -> String

showList :: [ChatOps] -> ShowS

Eq ChatOps

Defined in Data.Ollama.Chat

Methods

(==) :: ChatOps -> ChatOps -> Bool

(/=) :: ChatOps -> ChatOps -> Bool

data ChatResponse

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

FromJSON ChatResponse

Defined in Data.Ollama.Chat

Methods

parseJSON :: Value -> Parser ChatResponse

parseJSONList :: Value -> Parser [ChatResponse]

omittedField :: Maybe ChatResponse

Show ChatResponse

Defined in Data.Ollama.Chat

Methods

showsPrec :: Int -> ChatResponse -> ShowS

show :: ChatResponse -> String

showList :: [ChatResponse] -> ShowS

Eq ChatResponse

Defined in Data.Ollama.Chat

Methods

(==) :: ChatResponse -> ChatResponse -> Bool

(/=) :: ChatResponse -> ChatResponse -> Bool