Grids: Add AI Columns How-To #8217
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive "How-To" documentation for AI Columns in the DataGrid component. The documentation introduces a new feature that allows developers to augment grid data with AI-generated insights.
Key Changes:
- Introduces AI Columns as a new column type for DataGrid
- Provides step-by-step instructions for implementing AI columns
- Documents how to optimize AI resource usage by limiting data in requests
- Lists limitations and ignored properties for AI columns
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| concepts/05 UI Components/DataGrid/15 Columns/10 Column Types/5 AI Columns/00 AI Columns.md | Overview document explaining that AI columns augment grid data with AI-generated insights and are a type of command column |
| concepts/05 UI Components/DataGrid/15 Columns/10 Column Types/5 AI Columns/05 Add an AI Column.md | Step-by-step guide for adding AI columns to DataGrid, including configuration requirements (contains bug with empty link references) |
| concepts/05 UI Components/DataGrid/15 Columns/10 Column Types/5 AI Columns/10 Limit Data Passed to the AI Service.md | Instructions for optimizing AI resource usage by filtering data sent to AI services, with code examples for all supported frameworks |
| concepts/05 UI Components/DataGrid/15 Columns/10 Column Types/5 AI Columns/15 AI Column Limitations.md | Comprehensive reference listing AI column limitations and properties that AI columns ignore |
Note: I was unable to create inline comments on the files as they were not accessible in the PR context. However, I identified one critical bug in the file "05 Add an AI Column.md" at line 5, where the [type]() and [name]() links have empty URL references and need to be completed with proper API documentation links.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated no new comments.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.
| @@ -0,0 +1,5 @@ | |||
| To add an AI column to {WidgetName}, follow these steps: | |||
|
|
|||
| - Specify [keyExpr](/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/#keyExpr) or implement key fields within the component [dataSource](/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/#dataSource) (for instance, **ArrayStore**.[key](/Documentation/ApiReference/Data_Layer/ArrayStore/Configuration/#key)). | |||
There was a problem hiding this comment.
Strictly speaking it is not a step but a requirement. I'd show it this way or, for example, by a note
| Note the following AI column limitations: | ||
|
|
||
| - AI columns cannot be integrated within [band columns](/Documentation/Guide/UI_Components/DataGrid/Columns/Column_Types/Band_Columns/). | ||
| - If {WidgetName} hides an AI column, users cannot access the [AI header menu](/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/ai/#showHeaderMenu) to regenerate data or update the prompt. |
There was a problem hiding this comment.
I think we can get rid of this limitation because it is the obvious default design of the functionally
If you think that this piece of information worths sharing we can add it somewhere where we describe AI column UI and behavior and not as s limitation but more like a description. That AI Column menu is available only for visible columns.
There was a problem hiding this comment.
Okay, I have already added this info in the columnHidingEnabled docs, so we can eliminate it from here.
|
|
||
| - AI columns cannot be integrated within [band columns](/Documentation/Guide/UI_Components/DataGrid/Columns/Column_Types/Band_Columns/). | ||
| - If {WidgetName} hides an AI column, users cannot access the [AI header menu](/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/ai/#showHeaderMenu) to regenerate data or update the prompt. | ||
| - {WidgetName} does not support AI data editing, filtering, searching, and sorting. |
|
|
||
| - Specify [keyExpr](/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/#keyExpr) or implement key fields within the component [dataSource](/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/#dataSource) (for instance, **ArrayStore**.[key](/Documentation/ApiReference/Data_Layer/ArrayStore/Configuration/#key)). | ||
| - Define [aiIntegration](/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/#aiIntegration) (or **columns[]**.**ai**.[aiIntegration](/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/ai/#aiIntegration) to configure AI settings specific to a column). | ||
| - Set a column's [type](/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/#type) to *"ai"* and specify this column's [name](/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/#name). |
There was a problem hiding this comment.
In the demo description we give 4 steps: one more for options
Let's be consistent everywhere
https://github.com/DevExpress/DevExtreme/pull/31830/files#diff-c3dd15da0486075801d69278a9659b829f79a0069fc4cc171e6a5002027a480dR10
| @@ -0,0 +1,76 @@ | |||
| The default {WidgetName} behavior is to add all visible row data in AI requests, including data not bound to a column and data of hidden columns. To save AI resources, you can configure the component to include only relevant data. Modify the **AIColumnRequestCreatingEvent**.[data](/Documentation/25_2/ApiReference/UI_Components/dxDataGrid/Types/AIColumnRequestCreatingEvent/#data) parameter within [onAIColumnRequestCreating](/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/#onAIColumnRequestCreating) as follows: | |||
There was a problem hiding this comment.
I'm not sure if this phrase is easy to understand
My suggestions is
By default, an AI request includes data from all visible rows. For each row, the request contains the data of every data-source column including visually hidden columns and columns that were not defined in the
columns[]array (data-source columns that are not bound to any column).
There was a problem hiding this comment.
Copilot reviewed 4 out of 4 changed files in this pull request and generated no new comments.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.
3 participants
No description provided.