Generates text using the specified model and configuration.

Validates the GenerateOps configuration and sends a POST request to the "api/generate" endpoint. Supports both streaming and non-streaming responses based on the stream field in GenerateOps. Returns Right with a GenerateResponse on success or Left with an OllamaError on failure.

Example:

>>> let ops = defaultGenerateOps { modelName = "gemma3", prompt = "Write a short poem." }
>>> generate ops Nothing
Right (GenerateResponse ...)

MonadIO version of generate for use in monadic contexts.

Lifts the generate function into a MonadIO context, allowing it to be used in monadic computations.

Example:

>>> import Control.Monad.IO.Class
>>> let ops = defaultGenerateOps { modelName = "gemma3", prompt = "Hello!" }
>>> runReaderT (generateM ops Nothing) someContext
Right (GenerateResponse ...)

Default configuration for text generation.

Provides a default GenerateOps with the "gemma3" model and an empty prompt. Other fields are set to Nothing or default values. Can be customized by modifying fields as needed.

Example:

>>> let ops = defaultGenerateOps { modelName = "customModel", prompt = "Hello!" }
>>> generate ops Nothing

Configuration for a text generation request.

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

Sends a chat request to the Ollama API.

Validates the ChatOps configuration and sends a POST request to the "api/chat" endpoint. Supports both streaming and non-streaming responses based on the stream field in ChatOps. Returns an Either containing an OllamaError on failure or a ChatResponse on success.

Example:

>>> let ops = defaultChatOps { chatModelName = "gemma3", messages = userMessage "What's the capital of France?" :| [] }
>>> chat ops Nothing
Either OllamaError ChatResponse

MonadIO version of chat for use in monadic contexts.

Lifts the chat function into a MonadIO context, allowing it to be used in monadic computations.

Example:

>>> import Control.Monad.IO.Class
>>> let ops = defaultChatOps { chatModelName = "gemma3", messages = userMessage "Hello!" :| [] }
>>> runReaderT (chatM ops Nothing) someContext
Either OllamaError ChatResponse

Enumerated roles that can participate in a chat.

Default configuration for initiating a chat.

Provides a default ChatOps with the "gemma3" model and a sample user message ("What is 2+2?"). Can be customized by modifying fields as needed.

Example:

>>> let ops = defaultChatOps { chatModelName = "customModel", messages = userMessage "Hello!" :| [] }
>>> chat ops Nothing
Either OllamaError ChatResponse

Configuration for initiating a chat with an Ollama model.

Defines the parameters for a chat request, including the model name, messages, and optional settings for tools, response format, streaming, timeout, and model options.

Represents a tool that can be used in the conversation.

Since: 0.2.0.0

Represents a function that can be called by the model.

Since: 0.2.0.0

Parameters definition for a function call used in structured output or tool calls.

Since: 0.2.0.0

A single tool call returned from the model, containing the function to be invoked.

Since: 0.2.0.0

Output representation of a function to be called, including its name and arguments.

Since: 0.2.0.0

Simplified API for generating embeddings.

A higher-level function that generates embeddings using default settings for truncation, keep-alive, model options, and Ollama configuration. Suitable for basic use cases.

Generates embeddings for a list of input texts with full configuration.

Sends a POST request to the "api/embed" endpoint to generate embeddings for the provided inputs. Allows customization of truncation, keep-alive settings, model options, and Ollama configuration. Returns Right with an EmbeddingResp on success or Left with an OllamaError on failure.

MonadIO version of embedding for use in monadic contexts.

Lifts the embedding function into a MonadIO context, allowing it to be used in monadic computations.

MonadIO version of embeddingOps for use in monadic contexts.

Lifts the embeddingOps function into a MonadIO context, allowing it to be used in monadic computations with full configuration options.

Configuration for an embedding request.

Response type for an embedding request.

Copies a model from a source name to a destination name.

Sends a POST request to the "api/copy" endpoint with the source and destination model names. Returns 'Right ()' on success or Left with an OllamaError on failure. Example:

>>> copyModel "gemma3" "gemma3-copy" Nothing
Right ()

MonadIO version of copyModel for use in monadic contexts.

Lifts the copyModel function into a MonadIO context, allowing it to be used in monadic computations.

Example:

>>> import Control.Monad.IO.Class
>>> runReaderT (copyModelM "gemma3" "gemma3-copy" Nothing) someContext
Right ()

Creates a new model using either model file content or a file path.

Sends a POST request to the "api/pull" endpoint to create a model with the specified name. The model can be defined either by modelFile (Modelfile content as text) or path (file path to a Modelfile). If both are provided, modelFile is used. Supports streaming progress updates if stream is 'Just True'. Prints progress messages to the console during creation.

MonadIO version of createModel for use in monadic contexts.

Lifts the createModel function into a MonadIO context, allowing it to be used in monadic computations.

Deletes a model from the Ollama server.

Sends a DELETE request to the "api/delete" endpoint with the specified model name. Returns 'Right ()' on success or Left with an OllamaError on failure.

MonadIO version of deleteModel for use in monadic contexts.

Lifts the deleteModel function into a context, allowing it to be used in monadic computations.

Retrieves a list of available models from the Ollama server.

Sends a GET request to the "api/tags" endpoint to fetch the list of models. Returns Right with a Models containing the list of ModelInfo on success, or Left with an OllamaError on failure.

Retrieves a list of currently running models from the Ollama server.

Sends a GET request to the "api/ps" endpoint to fetch the list of running models. Returns Right with a RunningModels containing the list of RunningModel on success, or Left with an OllamaError on failure. Example:

>>> ps Nothing
Right (RunningModels [RunningModel {name_ = "gemma3:instance1", modelName = "gemma3", ...}])

MonadIO version of ps for use in monadic contexts.

Lifts the ps function into a MonadIO context, allowing it to be used in monadic computations.

Pushes a model to the Ollama server with specified options.

Sends a POST request to the "api/pull" endpoint to upload the specified model. Supports streaming progress updates (if stream is 'Just True') and insecure connections (if insecure is 'Just True'). Prints "Pushing..." during streaming and Completed when finished. Returns () on completion.

MonadIO version of push for use in monadic contexts.

Lifts the push function into a MonadIO context, allowing it to be used in monadic computations.

Example:

>>> import Control.Monad.IO.Class
>>> runReaderT (pushM "gemma3" Nothing (Just True) Nothing) someContext
Pushing...
Completed

Simplified API for pulling a model.

A higher-level function that pulls a model using default settings for insecure connections, streaming, and Ollama configuration. Suitable for basic use cases.

MonadIO version of pull for use in monadic contexts.

Lifts the pull function into a MonadIO context, allowing it to be used in monadic computations.

Example:

>>> import Control.Monad.IO.Class
>>> runReaderT (pullM "gemma3") someContext
Right (PullResp {status = "success", ...})

Pulls a model with full configuration.

Sends a POST request to the "api/pull" endpoint to download the specified model. Supports streaming progress updates (if stream is 'Just True') and insecure connections (if insecure is 'Just True'). Prints remaining bytes during streaming and Completed when finished. Returns Right with a PullResp on success or Left with an OllamaError on failure.

MonadIO version of pullOps for use in monadic contexts.

Lifts the pullOps function into a MonadIO context, allowing it to be used in monadic computations with full configuration options.

Example:

>>> import Control.Monad.IO.Class
>>> runReaderT (pullOpsM "gemma3" Nothing (Just True) Nothing) someContext
Remaining bytes: 123456789
...
Completed
Right (PullResp {status = "success", ...})

Simplified API for retrieving model information.

A higher-level function that fetches model information using default settings for verbose output and Ollama configuration. Suitable for basic use cases.

Retrieves model information with configuration options.

Sends a POST request to the "api/show" endpoint to fetch detailed information about the specified model. Supports verbose output if verbose is 'Just True' (though verbose mode parsing is currently incomplete). Returns Right with a ShowModelResponse on success or Left with an OllamaError on failure.

MonadIO version of showModel for use in monadic contexts.

Lifts the showModel function into a MonadIO context, allowing it to be used in monadic computations.

MonadIO version of showModelOps for use in monadic contexts.

Lifts the showModelOps function into a MonadIO context, allowing it to be used in monadic computations with full configuration options.

A default configuration pointing to localhost:11434 with 90s timeout and no hooks or retry logic.

Add a callback to be executed when a model starts.

Add a callback to be executed when a model finishes successfully.

Add a callback to be executed when a model errors.

Default model options for API requests.

Provides a default ModelOptions configuration with all fields set to Nothing, suitable as a starting point for customizing model parameters like temperature or token limits.

Example:

>>> let opts = defaultModelOptions { temperature = Just 0.7 }

Optional model tuning parameters that influence generation behavior.

Since: 0.2.0.0

Encodes an image file to Base64 format.

Takes a file path to an image (jpg, jpeg, or png) and returns its data encoded as a Base64 Text. Returns Nothing if the file extension is unsupported or the file cannot be read. This is useful for including images in API requests that expect Base64-encoded data, such as GenerateOps images field.

Sends an HTTP request to the Ollama API.

A unified function for making API requests to the Ollama server. Supports both GET and POST methods, customizable payloads, and optional configuration. The response is processed by the provided handler.

Retrieves the Ollama server version.

Sends a GET request to the "api/version" endpoint and returns the server version as a Version wrapped in an Either OllamaError.

Example:

>>> getVersion
--
-- @since 0.2.0.0

Loads a generative model into memory.

Sends a POST request to the "api/generate" endpoint to load the specified model into memory, ensuring faster response times for subsequent requests. Returns 'Right ()' on success or Left with an OllamaError on failure. -- -- @since 0.2.0.0

Unloads a generative model from memory.

Sends a POST request to the "api/generate" endpoint with a keep-alive duration of zero to unload the specified model from memory, freeing up resources. Returns 'Right ()' on success or Left with an OllamaError on failure. -- -- @since 0.2.0.0

MonadIO version of loadGenModel for use in monadic contexts.

Lifts the loadGenModel function into a MonadIO context, allowing it to be used in monadic computations.

Example:

>>> import Control.Monad.IO.Class
>>> runReaderT (loadGenModelM "gemma3") someContext
Right ()
--
-- @since 0.2.0.0

MonadIO version of unloadGenModel for use in monadic contexts.

Lifts the unloadGenModel function into a MonadIO context, allowing it to be used in monadic computations.

Example:

>>> import Control.Monad.IO.Class
>>> runReaderT (unloadGenModelM "gemma3") someContext
Right ()
--
-- @since 0.2.0.0

Response structure for model information.

A wrapper type containing a list of available models.

Details about a specific model.

Metadata describing a specific model's identity and configuration.

Detailed technical information about a model.

A wrapper type containing a list of running models.

Details about a specific running model.

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

Format specification for the chat output.

Since: 0.1.3.0

Represents all possible errors that may occur when using the Ollama client.

Since: 0.2.0.0

Configuration for the Ollama client. Used across all requests to customize behavior such as timeouts, retries, custom HTTP manager, and lifecycle hooks. -- -- @since 0.2.0.0

A wrapper for the Ollama engine version string.