Function: boxplotTool()

boxplotTool(props): RegisterFunctionCallingProps

Defined in: packages/echarts/src/boxplot/definition.ts:157

This function creates a boxplot tool, which can be used to create a box plot using natural language prompts, e.g. "Create a box plot of the variable 'age'".

To use this tool, you need to provide the implementation of the getValues function. This function will be used to retrieve the values of the variable from the dataset. Note: the values are only used to create the box plot, and are not sent to the LLM.

For example:

const functions = [
  ...,
  boxplotTool({
    getValues: async (datasetName, variableName) => {
      // retrieve the values of the variable from the dataset
      return datasets[datasetName][variableName];
    },
  }),
];

You can also provide a custom React component to render the box plot. See BoxplotToolProps for more details.

The default definition of this boxplot tool is BoxplotFunction. You can override the default definition by providing the tool property.

Parameters

props

BoxplotToolProps

The properties of the boxplot tool. See BoxplotToolProps for more details.

Returns

RegisterFunctionCallingProps

The function definition.