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

Data.Ollama.Common.Types

Description

📋 Overview

This module defines common types for working with Ollama's API, including:

Chat messages and roles
Text generation responses
Structured function/tool calling
Model metadata
Streaming handling
Custom model parameters

These types are consumed and returned by higher-level modules like Chat, Generate, and others.

Includes

Chat message structure and roles
Generate and chat response records
ModelOptions and advanced config
Structured function/tool call interfaces
JSON format hints and schema wrapping
Helper class HasDone for streaming termination

Most types implement ToJSON/FromJSON for direct API interaction.

Synopsis

data ModelDetails = ModelDetails {
- parentModel :: !(Maybe Text)
- format :: !Text
- family :: !Text
- families :: ![Text]
- parameterSize :: !Text
- quantizationLevel :: Text
}
data Format
- = JsonFormat
- | SchemaFormat Schema
data GenerateResponse = GenerateResponse {
- model :: !Text
- createdAt :: !UTCTime
- genResponse :: !Text
- done :: !Bool
- totalDuration :: !(Maybe Int64)
- loadDuration :: !(Maybe Int64)
- promptEvalCount :: !(Maybe Int64)
- promptEvalDuration :: !(Maybe Int64)
- evalCount :: !(Maybe Int64)
- evalDuration :: !(Maybe Int64)
- thinking :: !(Maybe Text)
}
data Message = Message {
- role :: !Role
- content :: !Text
- images :: !(Maybe [Text])
- tool_calls :: !(Maybe [ToolCall])
- thinking :: !(Maybe Text)
}
data Role
- = System
- | User
- | Assistant
- | Tool
data ChatResponse = ChatResponse {
- model :: !Text
- createdAt :: !UTCTime
- message :: !(Maybe Message)
- done :: !Bool
- totalDuration :: !(Maybe Int64)
- loadDuration :: !(Maybe Int64)
- promptEvalCount :: !(Maybe Int64)
- promptEvalDuration :: !(Maybe Int64)
- evalCount :: !(Maybe Int64)
- evalDuration :: !(Maybe Int64)
}
class HasDone a where
- getDone :: a -> Bool
data ModelOptions = ModelOptions {
- numKeep :: Maybe Int
- seed :: Maybe Int
- numPredict :: Maybe Int
- topK :: Maybe Int
- topP :: Maybe Double
- minP :: Maybe Double
- typicalP :: Maybe Double
- repeatLastN :: Maybe Int
- temperature :: Maybe Double
- repeatPenalty :: Maybe Double
- presencePenalty :: Maybe Double
- frequencyPenalty :: Maybe Double
- penalizeNewline :: Maybe Bool
- stop :: Maybe [Text]
- numa :: Maybe Bool
- numCtx :: Maybe Int
- numBatch :: Maybe Int
- numGpu :: Maybe Int
- mainGpu :: Maybe Int
- useMmap :: Maybe Bool
- numThread :: Maybe Int
}
data InputTool = InputTool {
- toolType :: Text
- function :: FunctionDef
}
data FunctionDef = FunctionDef {
- functionName :: Text
- functionDescription :: Maybe Text
- functionParameters :: Maybe FunctionParameters
- functionStrict :: Maybe Bool
}
data FunctionParameters = FunctionParameters {
- parameterType :: Text
- parameterProperties :: Maybe (Map Text FunctionParameters)
- requiredParams :: Maybe [Text]
- additionalProperties :: Maybe Bool
}
newtype ToolCall = ToolCall {
- outputFunction :: OutputFunction
}
data OutputFunction = OutputFunction {
- outputFunctionName :: Text
- arguments :: Map Text Value
}
newtype Version = Version Text

Documentation

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 #

data Format Source #

Format specification for the chat output.

Since: 0.1.3.0

Constructors

JsonFormat
SchemaFormat Schema

Instances

Instances details

ToJSON Format Source #
Instance details Defined in Data.Ollama.Common.Types Methods toJSON :: Format -> Value # toEncoding :: Format -> Encoding # toJSONList :: [Format] -> Value # toEncodingList :: [Format] -> Encoding # omitField :: Format -> Bool #
Show Format Source #
Instance details Defined in Data.Ollama.Common.Types Methods showsPrec :: Int -> Format -> ShowS # show :: Format -> String # showList :: [Format] -> ShowS #
Eq Format Source #
Instance details Defined in Data.Ollama.Common.Types Methods (==) :: Format -> Format -> Bool # (/=) :: Format -> Format -> Bool #

data GenerateResponse Source #

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.
genResponse :: !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.
thinking :: !(Maybe Text)
Thinking of reasoning models; if think is set to true
Since: 0.2.0.0

Instances

Instances details

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

data Message Source #

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. tool_calls :: !(Maybe [ToolCall]) a list of tools in JSON that the model wants to use Since: 0.1.3.0 thinking :: !(Maybe Text)

Instances

Instances details

FromJSON Message Source #

Instance details

Defined in Data.Ollama.Common.Types

Methods

parseJSON :: Value -> Parser Message #

parseJSONList :: Value -> Parser [Message] #

omittedField :: Maybe Message #

ToJSON Message Source #

Instance details

Defined in Data.Ollama.Common.Types

Methods

toJSON :: Message -> Value #

toEncoding :: Message -> Encoding #

toJSONList :: [Message] -> Value #

toEncodingList :: [Message] -> Encoding #

omitField :: Message -> Bool #

Generic Message Source #

Instance details

Defined in Data.Ollama.Common.Types

Associated Types

type Rep Message

Instance details

Defined in Data.Ollama.Common.Types

type Rep Message = D1 ('MetaData "Message" "Data.Ollama.Common.Types" "ollama-haskell-0.2.0.0-FoTQnIMi8UeBjcOZ65CLdd" 'False) (C1 ('MetaCons "Message" 'PrefixI 'True) ((S1 ('MetaSel ('Just "role") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Role) :*: S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "images") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "tool_calls") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe [ToolCall])) :*: S1 ('MetaSel ('Just "thinking") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Text))))))

Methods

from :: Message -> Rep Message x #

to :: Rep Message x -> Message #

Show Message Source #

Instance details

Defined in Data.Ollama.Common.Types

Methods

showsPrec :: Int -> Message -> ShowS #

show :: Message -> String #

showList :: [Message] -> ShowS #

Eq Message Source #

Instance details

Defined in Data.Ollama.Common.Types

Methods

(==) :: Message -> Message -> Bool #

(/=) :: Message -> Message -> Bool #

type Rep Message Source #

Instance details

Defined in Data.Ollama.Common.Types

type Rep Message = D1 ('MetaData "Message" "Data.Ollama.Common.Types" "ollama-haskell-0.2.0.0-FoTQnIMi8UeBjcOZ65CLdd" 'False) (C1 ('MetaCons "Message" 'PrefixI 'True) ((S1 ('MetaSel ('Just "role") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Role) :*: S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "images") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "tool_calls") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe [ToolCall])) :*: S1 ('MetaSel ('Just "thinking") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Text))))))

data Role Source #

Enumerated roles that can participate in a chat.

Constructors

System
User
Assistant
Tool

Instances

Instances details

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

data ChatResponse Source #

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

Instances details

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

class HasDone a where Source #

A workaround to use done field within commonStreamHandler

Methods

getDone :: a -> Bool Source #

Instances

Instances details

HasDone ChatResponse Source #
Instance details Defined in Data.Ollama.Common.Types Methods getDone :: ChatResponse -> Bool Source #
HasDone GenerateResponse Source #
Instance details Defined in Data.Ollama.Common.Types Methods getDone :: GenerateResponse -> Bool Source #

data ModelOptions Source #

Optional model tuning parameters that influence generation behavior.

Since: 0.2.0.0

Constructors

ModelOptions

Fields

Instances

Instances details

ToJSON ModelOptions Source #	Custom ToJSON instance for Options
Instance details Defined in Data.Ollama.Common.Types Methods toJSON :: ModelOptions -> Value # toEncoding :: ModelOptions -> Encoding # toJSONList :: [ModelOptions] -> Value # toEncodingList :: [ModelOptions] -> Encoding # omitField :: ModelOptions -> Bool #
Show ModelOptions Source #
Instance details Defined in Data.Ollama.Common.Types Methods showsPrec :: Int -> ModelOptions -> ShowS # show :: ModelOptions -> String # showList :: [ModelOptions] -> ShowS #
Eq ModelOptions Source #
Instance details Defined in Data.Ollama.Common.Types Methods (==) :: ModelOptions -> ModelOptions -> Bool # (/=) :: ModelOptions -> ModelOptions -> Bool #

data InputTool Source #

Represents a tool that can be used in the conversation.

Since: 0.2.0.0

Constructors

InputTool
Fields toolType :: Text The type of the tool function :: FunctionDef The function associated with the tool

Instances

Instances details

FromJSON InputTool Source #

Instance details

Defined in Data.Ollama.Common.Types

Methods

parseJSON :: Value -> Parser InputTool #

parseJSONList :: Value -> Parser [InputTool] #

omittedField :: Maybe InputTool #

ToJSON InputTool Source #

Instance details

Defined in Data.Ollama.Common.Types

Methods

toJSON :: InputTool -> Value #

toEncoding :: InputTool -> Encoding #

toJSONList :: [InputTool] -> Value #

toEncodingList :: [InputTool] -> Encoding #

omitField :: InputTool -> Bool #

Generic InputTool Source #

Instance details

Defined in Data.Ollama.Common.Types

Associated Types

type Rep InputTool

Instance details

Defined in Data.Ollama.Common.Types

type Rep InputTool = D1 ('MetaData "InputTool" "Data.Ollama.Common.Types" "ollama-haskell-0.2.0.0-FoTQnIMi8UeBjcOZ65CLdd" 'False) (C1 ('MetaCons "InputTool" 'PrefixI 'True) (S1 ('MetaSel ('Just "toolType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "function") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FunctionDef)))

Methods

from :: InputTool -> Rep InputTool x #

to :: Rep InputTool x -> InputTool #

Show InputTool Source #

Instance details

Defined in Data.Ollama.Common.Types

Methods

showsPrec :: Int -> InputTool -> ShowS #

show :: InputTool -> String #

showList :: [InputTool] -> ShowS #

Eq InputTool Source #

Instance details

Defined in Data.Ollama.Common.Types

Methods

(==) :: InputTool -> InputTool -> Bool #

(/=) :: InputTool -> InputTool -> Bool #

type Rep InputTool Source #

Instance details

Defined in Data.Ollama.Common.Types

type Rep InputTool = D1 ('MetaData "InputTool" "Data.Ollama.Common.Types" "ollama-haskell-0.2.0.0-FoTQnIMi8UeBjcOZ65CLdd" 'False) (C1 ('MetaCons "InputTool" 'PrefixI 'True) (S1 ('MetaSel ('Just "toolType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "function") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FunctionDef)))

data FunctionDef Source #

Represents a function that can be called by the model.

Since: 0.2.0.0

Constructors

FunctionDef
Fields functionName :: Text The name of the function functionDescription :: Maybe Text Optional description of the function functionParameters :: Maybe FunctionParameters Optional parameters for the function functionStrict :: Maybe Bool Optional strictness flag

Instances

Instances details

FromJSON FunctionDef Source #

Instance details

Defined in Data.Ollama.Common.Types

Methods

parseJSON :: Value -> Parser FunctionDef #

parseJSONList :: Value -> Parser [FunctionDef] #

omittedField :: Maybe FunctionDef #

ToJSON FunctionDef Source #

Instance details

Defined in Data.Ollama.Common.Types

Methods

toJSON :: FunctionDef -> Value #

toEncoding :: FunctionDef -> Encoding #

toJSONList :: [FunctionDef] -> Value #

toEncodingList :: [FunctionDef] -> Encoding #

omitField :: FunctionDef -> Bool #

Generic FunctionDef Source #

Instance details

Defined in Data.Ollama.Common.Types

Associated Types

type Rep FunctionDef

Instance details

Defined in Data.Ollama.Common.Types

type Rep FunctionDef = D1 ('MetaData "FunctionDef" "Data.Ollama.Common.Types" "ollama-haskell-0.2.0.0-FoTQnIMi8UeBjcOZ65CLdd" 'False) (C1 ('MetaCons "FunctionDef" 'PrefixI 'True) ((S1 ('MetaSel ('Just "functionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "functionDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "functionParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FunctionParameters)) :*: S1 ('MetaSel ('Just "functionStrict") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))))

Methods

from :: FunctionDef -> Rep FunctionDef x #

to :: Rep FunctionDef x -> FunctionDef #

Show FunctionDef Source #

Instance details

Defined in Data.Ollama.Common.Types

Methods

showsPrec :: Int -> FunctionDef -> ShowS #

show :: FunctionDef -> String #

showList :: [FunctionDef] -> ShowS #

Eq FunctionDef Source #

Instance details

Defined in Data.Ollama.Common.Types

Methods

(==) :: FunctionDef -> FunctionDef -> Bool #

(/=) :: FunctionDef -> FunctionDef -> Bool #

type Rep FunctionDef Source #

Instance details

Defined in Data.Ollama.Common.Types

type Rep FunctionDef = D1 ('MetaData "FunctionDef" "Data.Ollama.Common.Types" "ollama-haskell-0.2.0.0-FoTQnIMi8UeBjcOZ65CLdd" 'False) (C1 ('MetaCons "FunctionDef" 'PrefixI 'True) ((S1 ('MetaSel ('Just "functionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "functionDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "functionParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FunctionParameters)) :*: S1 ('MetaSel ('Just "functionStrict") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))))

data FunctionParameters Source #

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

Since: 0.2.0.0

Constructors

FunctionParameters
Fields parameterType :: Text Type of the parameter (usually "object"). parameterProperties :: Maybe (Map Text FunctionParameters) Optional nested parameters as a property map. requiredParams :: Maybe [Text] List of required parameter names. additionalProperties :: Maybe Bool Whether additional (unspecified) parameters are allowed.

Instances

Instances details

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

newtype ToolCall Source #

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

Since: 0.2.0.0

Constructors

ToolCall
Fields outputFunction :: OutputFunction The function the model intends to call, with arguments.

Instances

Instances details

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

data OutputFunction Source #

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

Since: 0.2.0.0

Constructors

OutputFunction
Fields outputFunctionName :: Text The name of the function to invoke. arguments :: Map Text Value A key-value map of argument names to values (JSON values).

Instances

Instances details

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

newtype Version Source #

A wrapper for the Ollama engine version string.

Constructors

Version Text

Instances

Instances details

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