AI Components & Features

New to KendoReact? Start a free 30-day trial

GridToolbarAIAssistantProps

Interface

Represents the props interface for the GridToolbarAIAssistant component. This component provides AI-powered functionality for grid operations through natural language prompts. Users can request sorting, filtering, grouping, and highlighting through conversational input.

Definition

Package:@progress/kendo-react-grid

Syntax:

tsx

<Grid data={products}>
  <GridToolbar>
    <GridToolbarAIAssistant
      requestUrl="/api/ai/grid"
      promptPlaceHolder="Ask AI to sort, filter, or group your data"
      suggestionsList={[
        'Sort products by price',
        'Show only electronics',
        'Group by category'
      ]}
      onResponseSuccess={(response) => console.log('AI processed:', response)}
    />
  </GridToolbar>
</Grid>

Properties

enableSpeechToText?

boolean | SpeechToTextButtonProps

Enables the speech-to-text functionality for the input of the GridToolbarAIAssistant.

gridAIPrompt?

CustomComponent<GridAIPromptProps>

Customizes the AI prompt component.

httpClient?

GridAIHttpClient

Optional custom HTTP client for the AI assistant. When not provided, the component uses the built-in fetch-based transport.

icon?

string

Defines the icon rendered in the GridToolbarAIAssistant tool (see example).

loading?

boolean

Defines if the AI prompt is in loading mode.

onCloseWindow?

() => void

The method that will be called to close the column menu.

onPromptRequest?

(request: GridAIRequestData, isRetry: boolean) => void

Called before the request is sent.

Parameters:requestGridAIRequestDataisRetry?boolean

onResponseError?

(error: any) => void

Called when the response returns an error.

Parameters:errorany

onResponseSuccess?

(response: GridAIResponse<any>, promptMessage: string, isRetry: boolean) => void

Called when the response is received.

Parameters:responseGridAIResponse<any>promptMessage?stringisRetry?boolean

outputs?

AIPromptOutputInterface[]

Defines the outputs of the AI prompt.

promptPlaceHolder?

string

Defines the placeholder text for the AI prompt input.

requestOptions?

GridAIRequestConfig

Defines the options for the HTTP request. Accepts both the new GridAIRequestConfig and the legacy AxiosRequestConfig.

requestUrl?

string

Defines the URL to which the request will be sent.

role?

string

Defines the user role for the request. Defaults to 'user'.

show?

boolean

Specifies if the popup will be displayed.

streaming?

boolean

Defines if the AI prompt is in streaming mode.

suggestionsList?

string[]

Defines the list of suggestions for the AI prompt.

svgIcon?

SVGIcon

Defines the SVG icon rendered in the GridToolbarAIAssistant tool (see example).