ai

package

Go to main page

Versions in this module

v0

v0.5.4

May 13, 2025

Changes in this version

type GenerationUsage

+ CachedContentTokens int

+ ThoughtsTokens int

v0.5.3

May 1, 2025

v0.5.2

Apr 18, 2025

Changes in this version

+ const OutputFormatArray

+ const OutputFormatEnum

v0.5.1

Apr 9, 2025

Changes in this version

type Part

+ Custom map[string]any

+ func NewCustomPart(customData map[string]any) *Part

+ func (p *Part) IsCustom() bool

type PartKind

+ const PartCustom

v0.5.0

Apr 8, 2025

Changes in this version

+ const OutputFormatJSONL

+ var DEFAULT_FORMATS = []Formatter

+ func ConfigureFormats(reg *registry.Registry)

+ func DefineFormat(r *registry.Registry, name string, formatter Formatter)

+ type CommonGenOption interface

+ type ConfigOption interface

+ type DocumentOption interface

+ func WithTextDocs(text ...string) DocumentOption

type EmbedRequest

+ Input []*Document

+ type EmbedderOption interface

+ type EvaluatorOption interface

+ func WithDataset(examples ...*Example) EvaluatorOption

+ func WithID(ID string) EvaluatorOption

+ type FormatHandler interface

+ Config func() ModelOutputConfig

+ Instructions func() string

+ ParseMessage func(message *Message) (*Message, error)

+ type Formatter interface

+ Handler func(schema map[string]any) (FormatHandler, error)

+ Name func() string

+ type IndexerFunc = func(context.Context, *IndexerRequest) error

+ type MessagesFn = func(context.Context, any) ([]*Message, error)

+ type ModelArg interface

+ Name func() string

type ModelInfo

+ ConfigSchema map[string]any

+ type ModelRef struct

+ func NewModelRef(name string, config any) ModelRef

+ func (m ModelRef) Config() any

+ func (m ModelRef) Name() string

type ModelResponse

+ func (mr *ModelResponse) ToolRequests() ([]*ToolRequest, error)

type OutputOption

+ func WithCustomConstrainedOutput() OutputOption

+ func WithOutputInstructions(instructions string) OutputOption

+ type PromptExecuteOption interface

+ type PromptFn = func(context.Context, any) (string, error)

type PromptingOption

+ func WithPrompt(text string, args ...any) PromptingOption

+ func WithSystem(text string, args ...any) PromptingOption

+ type RetrieverFunc = func(context.Context, *RetrieverRequest) (*RetrieverResponse, error)

+ type RetrieverOption interface

v0.3.0

Mar 28, 2025

Changes in this version

+ func DefineGenerateAction(ctx context.Context, r *registry.Registry) *generateAction

+ func IsDefinedEvaluator(r *registry.Registry, provider, name string) bool

+ func LoadPromptDir(r *registry.Registry, dir string, namespace string) error

+ type AugmentWithContextOptions struct

+ CitationKey *string

+ ItemTemplate func(d Document, index int, options *AugmentWithContextOptions) string

+ Preface *string

+ type BaseDataPoint struct

+ Context map[string]any

+ Input map[string]any

+ Output map[string]any

+ Reference map[string]any

+ TestCaseID string

+ TraceIDs []string

+ type BaseEvalDataPoint struct

+ Context map[string]any

+ Input map[string]any

+ Output map[string]any

+ Reference map[string]any

+ TestCaseID string

+ TraceIDs []string

+ type CandidateError struct

+ Code CandidateErrorCode

+ Index float64

+ Message string

+ type CandidateErrorCode string

+ const CandidateErrorCodeBlocked

+ const CandidateErrorCodeOther

+ const CandidateErrorCodeUnknown

+ type CommonOption interface

+ func WithMaxTurns(maxTurns int) CommonOption

+ func WithMessagesFn(fn messagesFn) CommonOption

+ func WithMiddleware(middleware ...ModelMiddleware) CommonOption

+ func WithModel(model Model) CommonOption

+ func WithModelName(name string) CommonOption

+ func WithReturnToolRequests(returnReqs bool) CommonOption

+ func WithToolChoice(toolChoice ToolChoice) CommonOption

+ type CommonRerankerOptions struct

+ K float64

+ type CommonRetrieverOptions struct

+ K float64

+ type ConstrainedSupport string

+ const ConstrainedSupportAll

+ const ConstrainedSupportNoTools

+ const ConstrainedSupportNone

+ type Dataset = []Example

+ type DownloadMediaOptions struct

+ Filter func(part *Part) bool

+ MaxBytes int64

+ type Embedding struct

+ Embedding []float64

+ Metadata map[string]any

+ type EvalFnResponse struct

+ Evaluation any

+ SampleIndex float64

+ SpanID string

+ TestCaseID string

+ TraceID string

+ type EvalRequest struct

+ Dataset []*BaseDataPoint

+ EvalRunID string

+ Options any

+ type EvalResponse []any

+ type EvalStatusEnum string

+ const EvalStatusEnumFAIL

+ const EvalStatusEnumPASS

+ const EvalStatusEnumUNKNOWN

+ type EvaluateOption func(req *EvaluatorRequest) error

+ func WithEvaluateDataset(dataset *Dataset) EvaluateOption

+ func WithEvaluateId(evaluationId string) EvaluateOption

+ func WithEvaluateOptions(opts any) EvaluateOption

+ type EvaluationResult struct

+ Evaluation []Score

+ SpanID string

+ TestCaseId string

+ TraceID string

+ type Evaluator interface

+ Evaluate func(ctx context.Context, req *EvaluatorRequest) (*EvaluatorResponse, error)

+ Name func() string

+ func DefineBatchEvaluator(r *registry.Registry, provider, name string, options *EvaluatorOptions, ...) (Evaluator, error)

+ func DefineEvaluator(r *registry.Registry, provider, name string, options *EvaluatorOptions, ...) (Evaluator, error)

+ func LookupEvaluator(r *registry.Registry, provider, name string) Evaluator

+ type EvaluatorCallbackRequest struct

+ Input Example

+ Options any

+ type EvaluatorCallbackResponse = EvaluationResult

+ type EvaluatorOptions struct

+ Definition string

+ DisplayName string

+ IsBilled bool

+ type EvaluatorRequest struct

+ Dataset *Dataset

+ EvaluationId string

+ Options any

+ type EvaluatorResponse = []EvaluationResult

+ func Evaluate(ctx context.Context, r Evaluator, opts ...EvaluateOption) (*EvaluatorResponse, error)

+ type Example struct

+ Context []any

+ Input any

+ Output any

+ Reference any

+ TestCaseId string

+ TraceIds []string

+ type ExecutionOption interface

+ func WithDocs(docs ...*Document) ExecutionOption

type FinishReason

+ const FinishReasonInterrupted

+ type GenerateActionOptions struct

+ Config any

+ Docs []*Document

+ MaxTurns int

+ Messages []*Message

+ Model string

+ Output *GenerateActionOutputConfig

+ Resume *GenerateActionResume

+ ReturnToolRequests bool

+ ToolChoice ToolChoice

+ Tools []string

+ type GenerateActionOutputConfig struct

+ Constrained bool

+ ContentType string

+ Format string

+ Instructions string

+ JsonSchema map[string]any

+ type GenerateActionResume struct

+ Metadata map[string]any

+ Respond []*toolResponsePart

+ Restart []*toolRequestPart

type GenerationUsage

+ InputAudioFiles float64

+ InputVideos float64

+ OutputAudioFiles float64

+ OutputVideos float64

+ type GenkitError struct

+ Data *GenkitErrorData

+ Details any

+ Message string

+ Stack string

+ type GenkitErrorData struct

+ GenkitErrorDetails *GenkitErrorDetails

+ GenkitErrorMessage string

+ type GenkitErrorDetails struct

+ Stack string

+ TraceID string

+ type InterruptOptions struct

+ Metadata map[string]any

+ type Media struct

+ ContentType string

+ Url string

type Message

+ func NewUserMessageWithMetadata(metadata map[string]any, parts ...*Part) *Message

+ func (m *Message) Text() string

+ func (m *Message) WithCacheName(n string) *Message

+ func (m *Message) WithCacheTTL(ttlSeconds int) *Message

type Model

+ func LookupModelByName(r *registry.Registry, modelName string) (Model, error)

+ type ModelAction = core.ActionDef[*ModelRequest, *ModelResponse, *ModelResponseChunk]

+ type ModelFunc = core.StreamingFunc[*ModelRequest, *ModelResponse, *ModelResponseChunk]

type ModelInfo

+ Stage ModelStage

+ type ModelMiddleware = core.Middleware[*ModelRequest, *ModelResponse, *ModelResponseChunk]

+ func DownloadRequestMedia(options *DownloadMediaOptions) ModelMiddleware

+ type ModelOutputConfig struct

+ Constrained bool

+ ContentType string

+ Format string

+ Instructions string

+ Schema map[string]any

+ type ModelRequest struct

+ Config any

+ Docs []*Document

+ Messages []*Message

+ Output *ModelOutputConfig

+ ToolChoice ToolChoice

+ Tools []*ToolDefinition

+ func NewModelRequest(config any, messages ...*Message) *ModelRequest

+ type ModelResponse struct

+ Custom any

+ FinishMessage string

+ FinishReason FinishReason

+ LatencyMs float64

+ Message *Message

+ Request *ModelRequest

+ Usage *GenerationUsage

+ func GenerateWithRequest(ctx context.Context, r *registry.Registry, opts *GenerateActionOptions, ...) (*ModelResponse, error)

+ func (gr *ModelResponse) History() []*Message

+ func (gr *ModelResponse) Output(v any) error

+ func (gr *ModelResponse) Text() string

+ type ModelResponseChunk struct

+ Aggregated bool

+ Content []*Part

+ Custom any

+ Index int

+ Role Role

+ func (c *ModelResponseChunk) Text() string

+ type ModelStage string

+ const ModelStageDeprecated

+ const ModelStageFeatured

+ const ModelStageLegacy

+ const ModelStageStable

+ const ModelStageUnstable

+ type ModelStreamCallback = func(context.Context, *ModelResponseChunk) error

+ type ModelSupports struct

+ Constrained ConstrainedSupport

+ ContentType []string

+ Context bool

+ Media bool

+ Multiturn bool

+ Output []string

+ SystemRole bool

+ ToolChoice bool

+ Tools bool

+ type OutputOption interface

+ func WithOutputType(output any) OutputOption

type Part

+ Metadata map[string]any

+ func (p *Part) UnmarshalYAML(value *yaml.Node) error

+ type PathMetadata struct

+ Error string

+ Latency float64

+ Path string

+ Status string

type Prompt

+ func LoadPrompt(r *registry.Registry, dir, filename, namespace string) (*Prompt, error)

+ func (p *Prompt) Execute(ctx context.Context, opts ...PromptGenerateOption) (*ModelResponse, error)

+ func (p *Prompt) Name() string

+ type PromptGenerateOption interface

+ func WithInput(input any) PromptGenerateOption

+ type PromptOption interface

+ func WithDescription(description string) PromptOption

+ func WithInputType(input any) PromptOption

+ func WithMetadata(metadata map[string]any) PromptOption

+ type PromptingOption interface

+ func WithPromptFn(fn promptFn) PromptingOption

+ func WithPromptText(text string) PromptingOption

+ func WithSystemFn(fn promptFn) PromptingOption

+ func WithSystemText(text string) PromptingOption

+ type RankedDocumentData struct

+ Content []*Part

+ Metadata *RankedDocumentMetadata

+ type RankedDocumentMetadata struct

+ Score float64

+ type RerankerRequest struct

+ Documents []*Document

+ Options any

+ Query *Document

+ type RerankerResponse struct

+ Documents []*RankedDocumentData

type RetrieverRequest

+ Query *Document

+ type Score struct

+ Details map[string]any

+ Error string

+ Id string

+ Score any

+ Status string

+ type ScoreDetails struct

+ Reasoning string

+ type ScoreStatus int

+ const ScoreStatusFail

+ const ScoreStatusPass

+ const ScoreStatusUnknown

+ func (ss ScoreStatus) String() string

type Tool

+ Name func() string

+ type ToolChoice string

+ const ToolChoiceAuto

+ const ToolChoiceNone

+ const ToolChoiceRequired

+ type ToolConfig struct

+ MaxTurns int

+ ReturnToolRequests bool

+ type ToolContext struct

+ Interrupt func(opts *InterruptOptions) error

type ToolDef

+ func (ta *ToolDef[In, Out]) Name() string

type ToolDefinition

+ Metadata map[string]any

+ type ToolInterruptError struct

+ Metadata map[string]any

+ func (e *ToolInterruptError) Error() string

+ type ToolName string

+ func (t ToolName) Name() string

+ type ToolRef interface

+ Name func() string

type ToolRequest

+ Ref string

type ToolResponse

+ Ref string

+ type TraceMetadata struct

+ FeatureName string

+ Paths []*PathMetadata

+ Timestamp float64

v0.2.1

Nov 21, 2024

v0.2.0

Nov 20, 2024

v0.1.4

Nov 20, 2024

retracted

v0.1.3

Nov 19, 2024

retracted

v0.1.2

Oct 30, 2024

v0.1.1

Aug 22, 2024

v0.1.0

Aug 1, 2024

Changes in this version

+ func GenerateText(ctx context.Context, m Model, opts ...GenerateOption) (string, error)

+ func Index(ctx context.Context, r Indexer, opts ...IndexerOption) error

+ func IsDefinedEmbedder(provider, name string) bool

+ func IsDefinedIndexer(provider, name string) bool

+ func IsDefinedModel(provider, name string) bool

+ func IsDefinedPrompt(provider, name string) bool

+ func IsDefinedRetriever(provider, name string) bool

+ type EmbedOption func(req *EmbedRequest) error

+ func WithEmbedDocs(docs ...*Document) EmbedOption

+ func WithEmbedOptions(opts any) EmbedOption

+ func WithEmbedText(text ...string) EmbedOption

type EmbedResponse

+ func Embed(ctx context.Context, e Embedder, opts ...EmbedOption) (*EmbedResponse, error)

type Embedder

+ Name func() string

+ type GenerateOption func(req *generateParams) error

+ func WithCandidates(c int) GenerateOption

+ func WithConfig(config any) GenerateOption

+ func WithContext(c ...any) GenerateOption

+ func WithHistory(history ...*Message) GenerateOption

+ func WithMessages(messages ...*Message) GenerateOption

+ func WithOutputFormat(format OutputFormat) GenerateOption

+ func WithOutputSchema(schema any) GenerateOption

+ func WithStreaming(cb ModelStreamingCallback) GenerateOption

+ func WithSystemPrompt(prompt string) GenerateOption

+ func WithTextPrompt(prompt string) GenerateOption

+ func WithTools(tools ...Tool) GenerateOption

type GenerateResponse

+ func Generate(ctx context.Context, m Model, opts ...GenerateOption) (*GenerateResponse, error)

+ func GenerateData(ctx context.Context, m Model, value any, opts ...GenerateOption) (*GenerateResponse, error)

+ func (gr *GenerateResponse) History() []*Message

+ func (gr *GenerateResponse) UnmarshalOutput(v any) error

+ type IndexerOption func(req *IndexerRequest) error

+ func WithIndexerDocs(docs ...*Document) IndexerOption

+ func WithIndexerOpts(opts any) IndexerOption

type Model

+ Name func() string

+ type RetrieveOption func(req *RetrieverRequest) error

+ func WithRetrieverDoc(doc *Document) RetrieveOption

+ func WithRetrieverOpts(opts any) RetrieveOption

+ func WithRetrieverText(text string) RetrieveOption

type RetrieverResponse

+ func Retrieve(ctx context.Context, r Retriever, opts ...RetrieveOption) (*RetrieverResponse, error)

type Tool

+ func LookupTool(name string) Tool

+ Action func() action.Action

+ RunRaw func(ctx context.Context, input map[string]any) (any, error)

+ type ToolDef struct

+ func (ta *ToolDef[In, Out]) Action() action.Action

+ func (ta *ToolDef[In, Out]) Definition() *ToolDefinition

+ func (ta *ToolDef[In, Out]) RunRaw(ctx context.Context, input map[string]any) (any, error)

v0.0.2

Jul 12, 2024

Changes in this version

+ type DocumentEmbedding struct

+ Embedding []float32

type EmbedRequest

+ Documents []*Document

+ type EmbedResponse struct

+ Embeddings []*DocumentEmbedding

v0.0.1

Jul 1, 2024

Changes in this version

+ func DefineTool(definition *ToolDefinition, metadata map[string]any, ...)

+ func RunTool(ctx context.Context, name string, input map[string]any) (map[string]any, error)

+ type Candidate struct

+ Custom any

+ FinishMessage string

+ FinishReason FinishReason

+ Index int

+ Message *Message

+ Usage *GenerationUsage

+ func (c *Candidate) Text() (string, error)

+ type Document struct

+ Content []*Part

+ Metadata map[string]any

+ func DocumentFromText(text string, metadata map[string]any) *Document

+ type EmbedRequest struct

+ Document *Document

+ Options any

+ type Embedder core.Action[*EmbedRequest, []float32, struct{}]

+ func DefineEmbedder(provider, name string, ...) *Embedder

+ func LookupEmbedder(provider, name string) *Embedder

+ func (e *Embedder) Embed(ctx context.Context, req *EmbedRequest) ([]float32, error)

+ type FinishReason string

+ const FinishReasonBlocked

+ const FinishReasonLength

+ const FinishReasonOther

+ const FinishReasonStop

+ const FinishReasonUnknown

+ type GenerateRequest struct

+ Candidates int

+ Config any

+ Context []any

+ Messages []*Message

+ Output *GenerateRequestOutput

+ Tools []*ToolDefinition

+ func NewGenerateRequest(config any, messages ...*Message) *GenerateRequest

+ type GenerateRequestOutput struct

+ Format OutputFormat

+ Schema map[string]any

+ type GenerateResponse struct

+ Candidates []*Candidate

+ Custom any

+ LatencyMs float64

+ Request *GenerateRequest

+ Usage *GenerationUsage

+ func (gr *GenerateResponse) Text() (string, error)

+ type GenerateResponseChunk struct

+ Content []*Part

+ Custom any

+ Index int

+ func (c *GenerateResponseChunk) Text() (string, error)

+ type GenerationCommonConfig struct

+ MaxOutputTokens int

+ StopSequences []string

+ Temperature float64

+ TopK int

+ TopP float64

+ Version string

+ type GenerationUsage struct

+ Custom map[string]float64

+ InputCharacters int

+ InputImages int

+ InputTokens int

+ OutputCharacters int

+ OutputImages int

+ OutputTokens int

+ TotalTokens int

+ type Indexer core.Action[*IndexerRequest, struct{}, struct{}]

+ func DefineIndexer(provider, name string, index func(context.Context, *IndexerRequest) error) *Indexer

+ func LookupIndexer(provider, name string) *Indexer

+ func (i *Indexer) Index(ctx context.Context, req *IndexerRequest) error

+ func (i *Indexer) Name() string

+ type IndexerRequest struct

+ Documents []*Document

+ Options any

+ type Message struct

+ Content []*Part

+ Metadata map[string]any

+ Role Role

+ func NewMessage(role Role, metadata map[string]any, parts ...*Part) *Message

+ func NewModelMessage(parts ...*Part) *Message

+ func NewModelTextMessage(text string) *Message

+ func NewSystemMessage(parts ...*Part) *Message

+ func NewSystemTextMessage(text string) *Message

+ func NewTextMessage(role Role, text string) *Message

+ func NewUserMessage(parts ...*Part) *Message

+ func NewUserTextMessage(text string) *Message

+ type Model core.Action[*GenerateRequest, *GenerateResponse, *GenerateResponseChunk]

+ func DefineModel(provider, name string, metadata *ModelMetadata, ...) *Model

+ func LookupModel(provider, name string) *Model

+ func (m *Model) Generate(ctx context.Context, req *GenerateRequest, cb ModelStreamingCallback) (*GenerateResponse, error)

+ type ModelCapabilities struct

+ Media bool

+ Multiturn bool

+ SystemRole bool

+ Tools bool

+ type ModelInfo struct

+ Label string

+ Supports *ModelInfoSupports

+ Versions []string

+ type ModelInfoSupports struct

+ Context bool

+ Media bool

+ Multiturn bool

+ Output OutputFormat

+ SystemRole bool

+ Tools bool

+ type ModelMetadata struct

+ Label string

+ Supports ModelCapabilities

+ type ModelStreamingCallback = func(context.Context, *GenerateResponseChunk) error

+ type OutputFormat string

+ const OutputFormatJSON

+ const OutputFormatMedia

+ const OutputFormatText

+ type Part struct

+ ContentType string

+ Kind PartKind

+ Text string

+ ToolRequest *ToolRequest

+ ToolResponse *ToolResponse

+ func NewDataPart(contents string) *Part

+ func NewJSONPart(text string) *Part

+ func NewMediaPart(mimeType, contents string) *Part

+ func NewTextPart(text string) *Part

+ func NewToolRequestPart(r *ToolRequest) *Part

+ func NewToolResponsePart(r *ToolResponse) *Part

+ func (Part) JSONSchemaAlias() any

+ func (p *Part) IsData() bool

+ func (p *Part) IsMedia() bool

+ func (p *Part) IsText() bool

+ func (p *Part) IsToolRequest() bool

+ func (p *Part) IsToolResponse() bool

+ func (p *Part) MarshalJSON() ([]byte, error)

+ func (p *Part) UnmarshalJSON(b []byte) error

+ type PartKind int8

+ const PartData

+ const PartMedia

+ const PartText

+ const PartToolRequest

+ const PartToolResponse

+ type Prompt core.Action[any, *GenerateRequest, struct{}]

+ func DefinePrompt(provider, name string, metadata map[string]any, inputSchema *jsonschema.Schema, ...) *Prompt

+ func LookupPrompt(provider, name string) *Prompt

+ func (p *Prompt) Render(ctx context.Context, input any) (*GenerateRequest, error)

+ type Retriever core.Action[*RetrieverRequest, *RetrieverResponse, struct{}]

+ func DefineRetriever(provider, name string, ...) *Retriever

+ func LookupRetriever(provider, name string) *Retriever

+ func (r *Retriever) Name() string

+ func (r *Retriever) Retrieve(ctx context.Context, req *RetrieverRequest) (*RetrieverResponse, error)

+ type RetrieverRequest struct

+ Document *Document

+ Options any

+ type RetrieverResponse struct

+ Documents []*Document

+ type Role string

+ const RoleModel

+ const RoleSystem

+ const RoleTool

+ const RoleUser

+ type Tool struct

+ Definition *ToolDefinition

+ Fn func(context.Context, map[string]any) (map[string]any, error)

+ type ToolDefinition struct

+ Description string

+ InputSchema map[string]any

+ Name string

+ OutputSchema map[string]any

+ type ToolRequest struct

+ Input map[string]any

+ Name string

+ type ToolResponse struct

+ Name string

+ Output map[string]any

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL