Skip to content

@sqlrooms/vega / createVegaChartTool

Function: createVegaChartTool()

createVegaChartTool(options): Tool<{ sqlQuery: string; vegaLiteSpec: string; reasoning: string; }, { error?: undefined; success: boolean; details: string; sqlQuery: string; vegaLiteSpec: null; } | { error?: undefined; success: boolean; details: string; sqlQuery: string; vegaLiteSpec: TopLevelSpec; } | { success: boolean; details: string; error: string; sqlQuery: string; vegaLiteSpec: null; }>

Creates a VegaLite chart visualization tool for AI assistants

Parameters

ParameterTypeDescription
optionsVegaChartToolOptionsConfiguration options for the VegaChart tool

Returns

Tool<{ sqlQuery: string; vegaLiteSpec: string; reasoning: string; }, { error?: undefined; success: boolean; details: string; sqlQuery: string; vegaLiteSpec: null; } | { error?: undefined; success: boolean; details: string; sqlQuery: string; vegaLiteSpec: TopLevelSpec; } | { success: boolean; details: string; error: string; sqlQuery: string; vegaLiteSpec: null; }>

A tool that can be used with the AI assistant