Documentation v1.0.0

---

Documentation / @openassistant/plots / scatterplot

Variable: scatterplot

const scatterplot: OpenAssistantTool<ScatterplotFunctionArgs, ScatterplotLlmResult, ScatterplotAdditionalData, EChartsToolContext>

Defined in: echarts/scatterplot/tool.ts:59

The scatterplot tool is used to create a scatterplot chart for a given dataset and variables.

Example user prompts:

• "Can you create a scatter plot of the population and income for each location in dataset myVenues?"
• "What is the relationship between population and income?"
• "Can you show a scatter plot of the population and income for each location in dataset myVenues?"

Example

import { scatterplot, ScatterplotTool } from '@openassistant/plots';
import { convertToVercelAiTool } from '@openassistant/utils';
import { generateText } from 'ai';

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

const onToolCompleted = (toolCallId: string, additionalData?: unknown) => {
  console.log('Tool call completed:', toolCallId, additionalData);
  // render the scatterplot using <ScatterplotComponentContainer props={additionalData} />
};

const scatterplotTool: ScatterplotTool = {
  ...scatterplot,
  context: toolContext,
  onToolCompleted,
};

generateText({
  model: openai('gpt-4.1', { apiKey: key }),
  prompt: 'What is the relationship between population and income?',
  tools: {scatterplot: convertToVercelAiTool(scatterplotTool)},
});

getValues()

See ScatterplotToolContext for detailed usage.

User implements this function to get the values of the variables from dataset.

For prompts like "can you show a scatter plot of the population and income for each location in dataset myVenues", the tool will call the getValues() function twice:

• get the values of population from dataset: getValues('myVenues', 'population')
• get the values of income from dataset: getValues('myVenues', 'income')