ollama

Documentation

Index

• func DefineEmbedder(serverAddress string, model string) ai.Embedder
• func DefineModel(model ModelDefinition, caps *ai.ModelCapabilities) ai.Model
• func Embedder(serverAddress string) ai.Embedder
• func Init(ctx context.Context, cfg *Config) (err error)
• func IsDefinedEmbedder(serverAddress string) bool
• func IsDefinedModel(name string) bool
• func Model(name string) ai.Model
• type Config
• type EmbedOptions
• type ModelDefinition

Functions

func DefineEmbedder

func DefineEmbedder(serverAddress string, model string) ai.Embedder

DefineEmbedder defines an embedder with a given server address.

func DefineModel

func DefineModel(model ModelDefinition, caps *ai.ModelCapabilities) ai.Model

func Embedder

func Embedder(serverAddress string) ai.Embedder

Embedder returns the ai.Embedder with the given server address. It returns nil if the embedder was not defined.

func Init

func Init(ctx context.Context, cfg *Config) (err error)

Init initializes the plugin. Since Ollama models are locally hosted, the plugin doesn't initialize any default models. After downloading a model, call DefineModel to use it.

func IsDefinedEmbedder

func IsDefinedEmbedder(serverAddress string) bool

IsDefinedEmbedder reports whether the embedder with the given server address is defined by this plugin.

func IsDefinedModel

func IsDefinedModel(name string) bool

IsDefinedModel reports whether a model is defined.

func Model

func Model(name string) ai.Model

Model returns the ai.Model with the given name. It returns nil if the model was not configured.

Types

type Config

type Config struct {
	// Server Address of oLLama.
	ServerAddress string
}

Config provides configuration options for the Init function.

type EmbedOptions

type EmbedOptions struct {
	Model string `json:"model"`
}

type ModelDefinition

type ModelDefinition struct {
	Name string
	Type string
}

ModelDefinition represents a model with its name and type.