Copyright	(c) 2025 Tushar Adhatrao
License	MIT
Maintainer	Tushar Adhatrao <tusharadhatrao@gmail.com>
Stability	experimental
Safe Haskell	None
Language	Haskell2010

Data.Ollama.List

Contents

List Models API
Model Types

Description

This module provides functions to retrieve a list of models available on the Ollama server. It includes both an IO-based function (list) and a monadic version (listM) for use in MonadIO contexts. The list operation is performed via a GET request to the "api/tags" endpoint, returning a Models type containing a list of ModelInfo records with details about each model.

Example:

>>> list Nothing
Right (Models [ModelInfo ...])

Synopsis

list :: Maybe OllamaConfig -> IO (Either OllamaError Models)
listM :: MonadIO m => Maybe OllamaConfig -> m (Either OllamaError Models)
newtype Models = Models [ModelInfo]
data ModelInfo = ModelInfo {
- name :: !Text
- modifiedAt :: !UTCTime
- size :: !Int64
- digest :: !Text
- details :: !ModelDetails
}

List Models API

list Source #

Arguments

:: Maybe OllamaConfig	Optional `OllamaConfig` (defaults to `defaultOllamaConfig` if `Nothing`)
-> IO (Either OllamaError Models)

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.

listM :: MonadIO m => Maybe OllamaConfig -> m (Either OllamaError Models) Source #

MonadIO version of list for use in monadic contexts.

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

Example:

>>> import Control.Monad.IO.Class
>>> runReaderT (listM Nothing) someContext
Right (Models [ModelInfo ...])

Model Types

newtype Models Source #

A wrapper type containing a list of available models.

Constructors

Models [ModelInfo]

List of ModelInfo records describing available models.

Instances

Instances details

FromJSON Models Source #	JSON parsing instance for `Models`.
Instance details Defined in Data.Ollama.List Methods parseJSON :: Value -> Parser Models # parseJSONList :: Value -> Parser [Models] # omittedField :: Maybe Models #
Show Models Source #
Instance details Defined in Data.Ollama.List Methods showsPrec :: Int -> Models -> ShowS # show :: Models -> String # showList :: [Models] -> ShowS #
Eq Models Source #
Instance details Defined in Data.Ollama.List Methods (==) :: Models -> Models -> Bool # (/=) :: Models -> Models -> Bool #

data ModelInfo Source #

Details about a specific model.

Constructors

ModelInfo
Fields name :: !Text The name of the model. modifiedAt :: !UTCTime The timestamp when the model was last modified. size :: !Int64 The size of the model in bytes. digest :: !Text The digest (hash) of the model. details :: !ModelDetails Additional details about the model (e.g., format, family, parameters).

Instances

Instances details

FromJSON ModelInfo Source #	JSON parsing instance for `ModelInfo`.
Instance details Defined in Data.Ollama.List Methods parseJSON :: Value -> Parser ModelInfo # parseJSONList :: Value -> Parser [ModelInfo] # omittedField :: Maybe ModelInfo #
Show ModelInfo Source #
Instance details Defined in Data.Ollama.List Methods showsPrec :: Int -> ModelInfo -> ShowS # show :: ModelInfo -> String # showList :: [ModelInfo] -> ShowS #
Eq ModelInfo Source #
Instance details Defined in Data.Ollama.List Methods (==) :: ModelInfo -> ModelInfo -> Bool # (/=) :: ModelInfo -> ModelInfo -> Bool #