Copyright	(c) 2025 Tushar Adhatrao
License	MIT
Maintainer	Tushar Adhatrao <[email protected]>
Stability	experimental
Safe Haskell	None
Language	Haskell2010

Data.Ollama.Ps

Contents

List Running Models API
Model Types

Description

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

Example:

>>> ps Nothing
Right (RunningModels [RunningModel ...])

Synopsis

ps :: Maybe OllamaConfig -> IO (Either OllamaError RunningModels)
psM :: MonadIO m => Maybe OllamaConfig -> m (Either OllamaError RunningModels)
newtype RunningModels = RunningModels [RunningModel]
data RunningModel = RunningModel {
- name_ :: !Text
- modelName :: !Text
- size_ :: !Int64
- modelDigest :: !Text
- modelDetails :: !ModelDetails
- expiresAt :: !UTCTime
- sizeVRam :: !Int64
}

List Running Models API

ps Source #

Arguments

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

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", ...}])

psM :: MonadIO m => Maybe OllamaConfig -> m (Either OllamaError RunningModels) Source #

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.

Model Types

newtype RunningModels Source #

A wrapper type containing a list of running models.

Constructors

RunningModels [RunningModel]

List of RunningModel records describing currently running models.

Instances

Instances details

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

data RunningModel Source #

Details about a specific running model.

Constructors

RunningModel

Fields

name_ :: !Text
The name of the running model instance.
modelName :: !Text
The base model name (e.g., "gemma3").
size_ :: !Int64
The size of the model in bytes.
modelDigest :: !Text
The digest (hash) of the model.
modelDetails :: !ModelDetails
Additional details about the model (e.g., format, family, parameters).
expiresAt :: !UTCTime
The timestamp when the model's memory allocation expires.
sizeVRam :: !Int64
The size of the model's VRAM usage in bytes.

Instances

Instances details

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