Grids AI Column Demos: Add Descriptions #31830
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,22 @@ | ||||||||||
| DevExtreme DataGrid allows you to create one or multiple AI columns. These columns generate meaningful cell values based on component data and a custom prompt, transforming DevExtreme DataGrid into an AI-augmented data exploration tool. In this demo, an AI column is fixed on the right side of the component. | ||||||||||
|
|
||||||||||
| <!--split--> | ||||||||||
|
|
||||||||||
| [note] | ||||||||||
|
|
||||||||||
| AI services used for this demo have been rate and data limited. As such, you may experience performance-related delays when exploring the capabilities of DataGrid AI Columns. | ||||||||||
|
|
||||||||||
| When connected to your own AI model/service without rate and data limits, DataGrid AI Columns will perform seamlessly, without artificial delays. Note that DevExtreme does not offer an AI REST API and does not ship any built-in LLMs/SLMs. | ||||||||||
|
|
||||||||||
| [/note] | ||||||||||
|
|
||||||||||
| This demo implements a prompt that instructs AI to identify the origin country of each car. You can modify the default prompt or enter a custom prompt in the AI column header menu. | ||||||||||
|
There was a problem hiding this comment. For consistency with the TreeList description (line 13), consider adding "default" before "prompt": "This demo implements a default prompt that instructs AI..."
Suggested change
There was a problem hiding this comment. Inconsistent sentence structure between DataGrid and TreeList descriptions. DataGrid uses a single sentence with a relative clause ("a prompt that instructs"), while TreeList uses two sentences ("a default prompt... This prompt instructs"). Consider using consistent structure across both descriptions.
Suggested change
There was a problem hiding this comment. Missing article "the" before "AI column header menu". Should be "in the AI column header menu" for grammatical correctness. |
||||||||||
|
|
||||||||||
| To integrate an AI column into your DevExtreme DataGrid, you must: | ||||||||||
|
There was a problem hiding this comment. Inconsistent phrasing between DataGrid and TreeList descriptions. DataGrid uses "you must:" while TreeList uses "do the following:". Consider standardizing to one format across both demos for consistency.
Suggested change
|
||||||||||
|
|
||||||||||
| - Configure the **aiIntegration** property at the component or column level ([aiIntegration](/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/#aiIntegration) or **columns[]**.**ai**.[aiIntegration](/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/ai/#aiIntegration)). | ||||||||||
| - Set the column [type](/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/#type) to *"ai"*. | ||||||||||
| - Specify the column [name](/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/#name). | ||||||||||
|
There was a problem hiding this comment. Inconsistent possessive usage. TreeList description uses "column's" (line 19) while DataGrid uses "column" without the possessive. Consider standardizing to match: either "Specify the column [name]" or "Specify the column's [name]" in both files.
Suggested change
|
||||||||||
| - Configure **columns[]**.**ai** options, such as generation [mode](/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/ai/#mode), predefined [prompt](/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/ai/#prompt), and [no data text](/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/ai/#noDataText) (displayed when the AI service returns no data for a row). | ||||||||||
|
There was a problem hiding this comment. Inconsistent phrasing between DataGrid and TreeList. DataGrid uses "such as generation" while TreeList uses "including the generation". Consider standardizing the phrasing across both descriptions.
Suggested change
|
||||||||||
|
|
||||||||||
| Our DevExtreme DataGrid component uses all visible row data in AI requests, including unbound and hidden column fields. This data gives LLMs broader context, but increases the component use of AI resources. To limit data included in AI requests, modify the **AIColumnRequestCreatingEvent**.[data](/Documentation/ApiReference/UI_Components/dxDataGrid/Types/AIColumnRequestCreatingEvent/#data) parameter in the [onAIColumnRequestCreating](/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/#onAIColumnRequestCreating) event handler. | ||||||||||
|
There was a problem hiding this comment. The description of the data limiting feature is inconsistent with the TreeList demo description. The TreeList version mentions "This demo also configures the onAIColumnRequestCreating handler to limit data" and explains the default behavior more clearly. Consider rephrasing to: "This demo also configures the [onAIColumnRequestCreating]... handler to limit data included in AI requests. The default DataGrid behavior is to include all data from visible rows in AI requests, including data not bound to a column and data of hidden columns. This gives LLMs broader context, but increases the component's use of AI resources."
Suggested change
Contributor
There was a problem hiding this comment. How about just |
||||||||||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,22 @@ | ||||||
| DevExtreme TreeList allows you to create one or multiple AI columns. These columns generate meaningful cell values based on component data and a custom prompt, transforming DevExtreme TreeList into an AI-augmented data exploration tool. In this demo, an AI column is fixed on the right side of the component. | ||||||
|
|
||||||
| <!--split--> | ||||||
|
|
||||||
| [note] | ||||||
|
|
||||||
| AI services used for this demo have been rate and data limited. As such, you may experience performance-related delays when exploring the capabilities of TreeList AI Columns. | ||||||
|
There was a problem hiding this comment. The phrase "rate and data limited" should use hyphens to form proper compound adjectives: "rate-limited and data-limited". When multiple words function together as an adjective before a noun or verb, they should be hyphenated. This matches the style already used in "performance-related" and "AI-powered" elsewhere in the document.
Suggested change
|
||||||
|
|
||||||
| When connected to your own AI model/service without rate and data limits, TreeList AI Columns will perform seamlessly, without artificial delays. Note that DevExtreme does not offer an AI REST API and does not ship any built-in LLMs/SLMs. | ||||||
|
|
||||||
| [/note] | ||||||
|
|
||||||
| This demo implements a prompt that instructs AI to identify the department of each employee. You can modify the default prompt or enter a custom prompt in the AI column's header menu. | ||||||
|
There was a problem hiding this comment. Inconsistent possessive usage. TreeList uses "AI column's header menu" while DataGrid uses "AI column header menu". Consider standardizing to one format across both descriptions.
Suggested change
|
||||||
|
|
||||||
| To integrate an AI column into your DevExtreme TreeList, you must: | ||||||
|
|
||||||
| - Configure the **aiIntegration** property at the component or column level ([aiIntegration](/Documentation/ApiReference/UI_Components/dxTreeList/Configuration/#aiIntegration) or **columns[]**.**ai**.[aiIntegration](/Documentation/ApiReference/UI_Components/dxTreeList/Configuration/columns/ai/#aiIntegration)). | ||||||
| - Set the column [type](/Documentation/ApiReference/UI_Components/dxTreeList/Configuration/columns/#type) to *"ai"*. | ||||||
| - Specify the column [name](/Documentation/ApiReference/UI_Components/dxTreeList/Configuration/columns/#name). | ||||||
| - Configure **columns[]**.**ai** options, such as generation [mode](/Documentation/ApiReference/UI_Components/dxTreeList/Configuration/columns/ai/#mode), predefined [prompt](/Documentation/ApiReference/UI_Components/dxTreeList/Configuration/columns/ai/#prompt), and [no data text](/Documentation/ApiReference/UI_Components/dxTreeList/Configuration/columns/ai/#noDataText) (displayed when the AI service returns no data for a row). | ||||||
|
|
||||||
| Our DevExtreme TreeList component uses all visible row data in AI requests, including unbound and hidden column fields. This data gives LLMs broader context, but increases the component use of AI resources. To limit data included in AI requests, modify the **AIColumnRequestCreatingEvent**.[data](/Documentation/ApiReference/UI_Components/dxTreeList/Types/AIColumnRequestCreatingEvent/#data) parameter in the [onAIColumnRequestCreating](/Documentation/ApiReference/UI_Components/dxTreeList/Configuration/#onAIColumnRequestCreating) event handler. | ||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The phrase "rate and data limited" should use hyphens to form proper compound adjectives: "rate-limited and data-limited". When multiple words function together as an adjective before a noun or verb, they should be hyphenated. This matches the style already used in "performance-related" and "AI-powered" elsewhere in the document.