ollama

Documentation

Index

• type ChatRequest
• type ChatResponse
• type ChatStream
• type Client
  • func New(apiURL string, optFns ...func(o *ClientOptions)) *Client
  • func (c *Client) CreateChat(ctx context.Context, req *ChatRequest) (*ChatResponse, error)
  • func (c *Client) CreateChatStream(ctx context.Context, req *ChatRequest) (*ChatStream, error)
  • func (c *Client) CreateEmbedding(ctx context.Context, req *EmbeddingRequest) (*EmbeddingResponse, error)
  • func (c *Client) CreateGeneration(ctx context.Context, req *GenerationRequest) (*GenerationResponse, error)
  • func (c *Client) CreateGenerationStream(ctx context.Context, req *GenerationRequest) (*GenerationStream, error)
• type ClientOptions
• type EmbeddingRequest
• type EmbeddingResponse
• type ErrorResponse
• type GenerationRequest
• type GenerationResponse
• type GenerationStream
• type HTTPClient
• type ImageData
• type Message
• type Metrics
• type Options
• type Runner

Types

type ChatRequest

type ChatRequest struct {
	Model    string    `json:"model"`
	Messages []Message `json:"messages"`
	Stream   *bool     `json:"stream,omitempty"`
	Format   string    `json:"format"`

	Options Options `json:"options"`
}

type ChatResponse

type ChatResponse struct {
	Model     string    `json:"model"`
	CreatedAt time.Time `json:"created_at"`
	Message   *Message  `json:"message,omitempty"`

	Done bool `json:"done"`

	Metrics
}

type ChatStream

type ChatStream struct {
	*stream.Stream[ChatResponse]
}

type Client

type Client struct {
	// contains filtered or unexported fields
}

func New

func New(apiURL string, optFns ...func(o *ClientOptions)) *Client

func (*Client) CreateChat

func (c *Client) CreateChat(ctx context.Context, req *ChatRequest) (*ChatResponse, error)

func (*Client) CreateChatStream

func (c *Client) CreateChatStream(ctx context.Context, req *ChatRequest) (*ChatStream, error)

func (*Client) CreateEmbedding

func (c *Client) CreateEmbedding(ctx context.Context, req *EmbeddingRequest) (*EmbeddingResponse, error)

func (*Client) CreateGeneration

func (c *Client) CreateGeneration(ctx context.Context, req *GenerationRequest) (*GenerationResponse, error)

func (*Client) CreateGenerationStream

func (c *Client) CreateGenerationStream(ctx context.Context, req *GenerationRequest) (*GenerationStream, error)

type ClientOptions

type ClientOptions struct {
	// The HTTP client to use for making API requests.
	HTTPClient HTTPClient
}

type EmbeddingRequest

type EmbeddingRequest struct {
	Model   string  `json:"model"`
	Prompt  string  `json:"prompt"`
	Options Options `json:"options"`
}

type EmbeddingResponse

type EmbeddingResponse struct {
	Embedding []float32 `json:"embedding"`
}

type ErrorResponse

type ErrorResponse struct {
	Message string `json:"error"`
}

type GenerationRequest

type GenerationRequest struct {
	Model    string      `json:"model"`
	Prompt   string      `json:"prompt"`
	System   string      `json:"system"`
	Template string      `json:"template"`
	Context  []int       `json:"context,omitempty"`
	Stream   *bool       `json:"stream,omitempty"`
	Raw      bool        `json:"raw,omitempty"`
	Format   string      `json:"format"`
	Images   []ImageData `json:"images,omitempty"`

	Options Options `json:"options"`
}

type GenerationResponse

type GenerationResponse struct {
	Model     string    `json:"model"`
	CreatedAt time.Time `json:"created_at"`
	Response  string    `json:"response"`

	Done    bool  `json:"done"`
	Context []int `json:"context,omitempty"`

	Metrics
}

type GenerationStream

type GenerationStream struct {
	*stream.Stream[GenerationResponse]
}

type HTTPClient

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

HTTPClient is an interface for making HTTP requests.

type ImageData

type ImageData []byte

type Message

type Message struct {
	Role    string      `json:"role"` // one of ["system", "user", "assistant"]
	Content string      `json:"content"`
	Images  []ImageData `json:"images,omitempty"`
}

type Metrics

type Metrics struct {
	TotalDuration      time.Duration `json:"total_duration,omitempty"`
	LoadDuration       time.Duration `json:"load_duration,omitempty"`
	PromptEvalCount    int           `json:"prompt_eval_count,omitempty"`
	PromptEvalDuration time.Duration `json:"prompt_eval_duration,omitempty"`
	EvalCount          int           `json:"eval_count,omitempty"`
	EvalDuration       time.Duration `json:"eval_duration,omitempty"`
}

type Options

type Options struct {
	Stop []string `json:"stop,omitempty"`
	Runner
	RepeatLastN      int     `json:"repeat_last_n,omitempty"`
	Seed             int     `json:"seed,omitempty"`
	TopK             int     `json:"top_k,omitempty"`
	NumKeep          int     `json:"num_keep,omitempty"`
	Mirostat         int     `json:"mirostat,omitempty"`
	NumPredict       int     `json:"num_predict,omitempty"`
	Temperature      float32 `json:"temperature,omitempty"`
	TypicalP         float32 `json:"typical_p,omitempty"`
	RepeatPenalty    float32 `json:"repeat_penalty,omitempty"`
	PresencePenalty  float32 `json:"presence_penalty,omitempty"`
	FrequencyPenalty float32 `json:"frequency_penalty,omitempty"`
	TFSZ             float32 `json:"tfs_z,omitempty"`
	MirostatTau      float32 `json:"mirostat_tau,omitempty"`
	MirostatEta      float32 `json:"mirostat_eta,omitempty"`
	TopP             float32 `json:"top_p,omitempty"`
	PenalizeNewline  bool    `json:"penalize_newline,omitempty"`
}

type Runner

type Runner struct {
	NumCtx             int     `json:"num_ctx,omitempty"`
	NumBatch           int     `json:"num_batch,omitempty"`
	NumGQA             int     `json:"num_gqa,omitempty"`
	NumGPU             int     `json:"num_gpu,omitempty"`
	MainGPU            int     `json:"main_gpu,omitempty"`
	NumThread          int     `json:"num_thread,omitempty"`
	RopeFrequencyBase  float32 `json:"rope_frequency_base,omitempty"`
	RopeFrequencyScale float32 `json:"rope_frequency_scale,omitempty"`
	LogitsAll          bool    `json:"logits_all,omitempty"`
	VocabOnly          bool    `json:"vocab_only,omitempty"`
	UseMMap            bool    `json:"use_mmap,omitempty"`
	UseMLock           bool    `json:"use_mlock,omitempty"`
	EmbeddingOnly      bool    `json:"embedding_only,omitempty"`
	UseNUMA            bool    `json:"numa,omitempty"`
	F16KV              bool    `json:"f16_kv,omitempty"`
	LowVRAM            bool    `json:"low_vram,omitempty"`
}