New to KendoReact? Start a free 30-day trial

buildGenerationPrompt

Function

Definition

Package:@progress/kendo-react-datainsights-composer

Builds the system prompt for a generate/refine call. When allowedComponentTypes names exactly one type (e.g. after selectComponentsAsync routing), the other two component shapes/docs/rules are omitted entirely, trimming the prompt's fixed instruction text.

Parameters:fieldsFieldDescriptor[]

The fields of the dataset.

currentConfigsundefined | DatAInsightsConfig[]

The configurations being refined. Omit them to generate a new visualization.

options?Pick<DatAInsightsComposerAIRequestOptions, "allowComponentTypeChangeOnRefine" | "allowedComponentTypes" | "datasetDescription" | "omitConfigProperties">

The request options that the component passes to the AI client. Forward the options argument of the AI client method to build a prompt that matches the request.

Returns:

string