UseGridAIRequestOptions

Updated on Feb 6, 2026

Options for the useGridAIRequest hook.

Name	Type	Default	Description
columns?	{ field: string; id?: string; values?: any[]; }[]		The columns to include in the request.
gridRef?	"null" | Pick<GridHandle>		Reference to grid methods.
gridState?	GridAIState		The current grid state.
onExportPdf?	() => void		Callback fired when PDF export is requested.
onMessages?	(messages: string[], promptMessage?: string, isRetry?: boolean) => void		Callback fired when messages are received from AI.
onPromptRequest?	(request: GridAIRequestData, isRetry?: boolean) => void		Callback fired before the request is sent.
onResponseError?	(error: any) => void		Callback fired when the response returns an error.
onResponseSuccess?	(response: AxiosResponse<any>, promptMessage?: string, isRetry?: boolean) => void		Callback fired when the response is received successfully.
onStateChange?	(newState: GridAIState) => void		Callback fired when the grid state should be updated.
requestOptions?	AxiosRequestConfig<any>		Additional axios request options.
requestUrl?	string		The URL to send the AI request to.
role?	string		The role for the AI request. Defaults to 'user'.