Skip to content

@sqlrooms/vega / createVegaChartTool

Function: createVegaChartTool()

createVegaChartTool(options): OpenAssistantTool<ZodObject<{ sqlQuery: ZodString; vegaLiteSpec: ZodString; reasoning: ZodString; }, $strip>, VegaChartToolLlmResult, VegaChartToolAdditionalData, unknown>

Creates a VegaLite chart visualization tool for AI assistants

Parameters

ParameterTypeDescription
options{ description: string; }Configuration options for the VegaChart tool
options.description?stringCustom description for the tool (defaults to a standard description)

Returns

OpenAssistantTool<ZodObject<{ sqlQuery: ZodString; vegaLiteSpec: ZodString; reasoning: ZodString; }, $strip>, VegaChartToolLlmResult, VegaChartToolAdditionalData, unknown>

A tool that can be used with the AI assistant