Ollama

This library lets you run LlMs from within Haskell projects. Inspired by `ollama-python`.

Main APIs

Generate Texts

generate :: GenerateOps -> IO (Either String GenerateResponse)

Generate function that returns either a GenerateResponse type or an error message. It takes a GenerateOps configuration and performs a request to the Ollama generate API.

Examples:

Basic usage without streaming:

let ops = GenerateOps 
        { modelName = "llama3.2"
        , prompt = "Tell me a joke."
        , suffix = Nothing
        , images = Nothing
        , format = Nothing
        , system = Nothing
        , template = Nothing
        , stream = Nothing
        , raw = Nothing
        , keepAlive = Nothing
        }
result <- generate ops
case result of
  Left errorMsg -> putStrLn ("Error: " ++ errorMsg)
  Right response -> print response

Usage with streaming to print responses to the console:

void $
  generate
    defaultGenerateOps
      { modelName = "llama3.2"
      , prompt = "what is functional programming?"
      , stream = Just (T.putStr . response_, pure ())
      }

In this example, the first function in the $sel:stream:GenerateOps tuple processes each chunk of response by printing it, and the second function is a simple no-op flush.generate :: GenerateOps -> IO (Either String GenerateResponse)

defaultGenerateOps :: GenerateOps

A function to create a default GenerateOps type with preset values.

Example:

let ops = defaultGenerateOps
generate ops

This will generate a response using the default configuration.

data GenerateOps

Input type for generate functions. This data type represents all possible configurations that you can pass to the Ollama generate API.

Example:

let ops = GenerateOps 
        { modelName = "llama3.2"
        , prompt = "What is the meaning of life?"
        , suffix = Nothing
        , images = Nothing
        , format = Just "text"
        , system = Nothing
        , template = Nothing
        , stream = Nothing
        , raw = Just False
        , keepAlive = Just "yes"
        }

Constructors

GenerateOps

Fields

• modelName :: Text

  The name of the model to be used for generation.

• prompt :: Text

  The prompt text that will be provided to the model for generating a response.

• suffix :: Maybe Text

  An optional suffix to append to the generated text.

• images :: Maybe [Text]

  Optional list of base64 encoded images to include with the request.

• format :: Maybe Text

  An optional format specifier for the response.

• system :: Maybe Text

  Optional system text that can be included in the generation context.

• template :: Maybe Text

  An optional template to format the response.

• stream :: Maybe (GenerateResponse -> IO (), IO ())

  An optional streaming function where the first function handles each chunk of response, and the second flushes the stream.

• raw :: Maybe Bool

  An optional flag to return the raw response.

• keepAlive :: Maybe Text

  Optional text to specify keep-alive behavior.

Instances

ToJSON GenerateOps

Defined in Data.Ollama.Generate

Methods

toJSON :: GenerateOps -> Value

toEncoding :: GenerateOps -> Encoding

toJSONList :: [GenerateOps] -> Value

toEncodingList :: [GenerateOps] -> Encoding

omitField :: GenerateOps -> Bool

Show GenerateOps

Defined in Data.Ollama.Generate

Methods

showsPrec :: Int -> GenerateOps -> ShowS

show :: GenerateOps -> String

showList :: [GenerateOps] -> ShowS

Eq GenerateOps

Defined in Data.Ollama.Generate

Methods

(==) :: GenerateOps -> GenerateOps -> Bool

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

data GenerateResponse

Result type for generate function containing the model's response and meta-information.

Constructors

GenerateResponse

Fields

• model :: Text

  The name of the model that generated the response.

• createdAt :: UTCTime

  The timestamp when the response was created.

• response_ :: Text

  The generated response from the model.

• done :: Bool

  A flag indicating whether the generation process is complete.

• totalDuration :: Maybe Int64

  Optional total duration in milliseconds for the generation process.

• loadDuration :: Maybe Int64

  Optional load duration in milliseconds for loading the model.

• promptEvalCount :: Maybe Int64

  Optional count of prompt evaluations during the generation process.

• promptEvalDuration :: Maybe Int64

  Optional duration in milliseconds for evaluating the prompt.

• evalCount :: Maybe Int64

  Optional count of evaluations during the generation process.

• evalDuration :: Maybe Int64

  Optional duration in milliseconds for evaluations during the generation process.

Instances

FromJSON GenerateResponse

Defined in Data.Ollama.Generate

Methods

parseJSON :: Value -> Parser GenerateResponse

parseJSONList :: Value -> Parser [GenerateResponse]

omittedField :: Maybe GenerateResponse

Show GenerateResponse

Defined in Data.Ollama.Generate

Methods

showsPrec :: Int -> GenerateResponse -> ShowS

show :: GenerateResponse -> String

showList :: [GenerateResponse] -> ShowS

Eq GenerateResponse

Defined in Data.Ollama.Generate

Methods

(==) :: GenerateResponse -> GenerateResponse -> Bool

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

Chat with LLMs

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

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 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

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.

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

Embeddings

embedding

Arguments

:: Text

Model

-> Text

Input

-> IO (Maybe EmbeddingResp)

Embedding API

embeddingOps

Arguments

:: Text

Model

-> Text

Input

-> Maybe Bool

Truncate

-> Maybe Text

Keep Alive

-> IO (Maybe EmbeddingResp)

Embedding API

Ollama operations

Copy Models

copyModel

Arguments

:: Text

Source model

-> Text

Destination model

-> IO ()

Copy model from source to destination

Create Models

createModel

Arguments

:: Text

Model Name

-> Maybe Text

Model File

-> Maybe FilePath

Path

-> IO ()

Create a new model | Please note, if you specify both ModelFile and Path, ModelFile will be used.

createModelOps

Arguments

:: Text

Model Name

-> Maybe Text

Model File

-> Maybe Bool

Stream

-> Maybe FilePath

Path

-> IO ()

Create a new model either from ModelFile or Path Please note, if you specify both ModelFile and Path, ModelFile will be used.

Delete Models

deleteModel

Arguments

:: Text

Model name

-> IO ()

Delete a model

List Models

list :: IO (Maybe Models)

List all models from local

List currently running models

ps :: IO (Maybe RunningModels)

List running models

Push and Pull

push

Arguments

:: Text

Model name

-> IO ()

Push a model

pushOps

Arguments

:: Text

Model name

-> Maybe Bool

Insecure

-> Maybe Bool

Stream

-> IO ()

Push a model with options

pull

Arguments

:: Text

Model Name

-> IO ()

Pull a model using default options. This simplifies the pull operation by not requiring additional options.

Example:

pull "myModel"

This will pull "myModel" using default settings (no insecure connections and no streaming).

pullOps

Arguments

:: Text

Model Name

-> Maybe Bool

Insecure

-> Maybe Bool

Stream

-> IO ()

Pull a model with additional options for insecure connections and streaming. This function interacts directly with the Ollama API to download the specified model.

Example:

pullOps "myModel" (Just True) (Just True)

This will attempt to pull "myModel" with insecure connections allowed and enable streaming.

Show Model Info

showModel

Arguments

:: Text

model name

-> IO (Maybe ShowModelResponse)

Show given model's information.

Higher level API for show. @since 1.0.0.0

showModelOps

Arguments

:: Text

model name

-> Maybe Bool

verbose

-> IO (Maybe ShowModelResponse)

Show given model's information with options.

Since: 1.0.0.0

Types

data ShowModelResponse

Ouput structure for show model information.

Constructors

ShowModelResponse

Fields

• modelFile :: Text
• parameters :: Text
• template :: Text
• details :: ModelDetails
• modelInfo :: ModelInfo

Instances

FromJSON ShowModelResponse

The instance for show model response

Defined in Data.Ollama.Show

Methods

parseJSON :: Value -> Parser ShowModelResponse

parseJSONList :: Value -> Parser [ShowModelResponse]

omittedField :: Maybe ShowModelResponse

Show ShowModelResponse

Defined in Data.Ollama.Show

Methods

showsPrec :: Int -> ShowModelResponse -> ShowS

show :: ShowModelResponse -> String

showList :: [ShowModelResponse] -> ShowS

Eq ShowModelResponse

Defined in Data.Ollama.Show

Methods

(==) :: ShowModelResponse -> ShowModelResponse -> Bool

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

newtype Models

Constructors

Models [ModelInfo]

Instances

FromJSON Models

Defined in Data.Ollama.List

Methods

parseJSON :: Value -> Parser Models

parseJSONList :: Value -> Parser [Models]

omittedField :: Maybe Models

Show Models

Defined in Data.Ollama.List

Methods

showsPrec :: Int -> Models -> ShowS

show :: Models -> String

showList :: [Models] -> ShowS

Eq Models

Defined in Data.Ollama.List

Methods

(==) :: Models -> Models -> Bool

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

data ModelInfo

Constructors

ModelInfo

Fields

• name :: Text
• modifiedAt :: UTCTime
• size :: Int64
• digest :: Text
• details :: ModelDetails

Instances

FromJSON ModelInfo

Defined in Data.Ollama.List

Methods

parseJSON :: Value -> Parser ModelInfo

parseJSONList :: Value -> Parser [ModelInfo]

omittedField :: Maybe ModelInfo

Show ModelInfo

Defined in Data.Ollama.List

Methods

showsPrec :: Int -> ModelInfo -> ShowS

show :: ModelInfo -> String

showList :: [ModelInfo] -> ShowS

Eq ModelInfo

Defined in Data.Ollama.List

Methods

(==) :: ModelInfo -> ModelInfo -> Bool

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

newtype RunningModels

Constructors

RunningModels [RunningModel]

Instances

FromJSON RunningModels

Defined in Data.Ollama.Ps

Methods

parseJSON :: Value -> Parser RunningModels

parseJSONList :: Value -> Parser [RunningModels]

omittedField :: Maybe RunningModels

Show RunningModels

Defined in Data.Ollama.Ps

Methods

showsPrec :: Int -> RunningModels -> ShowS

show :: RunningModels -> String

showList :: [RunningModels] -> ShowS

Eq RunningModels

Defined in Data.Ollama.Ps

Methods

(==) :: RunningModels -> RunningModels -> Bool

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

data RunningModel

Constructors

RunningModel

Fields

• name_ :: Text
• modelName :: Text
• size_ :: Int64
• modelDigest :: Text
• modelDetails :: ModelDetails
• expiresAt :: UTCTime
• sizeVRam :: Int64

Instances

FromJSON RunningModel

Defined in Data.Ollama.Ps

Methods

parseJSON :: Value -> Parser RunningModel

parseJSONList :: Value -> Parser [RunningModel]

omittedField :: Maybe RunningModel

Show RunningModel

Defined in Data.Ollama.Ps

Methods

showsPrec :: Int -> RunningModel -> ShowS

show :: RunningModel -> String

showList :: [RunningModel] -> ShowS

Eq RunningModel

Defined in Data.Ollama.Ps

Methods

(==) :: RunningModel -> RunningModel -> Bool

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

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.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])))))