schemas.config•13 kB
# This file holds configuration for the genkit-schema.json file
# generated by the npm export:schemas script.
# DocumentData type was hand-written.
DocumentData omit
# Map DocumentData to Document
DocumentData name Document
# Code generator cannot handle "allOf" schemas.
Part omit
# Map DocumentPart to Part
DocumentPart name Part
# Tracing types were written manually.
InstrumentationLibrary omit
Link omit
SpanContext omit
SpanData omit
SpanDataSameProcessAsParentSpan omit
SpanDataTimeEvents omit
SpanMetadata omit
SpanMetadataState omit
SpanStatus omit
TimeEvent omit
TimeEventAnnotation omit
TraceData omit
GenerationCommonConfig.maxOutputTokens type int
GenerationCommonConfig.topK type int
Role doc
Role indicates which entity is responsible for the content of a message.
.
RoleSystem doc
RoleSystem indicates this message is user-independent context.
.
RoleUser doc
RoleUser indicates this message was generated by the client.
.
RoleModel doc
RoleModel indicates this message was generated by the model during a previous interaction.
.
RoleTool doc
RoleTool indicates this message was generated by a local tool, likely triggered by a request
from the model in one of its previous responses.
.
ToolRequest.input doc
Input is a JSON object describing the input values to the tool.
An example might be map[string]any{"country":"USA", "president":3}.
.
ToolResponse.output doc
Output is a JSON object describing the results of running the tool.
An example might be map[string]any{"name":"Thomas Jefferson", "born":1743}.
.
ToolRequest doc
A ToolRequest is a message from the model to the client that it should run a
specific tool and pass a [ToolResponse] to the model on the next chat request it makes.
Any ToolRequest will correspond to some [ToolDefinition] previously sent by the client.
.
ToolResponse doc
A ToolResponse is a message from the client to the model containing
the results of running a specific tool on the arguments passed to the client
by the model in a [ToolRequest].
.
Candidate omit
DocumentData pkg ai
GenerateResponse omit
GenerateResponseChunk omit
GenerateRequest omit
GenerateRequestToolChoice omit
GenerationUsage pkg ai
GenerationUsage.inputCharacters type int
GenerationUsage.inputImages type int
GenerationUsage.inputAudioFiles type int
GenerationUsage.inputVideos type int
GenerationUsage.inputTokens type int
GenerationUsage.outputCharacters type int
GenerationUsage.outputImages type int
GenerationUsage.outputAudioFiles type int
GenerationUsage.outputVideos type int
GenerationUsage.outputTokens type int
GenerationUsage.totalTokens type int
GenerationUsage.thoughtsTokens type int
GenerationUsage.cachedContentTokens type int
GenerationUsage doc
GenerationUsage provides information about the generation process.
.
GenerationCommonConfig pkg ai
Message pkg ai
ToolDefinition pkg ai
ToolDefinition.inputSchema type map[string]any
ToolDefinition.outputSchema type map[string]any
Part pkg ai
TextPart pkg ai
TextPart name textPart
TextPart.data omit
TextPart.media omit
TextPart.toolRequest omit
TextPart.toolResponse omit
TextPart.custom omit
TextPart.metadata type map[string]any
TextPart.reasoning omit
TextPart.resource omit
MediaPart pkg ai
MediaPart name mediaPart
MediaPart.text omit
MediaPart.toolRequest omit
MediaPart.toolResponse omit
MediaPart.custom omit
MediaPart.data omit
MediaPart.metadata type map[string]any
MediaPart.reasoning omit
MediaPart.resource omit
ToolRequestPart pkg ai
ToolRequestPart name toolRequestPart
ToolRequestPart.text omit
ToolRequestPart.media omit
ToolRequestPart.data omit
ToolRequestPart.toolResponse omit
ToolRequestPart.custom omit
ToolRequestPart.metadata type map[string]any
ToolRequestPart.reasoning omit
ToolRequestPart.resource omit
ToolResponsePart pkg ai
ToolResponsePart name toolResponsePart
ToolResponsePart.text omit
ToolResponsePart.media omit
ToolResponsePart.data omit
ToolResponsePart.toolRequest omit
ToolResponsePart.custom omit
ToolResponsePart.metadata type map[string]any
ToolResponsePart.reasoning omit
ToolResponsePart.resource omit
DataPart pkg ai
DataPart name dataPart
DataPart.media omit
DataPart.text omit
DataPart.toolRequest omit
DataPart.toolResponse omit
DataPart.custom omit
DataPart.metadata type map[string]any
DataPart.reasoning omit
DataPart.resource omit
ReasoningPart pkg ai
ReasoningPart name reasoningPart
ReasoningPart.media omit
ReasoningPart.data omit
ReasoningPart.text omit
ReasoningPart.toolRequest omit
ReasoningPart.toolResponse omit
ReasoningPart.custom omit
ReasoningPart.metadata type map[string]any
ReasoningPart.resource omit
CustomPart pkg ai
CustomPart name customPart
ResourcePart pkg ai
ResourcePart name resourcePart
ResourcePart.text omit
ResourcePart.media omit
ResourcePart.toolRequest omit
ResourcePart.toolResponse omit
ResourcePart.custom omit
ResourcePart.data omit
ResourcePart.metadata type map[string]any
ResourcePart.reasoning omit
ResourcePart.resource type *ResourcePart
# Use the auto-generated ResourcePartResource type for consistency with schema
ResourcePartResource pkg ai
ResourcePartResource name ResourcePart
ModelInfo pkg ai
ModelInfoSupports pkg ai
ModelInfoSupports.output type []string
ModelInfoSupports name ModelSupports
ModelInfoSupportsConstrained name ConstrainedSupport
ModelInfoStage name ModelStage
Role pkg ai
RoleUser pkg ai
RoleModel pkg ai
RoleTool pkg ai
EvalResponse type []any
# GenerateActionOptions
GenerateActionOptions pkg ai
GenerateActionOptions.model type string
GenerateActionOptions.docs type []*Document
GenerateActionOptions.messages type []*Message
GenerateActionOptions.tools type []string
GenerateActionOptionsToolChoice name ToolChoice
GenerateActionOptions.config type any
GenerateActionOptions.output type *GenerateActionOutputConfig
GenerateActionOptions.returnToolRequests type bool
GenerateActionOptions.maxTurns type int
GenerateActionOptionsResume name GenerateActionResume
# GenerateActionOutputConfig
GenerateActionOutputConfig.instructions type *string
GenerateActionOutputConfig.format name OutputConfigFormat
GenerateActionOutputConfig.jsonSchema name Schema
GenerateActionOutputConfig.jsonSchema type map[string]any
GenerateActionOutputConfig.constrained type bool
BaseDataPoint.context type map[string]any
BaseDataPoint.input type map[string]any
BaseDataPoint.output type map[string]any
BaseDataPoint.reference type map[string]any
BaseDataPoint.traceIds type []string
BaseEvalDataPoint.context type map[string]any
BaseEvalDataPoint.input type map[string]any
BaseEvalDataPoint.output type map[string]any
BaseEvalDataPoint.reference type map[string]any
BaseEvalDataPoint.traceIds type []string
# ModelRequest
ModelRequest pkg ai
ModelRequest.config type any
ModelRequest.messages type []*Message
ModelRequest.output type *ModelOutputConfig
ModelRequest.tools type []*ToolDefinition
ModelRequest.toolChoice type ToolChoice
ModelRequest.docs type []*Document
OutputConfig name ModelOutputConfig
# ModelResponse
ModelResponse pkg ai
ModelResponse.custom type any
ModelResponse.finishMessage type string
ModelResponse.latencyMs type float64
ModelResponse.message type *Message
ModelResponse.request type *ModelRequest
ModelResponse.usage type *GenerationUsage
ModelResponse.raw omit
ModelResponse.operation omit
# ModelResponseChunk
ModelResponseChunk pkg ai
ModelResponseChunk.aggregated type bool
ModelResponseChunk.content type []*Part
ModelResponseChunk.custom type any
ModelResponseChunk.index type int
ModelResponseChunk.role type Role
GenerationCommonConfig doc
GenerationCommonConfig holds configuration for generation.
.
Message doc
Message is the contents of a model response.
.
ToolDefinition doc
A ToolDefinition describes a tool.
.
ModelRequest doc
A ModelRequest is a request to generate completions from a model.
.
ModelRequest.output doc
Output describes the desired response format.
.
ModelRequest.tools doc
Tools lists the available tools that the model can ask the client to run.
.
OutputConfig doc
OutputConfig describes the structure that the model's output
should conform to. If Format is [OutputFormatJSON], then Schema
can describe the desired form of the generated JSON.
.
ModelResponse doc
A ModelResponse is a model's response to a [ModelRequest].
.
ModelResponse.latencyMs doc
LatencyMs is the time the request took in milliseconds.
.
ModelResponse.request doc
Request is the [ModelRequest] struct used to trigger this response.
.
ModelResponse.usage doc
Usage describes how many resources were used by this generation request.
.
ModelResponseChunk doc
A ModelResponseChunk is the portion of the [ModelResponse]
that is passed to a streaming callback.
.
Score omit
Operation omit
OperationError omit
Embedding.embedding type []float32
GenkitError omit
GenkitErrorData omit
GenkitErrorDataGenkitErrorDetails omit