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

Data.Ollama.Show

Contents

Show Model Info API
Response Types

Description

This module provides functions to fetch detailed information about a specific model on the Ollama server. It includes both high-level (showModel, showModelM) and low-level (showModelOps, showModelOpsM) APIs for retrieving model details, with support for verbose output. The operation is performed via a POST request to the "api/show" endpoint, returning a ShowModelResponse containing comprehensive model metadata.

The ShowModelOps type configures the request, and ShowModelResponse and ShowModelInfo represent the response structure. The module also re-exports ModelDetails for completeness.

Note: Verbose mode parsing is currently not fully supported.

Example:

>>> showModel "gemma3"
Right (ShowModelResponse {modelFile = "...", ...})

Since: 1.0.0.0

Synopsis

showModel :: Text -> IO (Either OllamaError ShowModelResponse)
showModelM :: MonadIO m => Text -> m (Either OllamaError ShowModelResponse)
showModelOps :: Text -> Maybe Bool -> Maybe OllamaConfig -> IO (Either OllamaError ShowModelResponse)
showModelOpsM :: MonadIO m => Text -> Maybe Bool -> Maybe OllamaConfig -> m (Either OllamaError ShowModelResponse)
data ShowModelResponse = ShowModelResponse {
- modelFile :: !Text
- parameters :: !(Maybe Text)
- template :: !(Maybe Text)
- details :: !ModelDetails
- modelInfo :: !ShowModelInfo
- license :: !(Maybe Text)
- capabilities :: Maybe [Text]
}
data ShowModelInfo = ShowModelInfo {
- generalArchitecture :: !(Maybe Text)
- generalFileType :: !(Maybe Int)
- generalParameterCount :: !(Maybe Int64)
- generalQuantizationVersion :: !(Maybe Int)
- llamaAttentionHeadCount :: !(Maybe Int)
- llamaAttentionHeadCountKV :: !(Maybe Int)
- llamaAttentionLayerNormRMSEpsilon :: !(Maybe Float)
- llamaBlockCount :: !(Maybe Int)
- llamaContextLength :: !(Maybe Int)
- llamaEmbeddingLength :: !(Maybe Int)
- llamaFeedForwardLength :: !(Maybe Int)
- llamaRopeDimensionCount :: !(Maybe Int)
- llamaRopeFreqBase :: !(Maybe Int64)
- llamaVocabSize :: !(Maybe Int64)
- tokenizerGgmlBosToken_id :: !(Maybe Int)
- tokenizerGgmlEosToken_id :: !(Maybe Int)
- tokenizerGgmlMerges :: !(Maybe [Text])
- tokenizerGgmlMode :: !(Maybe Text)
- tokenizerGgmlPre :: !(Maybe Text)
- tokenizerGgmlTokenType :: !(Maybe [Text])
- tokenizerGgmlTokens :: !(Maybe [Text])
}
data ModelDetails = ModelDetails {
- parentModel :: !(Maybe Text)
- format :: !Text
- family :: !Text
- families :: ![Text]
- parameterSize :: !Text
- quantizationLevel :: Text
}

Show Model Info API

showModel Source #

Arguments

:: Text	Model name
-> IO (Either OllamaError ShowModelResponse)

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.

showModelM :: MonadIO m => Text -> m (Either OllamaError ShowModelResponse) Source #

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.

showModelOps Source #

Arguments

:: Text	Model name
-> Maybe Bool	Optional verbose flag
-> Maybe OllamaConfig	Optional `OllamaConfig` (defaults to `defaultOllamaConfig` if `Nothing`)
-> IO (Either OllamaError ShowModelResponse)

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.

showModelOpsM :: MonadIO m => Text -> Maybe Bool -> Maybe OllamaConfig -> m (Either OllamaError ShowModelResponse) Source #

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.

Response Types

data ShowModelResponse Source #

Response structure for model information.

Constructors

ShowModelResponse

Fields

modelFile :: !Text
The content of the model's Modelfile.
parameters :: !(Maybe Text)
Optional model parameters (e.g., temperature settings).
template :: !(Maybe Text)
Optional template used for the model.
details :: !ModelDetails
General details about the model (e.g., format, family).
modelInfo :: !ShowModelInfo
Detailed technical information about the model.
license :: !(Maybe Text)
Optional license information for the model.
Since: 0.2.0.0
capabilities :: Maybe [Text]
Optional list of model capabilities.
Since: 0.2.0.0

Instances

Instances details

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

data ShowModelInfo Source #

Detailed technical information about a model.

Constructors

ShowModelInfo

Fields

generalArchitecture :: !(Maybe Text)
The architecture of the model (e.g., "llama").
generalFileType :: !(Maybe Int)
The file type identifier for the model.
generalParameterCount :: !(Maybe Int64)
The number of parameters in the model.
generalQuantizationVersion :: !(Maybe Int)
The quantization version used by the model.
llamaAttentionHeadCount :: !(Maybe Int)
Number of attention heads in the LLaMA model.
llamaAttentionHeadCountKV :: !(Maybe Int)
Number of key-value attention heads in the LLaMA model.
llamaAttentionLayerNormRMSEpsilon :: !(Maybe Float)
RMS epsilon for layer normalization in the LLaMA model.
llamaBlockCount :: !(Maybe Int)
Number of blocks in the LLaMA model.
llamaContextLength :: !(Maybe Int)
Context length supported by the LLaMA model.
llamaEmbeddingLength :: !(Maybe Int)
Embedding length used by the LLaMA model.
llamaFeedForwardLength :: !(Maybe Int)
Feed-forward layer length in the LLaMA model.
llamaRopeDimensionCount :: !(Maybe Int)
RoPE dimension count in the LLaMA model.
llamaRopeFreqBase :: !(Maybe Int64)
Base frequency for RoPE in the LLaMA model.
llamaVocabSize :: !(Maybe Int64)
Vocabulary size of the LLaMA model.
tokenizerGgmlBosToken_id :: !(Maybe Int)
BOS (beginning of sequence) token ID for the GGML tokenizer.
tokenizerGgmlEosToken_id :: !(Maybe Int)
EOS (end of sequence) token ID for the GGML tokenizer.
tokenizerGgmlMerges :: !(Maybe [Text])
List of merges for the GGML tokenizer.
tokenizerGgmlMode :: !(Maybe Text)
Mode of the GGML tokenizer.
tokenizerGgmlPre :: !(Maybe Text)
Pre-tokenization configuration for the GGML tokenizer.
tokenizerGgmlTokenType :: !(Maybe [Text])
Token type information for the GGML tokenizer.
tokenizerGgmlTokens :: !(Maybe [Text])
List of tokens for the GGML tokenizer.

Instances

Instances details

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

data ModelDetails Source #

Metadata describing a specific model's identity and configuration.

Constructors

ModelDetails

Fields

parentModel :: !(Maybe Text)
The parent model from which this model was derived, if any.
format :: !Text
The format used for the model (e.g., "gguf").
family :: !Text
The family name of the model (e.g., "llama", "mistral").
families :: ![Text]
Alternative or related family identifiers.
parameterSize :: !Text
The size of the model's parameters, typically expressed as a string (e.g., "7B").
quantizationLevel :: Text
The quantization level used (e.g., Q4, Q8).

Instances

Instances details

FromJSON ModelDetails Source #
Instance details Defined in Data.Ollama.Common.Types Methods parseJSON :: Value -> Parser ModelDetails # parseJSONList :: Value -> Parser [ModelDetails] # omittedField :: Maybe ModelDetails #
Show ModelDetails Source #
Instance details Defined in Data.Ollama.Common.Types Methods showsPrec :: Int -> ModelDetails -> ShowS # show :: ModelDetails -> String # showList :: [ModelDetails] -> ShowS #
Eq ModelDetails Source #
Instance details Defined in Data.Ollama.Common.Types Methods (==) :: ModelDetails -> ModelDetails -> Bool # (/=) :: ModelDetails -> ModelDetails -> Bool #