googleai

Documentation

Index

• func DefineEmbedder(name string) *ai.Embedder
• func DefineModel(name string, caps *ai.ModelCapabilities) (*ai.Model, error)
• func Embedder(name string) *ai.Embedder
• func Init(ctx context.Context, cfg *Config) (err error)
• func IsKnownModel(name string) bool
• func KnownModels() []string
• func Model(name string) *ai.Model
• type Config

Functions

func DefineEmbedder

func DefineEmbedder(name string) *ai.Embedder

DefineEmbedder defines an embedder with a given name.

func DefineModel

func DefineModel(name string, caps *ai.ModelCapabilities) (*ai.Model, error)

DefineModel defines an unknown model with the given name. The second argument describes the capability of the model. Use IsKnownModel to determine if a model is known.

func Embedder

func Embedder(name string) *ai.Embedder

Embedder returns the ai.Embedder with the given name. It returns nil if the embedder was not configured.

func Init

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

Init initializes the plugin and all known models and embedders. After calling Init, you may call DefineModel and DefineEmbedder to create and register any additional generative models and embedders

func IsKnownModel

func IsKnownModel(name string) bool

IsKnownModel reports whether a model is known to this plugin.

func KnownModels

func KnownModels() []string

KnownModels returns a slice of all known model names.

func Model

func Model(name string) *ai.Model

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

Types

type Config

type Config struct {
	// The API key to access the service.
	// If empty, the values of the environment variables GOOGLE_GENAI_API_KEY
	// and GOOGLE_API_KEY will be consulted, in that order.
	APIKey string
	// Options to the Google AI client.
	ClientOptions []option.ClientOption
}

Config is the configuration for the plugin.