vertexai

Documentation

Index

• func Embedder(name string) *ai.EmbedderAction
• func Init(ctx context.Context, cfg Config) (err error)
• func Model(name string) *ai.ModelAction
• type Config
• type EmbedOptions

Functions

func Embedder

func Embedder(name string) *ai.EmbedderAction

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

func Init

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

func Model

func Model(name string) *ai.ModelAction

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 project holding the resources.
	ProjectID string
	// The location of the resources.
	// Defaults to "us-central1".
	Location string
	// Generative models to provide.
	Models []string
	// Embedding models to provide.
	Embedders []string
}

Config provides configuration options for the Init function.

type EmbedOptions

type EmbedOptions struct {
	// Document title.
	Title string `json:"title,omitempty"`
	// Task type: RETRIEVAL_QUERY, RETRIEVAL_DOCUMENT, and so forth.
	// See the Vertex AI text embedding docs.
	TaskType string `json:"task_type,omitempty"`
}

EmbedOptions are options for the Vertex AI embedder. Set ai.EmbedRequest.Options to a value of type *EmbedOptions.