ollama

package module

Go to main page

Versions in this module

v1

v1.0.3

Jul 26, 2026

Changes in this version

+ var ErrContextLengthExceeded = errors.New("ollama: context length exceeded")

+ var ErrModelNotFound = errors.New("ollama: model not found")

+ var ErrRateLimited = errors.New("ollama: rate limited")

+ var ErrServerBusy = errors.New("ollama: server busy")

+ var ErrUnauthorized = errors.New("ollama: unauthorized")

+ var ErrUnsupportedCapability = errors.New("ollama: unsupported capability")

type APIError

+ func (e *APIError) Unwrap() error

v1.0.2

Jul 26, 2026

Changes in this version

type ChatNewParams

+ Shift *bool

+ Truncate *bool

type ChatResponse

+ RemoteHost string

+ RemoteModel string

type EmbeddingNewParams

+ KeepAlive any

type FunctionCall

+ Index int

type GenerateNewParams

+ Context []int

+ Height *int

+ Shift *bool

+ Steps *int

+ Template string

+ Truncate *bool

+ Width *int

type GenerateResponse

+ Completed int64

+ Context []int

+ Image string

+ RemoteHost string

+ RemoteModel string

+ ToolCalls []ToolCall

+ Total int64

type Message

+ ToolCallID string

+ ToolName string

type ModelCreateParams

+ Adapters map[string]string

+ DraftFiles map[string]string

+ DraftQuantize string

+ Files map[string]string

+ Info map[string]any

+ Parser string

+ RemoteHost string

+ Renderer string

+ Requires string

type ModelShowParams

+ Options map[string]any

+ System string

+ Template string

type OptionKey

+ const DraftNumPredict

+ const FrequencyPenalty

+ const MainGPU

+ const NumBatch

+ const NumGPU

+ const NumKeep

+ const NumThread

+ const PresencePenalty

+ const TypicalP

+ const UseMMap

type Tool

+ Items any

type ToolCall

+ ID string

v1.0.1

Jun 4, 2026

v1.0.0

Jun 1, 2026

Changes in this version

+ const CloudBaseURL

+ const DefaultBaseURL

+ const RoleAssistant

+ const RoleSystem

+ const RoleTool

+ const RoleUser

+ func Bool(v bool) *bool

+ func Int(v int) *int

+ type APIError struct

+ Body []byte

+ Message string

+ Status string

+ StatusCode int

+ func (e *APIError) Error() string

+ type ChatNewParams struct

+ Format any

+ KeepAlive any

+ LogProbs *bool

+ Messages []Message

+ Model string

+ Options Options

+ Stream *bool

+ Think any

+ Tools []Tool

+ TopLogProbs *int

+ type ChatResponse struct

+ CreatedAt time.Time

+ Done bool

+ DoneReason string

+ LogProbs []LogProb

+ Message Message

+ Model string

+ type ChatService struct

+ func (s *ChatService) New(ctx context.Context, params ChatNewParams) (*ChatResponse, error)

+ func (s *ChatService) NewStreaming(ctx context.Context, params ChatNewParams, fn func(ChatResponse) error) error

+ type Client struct

+ Chat *ChatService

+ Embeddings *EmbeddingService

+ Generate *GenerateService

+ Models *ModelService

+ Version *VersionService

+ func MustNew(opts ...Option) *Client

+ func New(opts ...Option) (*Client, error)

+ func NewClient(opts ...Option) (*Client, error)

+ func NewCloud(opts ...Option) (*Client, error)

+ type EmbedResponse struct

+ Embeddings [][]float64

+ LoadDuration int64

+ Model string

+ PromptEvalCount int

+ TotalDuration int64

+ type EmbeddingNewParams struct

+ Dimensions *int

+ Input any

+ Model string

+ Options Options

+ Truncate *bool

+ type EmbeddingService struct

+ func (s *EmbeddingService) New(ctx context.Context, params EmbeddingNewParams) (*EmbedResponse, error)

+ type FunctionCall struct

+ Arguments map[string]any

+ Description string

+ Name string

+ type GenerateNewParams struct

+ Format any

+ Images []string

+ KeepAlive any

+ LogProbs *bool

+ Model string

+ Options Options

+ Prompt string

+ Raw *bool

+ Stream *bool

+ Suffix string

+ System string

+ Think any

+ TopLogProbs *int

+ type GenerateResponse struct

+ CreatedAt time.Time

+ Done bool

+ DoneReason string

+ LogProbs []LogProb

+ Model string

+ Response string

+ Thinking string

+ type GenerateService struct

+ func (s *GenerateService) New(ctx context.Context, params GenerateNewParams) (*GenerateResponse, error)

+ func (s *GenerateService) NewStreaming(ctx context.Context, params GenerateNewParams, fn func(GenerateResponse) error) error

+ type ListModelsResponse struct

+ Models []Model

+ type ListRunningModelsResponse struct

+ Models []Model

+ type LogProb struct

+ Bytes []int

+ LogProb float64

+ Token string

+ TopLogProbs []TopLogProb

+ type Message struct

+ Content string

+ Images []string

+ Role string

+ Thinking string

+ ToolCalls []ToolCall

+ func NewMessage(role, content string) Message

+ type Metrics struct

+ EvalCount int

+ EvalDuration int64

+ LoadDuration int64

+ PromptEvalCount int

+ PromptEvalDuration int64

+ TotalDuration int64

+ type MissingFieldError struct

+ Field string

+ func (e *MissingFieldError) Error() string

+ type Model struct

+ ContextLength int

+ Details ModelDetails

+ Digest string

+ ExpiresAt time.Time

+ Model string

+ ModifiedAt time.Time

+ Name string

+ Size int64

+ SizeVRAM int64

+ type ModelCopyParams struct

+ Destination string

+ Source string

+ type ModelCreateParams struct

+ From string

+ License any

+ Messages []Message

+ Model string

+ Parameters map[string]any

+ Quantize string

+ Stream *bool

+ System string

+ Template string

+ type ModelDeleteParams struct

+ Model string

+ type ModelDetails struct

+ Families []string

+ Family string

+ Format string

+ ParameterSize string

+ ParentModel string

+ QuantizationLevel string

+ type ModelPullParams struct

+ Insecure *bool

+ Model string

+ Stream *bool

+ type ModelPushParams struct

+ Insecure *bool

+ Model string

+ Stream *bool

+ type ModelService struct

+ func (s *ModelService) Copy(ctx context.Context, params ModelCopyParams) error

+ func (s *ModelService) Create(ctx context.Context, params ModelCreateParams) (*StatusResponse, error)

+ func (s *ModelService) CreateStreaming(ctx context.Context, params ModelCreateParams, fn func(StatusResponse) error) error

+ func (s *ModelService) Delete(ctx context.Context, params ModelDeleteParams) error

+ func (s *ModelService) List(ctx context.Context) (*ListModelsResponse, error)

+ func (s *ModelService) ListRunning(ctx context.Context) (*ListRunningModelsResponse, error)

+ func (s *ModelService) Pull(ctx context.Context, params ModelPullParams) (*StatusResponse, error)

+ func (s *ModelService) PullStreaming(ctx context.Context, params ModelPullParams, fn func(StatusResponse) error) error

+ func (s *ModelService) Push(ctx context.Context, params ModelPushParams) (*StatusResponse, error)

+ func (s *ModelService) PushStreaming(ctx context.Context, params ModelPushParams, fn func(StatusResponse) error) error

+ func (s *ModelService) Show(ctx context.Context, params ModelShowParams) (*ShowResponse, error)

+ type ModelShowParams struct

+ Model string

+ Verbose *bool

+ type Option func(*Client) error

+ func WithBaseURL(rawURL string) Option

+ func WithHTTPClient(httpClient *http.Client) Option

+ func WithHeader(key, value string) Option

+ func WithHeaders(headers map[string]string) Option

+ func WithUserAgent(userAgent string) Option

+ type OptionKey string

+ const MinP

+ const NumCtx

+ const NumPredict

+ const RepeatLastN

+ const RepeatPenalty

+ const Seed

+ const Stop

+ const Temperature

+ const TopK

+ const TopP

+ func (k OptionKey) String() string

+ type Options map[OptionKey]any

+ type ShowResponse struct

+ Capabilities []string

+ Details ModelDetails

+ License any

+ ModelInfo map[string]any

+ ModifiedAt time.Time

+ Parameters string

+ Template string

+ type StatusResponse struct

+ Completed int64

+ Digest string

+ Status string

+ Total int64

+ type Tool struct

+ Function ToolFunction

+ Type string

+ type ToolCall struct

+ Function FunctionCall

+ type ToolFunction struct

+ Description string

+ Name string

+ Parameters any

+ type TopLogProb struct

+ Bytes []int

+ LogProb float64

+ Token string

+ type VersionResponse struct

+ Version string

+ type VersionService struct

+ func (s *VersionService) Get(ctx context.Context) (*VersionResponse, error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL