Documentation
¶
Index ¶
- func GoogleAIEmbedder(g *genkit.Genkit, name string) ai.Embedder
- func GoogleAIModel(g *genkit.Genkit, name string) ai.Model
- func VertexAIEmbedder(g *genkit.Genkit, name string) ai.Embedder
- func VertexAIModel(g *genkit.Genkit, name string) ai.Model
- type GoogleAI
- func (ga *GoogleAI) DefineEmbedder(g *genkit.Genkit, name string) (ai.Embedder, error)
- func (ga *GoogleAI) DefineModel(g *genkit.Genkit, name string, info *ai.ModelInfo) (ai.Model, error)
- func (ga *GoogleAI) Init(ctx context.Context, g *genkit.Genkit) (err error)
- func (ga *GoogleAI) IsDefinedEmbedder(g *genkit.Genkit, name string) bool
- func (ga *GoogleAI) Name() string
- type VertexAI
- func (v *VertexAI) DefineEmbedder(g *genkit.Genkit, name string) (ai.Embedder, error)
- func (v *VertexAI) DefineModel(g *genkit.Genkit, name string, info *ai.ModelInfo) (ai.Model, error)
- func (v *VertexAI) Init(ctx context.Context, g *genkit.Genkit) (err error)
- func (v *VertexAI) IsDefinedEmbedder(g *genkit.Genkit, name string) bool
- func (v *VertexAI) Name() string
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GoogleAIEmbedder ¶
GoogleAIEmbedder returns the ai.Embedder with the given name. It returns nil if the embedder was not defined.
func GoogleAIModel ¶
GoogleAIModel returns the ai.Model with the given name. It returns nil if the model was not defined.
func VertexAIEmbedder ¶
VertexAIEmbedder returns the ai.Embedder with the given name. It returns nil if the embedder was not defined.
Types ¶
type GoogleAI ¶
type GoogleAI struct {
APIKey string // API key to access the service. If empty, the values of the environment variables GEMINI_API_KEY or GOOGLE_API_KEY will be consulted, in that order.
// contains filtered or unexported fields
}
GoogleAI is a Genkit plugin for interacting with the Google AI service.
func (*GoogleAI) DefineEmbedder ¶
DefineEmbedder defines an embedder with a given name.
func (*GoogleAI) DefineModel ¶
func (ga *GoogleAI) DefineModel(g *genkit.Genkit, name string, info *ai.ModelInfo) (ai.Model, error)
DefineModel defines an unknown model with the given name. The second argument describes the capability of the model. Use [IsDefinedModel] to determine if a model is already defined. After [Init] is called, only the known models are defined.
func (*GoogleAI) Init ¶
Init initializes the Google AI 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 (*GoogleAI) IsDefinedEmbedder ¶
IsDefinedEmbedder reports whether the named [Embedder] is defined by this plugin.
type VertexAI ¶
type VertexAI struct {
ProjectID string // Google Cloud project to use for Vertex AI. If empty, the value of the environment variable GOOGLE_CLOUD_PROJECT will be consulted.
Location string // Location of the Vertex AI service. If empty, GOOGLE_CLOUD_LOCATION and GOOGLE_CLOUD_REGION environment variables will be consulted, in that order.
// contains filtered or unexported fields
}
VertexAI is a Genkit plugin for interacting with the Google Vertex AI service.
func (*VertexAI) DefineEmbedder ¶
DefineEmbedder defines an embedder with a given name.
func (*VertexAI) DefineModel ¶
DefineModel defines an unknown model with the given name. The second argument describes the capability of the model. Use [IsDefinedModel] to determine if a model is already defined. After [Init] is called, only the known models are defined.
func (*VertexAI) Init ¶
Init initializes the VertexAI 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 (*VertexAI) IsDefinedEmbedder ¶
IsDefinedEmbedder reports whether the named [Embedder] is defined by this plugin.
Source Files