Documentation v1.0.0

---

Documentation / @openassistant/duckdb / localQuery

Variable: localQuery

const localQuery: OpenAssistantTool<LocalQueryArgs, LocalQueryResult["llmResult"], LocalQueryResult["additionalData"], LocalQueryContext>

Defined in: query-tool.ts:74

localQuery Tool

This tool is used to execute a query against a local dataset.

INFO

This tool should be executed in Browser environment for now.

Example

import { localQuery } from '@openassistant/duckdb';
import { convertToVercelAiTool } from '@openassistant/utils';
import { generateText } from 'ai';

const localQueryTool: LocalQueryTool = {
  ...localQuery,
  context: {
    ...localQuery.context,
    getValues: async (datasetName: string, variableName: string) => {
      // get the values of the variable from your dataset, e.g.
      return SAMPLE_DATASETS[datasetName].map((item) => item[variableName]);
    },
  },
};

generateText({
  model: 'gpt-4.1',
  prompt: 'What are the venues in San Francisco?',
  tools: {localQuery: convertToVercelAiTool(localQueryTool)},
});