server

package
v0.11.5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 19, 2025 License: MIT Imports: 65 Imported by: 11

Documentation

Index

Constants

View Source 
const (
	DefaultRegistry       = "registry.ollama.ai"
	DefaultNamespace      = "library"
	DefaultTag            = "latest"
	DefaultProtocolScheme = "https"
)

Variables

View Source 
var (
	ErrInvalidImageFormat  = errors.New("invalid image format")
	ErrInvalidDigestFormat = errors.New("invalid digest format")
	ErrInvalidProtocol     = errors.New("invalid protocol scheme")
	ErrInsecureProtocol    = errors.New("insecure protocol http")
	ErrModelPathInvalid    = errors.New("invalid model path")
)
View Source 
var ErrMaxQueue = errors.New("server busy, please try again.  maximum pending requests exceeded")

Functions

func CopyModel 

func CopyModel(src, dst model.Name) error

func GetBlobsPath 

func GetBlobsPath(digest string) (string, error)

func GetManifestPath 

func GetManifestPath() (string, error)

func GetModelInfo 

func GetModelInfo(req api.ShowRequest) (*api.ShowResponse, error)

func GetSHA256Digest 

func GetSHA256Digest(r io.Reader) (string, int64)

GetSHA256Digest returns the SHA256 hash of a given buffer and returns it, and the size of buffer

func Manifests added in v0.1.40 

func Manifests(continueOnError bool) (map[model.Name]*Manifest, error)

func PruneDirectory 

func PruneDirectory(path string) error

func PruneLayers 

func PruneLayers() error

func PullModel 

func PullModel(ctx context.Context, name string, regOpts *registryOptions, fn func(api.ProgressResponse)) error

func PushModel 

func PushModel(ctx context.Context, name string, regOpts *registryOptions, fn func(api.ProgressResponse)) error

func Serve 

func Serve(ln net.Listener) error

func WriteManifest 

func WriteManifest(name model.Name, config Layer, layers []Layer) error

Types

type ByDurationAndName added in v0.6.6 

type ByDurationAndName []*runnerRef

func (ByDurationAndName) Len added in v0.6.6 

func (a ByDurationAndName) Len() int

func (ByDurationAndName) Less added in v0.6.6 

func (a ByDurationAndName) Less(i, j int) bool

func (ByDurationAndName) Swap added in v0.6.6 

func (a ByDurationAndName) Swap(i, j int)

type ConfigV2 

type ConfigV2 struct {
	ModelFormat   string   `json:"model_format"`
	ModelFamily   string   `json:"model_family"`
	ModelFamilies []string `json:"model_families"`
	ModelType     string   `json:"model_type"`
	FileType      string   `json:"file_type"`

	// required by spec
	Architecture string `json:"architecture"`
	OS           string `json:"os"`
	RootFS       RootFS `json:"rootfs"`
}

type FunctionNameMap added in v0.11.5 

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

FunctionNameMap maps a user-specified function name to a valid function name for harmony (which look like TypeScript identifiers). This is needed to transform user-specified function names, which might contain characters that are not allowed in TypeScript identifiers

func NewFunctionNameMap added in v0.11.5 

func NewFunctionNameMap() *FunctionNameMap

func (*FunctionNameMap) ConvertAndAdd added in v0.11.5 

func (m *FunctionNameMap) ConvertAndAdd(userFunctionName string) string

func (*FunctionNameMap) OriginalFromConverted added in v0.11.5 

func (m *FunctionNameMap) OriginalFromConverted(harmonyFunctionName string) string

OriginalFromConverted looks up the reverse-mapping of a previously-converted user->harmony function name. To unmap reliably, the mapping must exist, as the conversion process is not reversible without the appropriate state

type HarmonyEvent added in v0.11.1 

type HarmonyEvent interface {
	// contains filtered or unexported methods
}

type HarmonyEventContentEmitted added in v0.11.1 

type HarmonyEventContentEmitted struct {
	Content string
}

type HarmonyEventHeaderComplete added in v0.11.1 

type HarmonyEventHeaderComplete struct {
	Header HarmonyHeader
}

type HarmonyEventMessageEnd added in v0.11.1 

type HarmonyEventMessageEnd struct{}

type HarmonyEventMessageStart added in v0.11.1 

type HarmonyEventMessageStart struct{}

type HarmonyHeader added in v0.11.1 

type HarmonyHeader struct {
	Role      string
	Channel   string
	Recipient string
}

type HarmonyMessageHandler added in v0.11.1 

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

HarmonyMessageHandler processes harmony events and accumulates content appropriately. This is a higher level interface that maps harmony concepts into ollama concepts

func NewHarmonyMessageHandler added in v0.11.1 

func NewHarmonyMessageHandler() *HarmonyMessageHandler

NewHarmonyMessageHandler creates a new message handler

func (*HarmonyMessageHandler) AddContent added in v0.11.1 

func (h *HarmonyMessageHandler) AddContent(content string, toolParser *HarmonyToolCallAccumulator) (string, string, string)

AddContent processes the content and returns the content, thinking, and tool content. content and thinking are already fully parsed, but tool content still needs to be passed to the tool parser

func (*HarmonyMessageHandler) CreateToolParser added in v0.11.1 

func (h *HarmonyMessageHandler) CreateToolParser() *HarmonyToolCallAccumulator

type HarmonyParser added in v0.11.1 

type HarmonyParser struct {
	MessageStartTag string
	MessageEndTag   string
	HeaderEndTag    string
	// contains filtered or unexported fields
}

func (*HarmonyParser) AddContent added in v0.11.1 

func (s *HarmonyParser) AddContent(content string) []HarmonyEvent

func (*HarmonyParser) AddImplicitStart added in v0.11.1 

func (s *HarmonyParser) AddImplicitStart()

func (*HarmonyParser) AddImplicitStartOrPrefill added in v0.11.1 

func (s *HarmonyParser) AddImplicitStartOrPrefill(lastMessage *api.Message)

type HarmonyToolCallAccumulator added in v0.11.1 

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

func (*HarmonyToolCallAccumulator) Add added in v0.11.1 

func (a *HarmonyToolCallAccumulator) Add(content string)

func (*HarmonyToolCallAccumulator) Content added in v0.11.1 

func (a *HarmonyToolCallAccumulator) Content() string

func (*HarmonyToolCallAccumulator) Drain added in v0.11.1 

func (a *HarmonyToolCallAccumulator) Drain() (*string, string)

func (*HarmonyToolCallAccumulator) SetToolName added in v0.11.1 

func (a *HarmonyToolCallAccumulator) SetToolName(toolName string)

type Layer 

type Layer struct {
	MediaType string `json:"mediaType"`
	Digest    string `json:"digest"`
	Size      int64  `json:"size"`
	From      string `json:"from,omitempty"`
	// contains filtered or unexported fields
}

func NewLayer 

func NewLayer(r io.Reader, mediatype string) (Layer, error)

func NewLayerFromLayer 

func NewLayerFromLayer(digest, mediatype, from string) (Layer, error)

func (*Layer) Open added in v0.1.35 

func (l *Layer) Open() (io.ReadSeekCloser, error)

func (*Layer) Remove added in v0.1.40 

func (l *Layer) Remove() error

type LlmRequest added in v0.1.33 

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

type Manifest added in v0.1.35 

type Manifest struct {
	SchemaVersion int     `json:"schemaVersion"`
	MediaType     string  `json:"mediaType"`
	Config        Layer   `json:"config"`
	Layers        []Layer `json:"layers"`
	// contains filtered or unexported fields
}

func GetManifest 

func GetManifest(mp ModelPath) (*Manifest, string, error)

func ParseNamedManifest added in v0.1.35 

func ParseNamedManifest(n model.Name) (*Manifest, error)

func (*Manifest) Remove added in v0.1.40 

func (m *Manifest) Remove() error

func (*Manifest) RemoveLayers added in v0.1.42 

func (m *Manifest) RemoveLayers() error

func (*Manifest) Size added in v0.1.35 

func (m *Manifest) Size() (size int64)

type Model 

type Model struct {
	Name           string `json:"name"`
	Config         ConfigV2
	ShortName      string
	ModelPath      string
	ParentModel    string
	AdapterPaths   []string
	ProjectorPaths []string
	System         string
	License        []string
	Digest         string
	Options        map[string]any
	Messages       []api.Message

	Template *template.Template
}

func GetModel 

func GetModel(name string) (*Model, error)

func (*Model) Capabilities added in v0.6.4 

func (m *Model) Capabilities() []model.Capability

Capabilities returns the capabilities that the model supports

func (*Model) CheckCapabilities added in v0.2.2 

func (m *Model) CheckCapabilities(want ...model.Capability) error

CheckCapabilities checks if the model has the specified capabilities returning an error describing any missing or unknown capabilities

func (*Model) String added in v0.1.34 

func (m *Model) String() string

type ModelPath 

type ModelPath struct {
	ProtocolScheme string
	Registry       string
	Namespace      string
	Repository     string
	Tag            string
}

func ParseModelPath 

func ParseModelPath(name string) ModelPath

func (ModelPath) BaseURL 

func (mp ModelPath) BaseURL() *url.URL

func (ModelPath) GetFullTagname 

func (mp ModelPath) GetFullTagname() string

func (ModelPath) GetManifestPath 

func (mp ModelPath) GetManifestPath() (string, error)

GetManifestPath returns the path to the manifest file for the given model path, it is up to the caller to create the directory if it does not exist.

func (ModelPath) GetNamespaceRepository 

func (mp ModelPath) GetNamespaceRepository() string

func (ModelPath) GetShortTagname 

func (mp ModelPath) GetShortTagname() string

type RootFS 

type RootFS struct {
	Type    string   `json:"type"`
	DiffIDs []string `json:"diff_ids"`
}

type Scheduler added in v0.1.33 

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

func InitScheduler added in v0.1.33 

func InitScheduler(ctx context.Context) *Scheduler

func (*Scheduler) GetRunner added in v0.1.33 

func (s *Scheduler) GetRunner(c context.Context, m *Model, opts api.Options, sessionDuration *api.Duration) (chan *runnerRef, chan error)

context must be canceled to decrement ref count and release the runner

func (*Scheduler) Run added in v0.1.33 

func (s *Scheduler) Run(ctx context.Context)

Returns immediately, spawns go routines for the scheduler which will shutdown when ctx is done

type Server 

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

func (*Server) ChatHandler added in v0.1.33 

func (s *Server) ChatHandler(c *gin.Context)

func (*Server) CopyHandler added in v0.3.8 

func (s *Server) CopyHandler(c *gin.Context)

func (*Server) CreateBlobHandler added in v0.1.33 

func (s *Server) CreateBlobHandler(c *gin.Context)

func (*Server) CreateHandler added in v0.3.8 

func (s *Server) CreateHandler(c *gin.Context)

func (*Server) DeleteHandler added in v0.3.8 

func (s *Server) DeleteHandler(c *gin.Context)

func (*Server) EmbedHandler added in v0.2.6 

func (s *Server) EmbedHandler(c *gin.Context)

func (*Server) EmbeddingsHandler added in v0.1.33 

func (s *Server) EmbeddingsHandler(c *gin.Context)

func (*Server) GenerateHandler added in v0.1.33 

func (s *Server) GenerateHandler(c *gin.Context)

func (*Server) GenerateRoutes 

func (s *Server) GenerateRoutes(rc *ollama.Registry) (http.Handler, error)

func (*Server) HeadBlobHandler added in v0.1.33 

func (s *Server) HeadBlobHandler(c *gin.Context)

func (*Server) ListHandler added in v0.3.8 

func (s *Server) ListHandler(c *gin.Context)

func (*Server) PsHandler added in v0.3.8 

func (s *Server) PsHandler(c *gin.Context)

func (*Server) PullHandler added in v0.3.8 

func (s *Server) PullHandler(c *gin.Context)

func (*Server) PushHandler added in v0.3.8 

func (s *Server) PushHandler(c *gin.Context)

func (*Server) ShowHandler added in v0.3.8 

func (s *Server) ShowHandler(c *gin.Context)

Source Files

View all Source files

Directories

Path Synopsis
internal
cache/blob
Package blob implements a content-addressable disk cache for blobs and manifests.
 Package blob implements a content-addressable disk cache for blobs and manifests.
client/ollama
Package ollama provides a client for interacting with an Ollama registry which pushes and pulls model manifests and layers as defined by the ollama.com/manifest.
 Package ollama provides a client for interacting with an Ollama registry which pushes and pulls model manifests and layers as defined by the ollama.com/manifest.
internal/backoff
internal/names
internal/stringsx
Package stringsx provides additional string manipulation functions that aren't in the standard library's strings package or go4.org/mem.
 Package stringsx provides additional string manipulation functions that aren't in the standard library's strings package or go4.org/mem.
internal/syncs
Package syncs provides synchronization primitives.
 Package syncs provides synchronization primitives.
manifest
Package manifest provides documentation for the Ollama manifest format.
 Package manifest provides documentation for the Ollama manifest format.
registry
Package registry implements an http.Handler for handling local Ollama API model management requests.
 Package registry implements an http.Handler for handling local Ollama API model management requests.
testutil

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.