Grids AI Assistant: Add API Descriptions Part 2#8767
Open
arman-boyakhchyan wants to merge 5 commits into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
This PR extends the DevExtreme Grids AI Assistant documentation by adding/relocating API type descriptions (commands, filter expression objects, AI Assistant customization callbacks) and wiring the AI Assistant toolbar button into the shared grids toolbar include.
Changes:
- Added documentation pages for predefined grid commands/command names and filter-expression object shapes (Common Types + DataGrid-specific Types).
- Added detailed API descriptions and multi-framework examples for AI Assistant
customizeResponseTitle/customizeResponseText, plus relatedchat/popupconfiguration notes. - Removed obsolete placeholder “NewTopics” stubs after migrating content to the canonical API reference locations.
Reviewed changes
Copilot reviewed 36 out of 37 changed files in this pull request and generated 12 comments.
Show a summary per file
| File | Description |
|---|---|
| includes/grids-toolbar.md | Adds aiAssistantButton to the predefined toolbar controls table. |
| api-reference/NewTopics/SummaryCommandTotalItem/SummaryCommandTotalItem.md | Removes placeholder stub (topic migrated to canonical location). |
| api-reference/NewTopics/SummaryCommandGroupItem/SummaryCommandGroupItem.md | Removes placeholder stub (topic migrated to canonical location). |
| api-reference/NewTopics/PredefinedCommands/PredefinedCommands.md | Removes placeholder stub (topic migrated to canonical location). |
| api-reference/NewTopics/PredefinedCommandNames/PredefinedCommandNames.md | Removes placeholder stub (topic migrated to canonical location). |
| api-reference/NewTopics/NegatedFilterExprObj/NegatedFilterExprObj.md | Removes placeholder stub (topic migrated to canonical location). |
| api-reference/NewTopics/FilterExprObj/FilterExprObj.md | Removes placeholder stub (topic migrated to canonical location). |
| api-reference/NewTopics/DataGridPredefinedCommands/DataGridPredefinedCommands.md | Removes placeholder stub (topic migrated to canonical location). |
| api-reference/NewTopics/DataGridPredefinedCommandNames/DataGridPredefinedCommandNames.md | Removes placeholder stub (topic migrated to canonical location). |
| api-reference/NewTopics/DataGridCommandInfo/DataGridCommandInfo.md | Removes placeholder stub (topic migrated to canonical location). |
| api-reference/NewTopics/CompositeKeyPair/CompositeKeyPair.md | Removes placeholder stub (topic migrated to canonical location). |
| api-reference/NewTopics/CommandInfo/CommandInfo.md | Removes placeholder stub (topic migrated to canonical location). |
| api-reference/NewTopics/CombinedFilterExprObj/CombinedFilterExprObj.md | Removes placeholder stub (topic migrated to canonical location). |
| api-reference/NewTopics/BasicFilterExprObj/BasicFilterExprObj.md | Removes placeholder stub (topic migrated to canonical location). |
| api-reference/40 Common Types/15 grids/ResponseStatusTexts/ResponseStatusTexts.md | Adds short + long descriptions for response status text object. |
| api-reference/40 Common Types/15 grids/ResponseStatus.md | Adds short description for AI response status enum. |
| api-reference/40 Common Types/15 grids/PredefinedCommands/PredefinedCommands.md | Adds documentation for predefined commands and their argument shapes. |
| api-reference/40 Common Types/15 grids/PredefinedCommandNames/PredefinedCommandNames.md | Adds documentation listing available predefined command names. |
| api-reference/40 Common Types/15 grids/NegatedFilterExprObj/NegatedFilterExprObj.md | Documents the negated filter expression object shape. |
| api-reference/40 Common Types/15 grids/FilterExprObj/FilterExprObj.md | Documents the union type for grid filter expressions. |
| api-reference/40 Common Types/15 grids/CompositeKeyPair/CompositeKeyPair.md | Documents composite key field/value pair shape. |
| api-reference/40 Common Types/15 grids/CommandInfo/CommandInfo.md | Documents command metadata object fields (name, args). |
| api-reference/40 Common Types/15 grids/CombinedFilterExprObj/CombinedFilterExprObj.md | Documents combined (AND/OR) filter expression object shape. |
| api-reference/40 Common Types/15 grids/BasicFilterExprObj/BasicFilterExprObj.md | Documents basic filter expression object shape. |
| api-reference/40 Common Types/15 grids/AIAssistant/popup.md | Expands the “do not recommend” popup options list. |
| api-reference/40 Common Types/15 grids/AIAssistant/customizeResponseTitle.md | Adds description + multi-framework examples for response title customization. |
| api-reference/40 Common Types/15 grids/AIAssistant/customizeResponseText.md | Adds description + multi-framework examples for per-command response texts. |
| api-reference/40 Common Types/15 grids/AIAssistant/chat.md | Expands the “do not recommend” chat options list. |
| api-reference/10 UI Components/dxDataGrid/9 Types/SummaryCommandTotalItem/SummaryCommandTotalItem.md | Adds DataGrid-specific type doc for summary-command total items. |
| api-reference/10 UI Components/dxDataGrid/9 Types/SummaryCommandGroupItem/SummaryCommandGroupItem.md | Adds DataGrid-specific type doc for summary-command group items. |
| api-reference/10 UI Components/dxDataGrid/9 Types/DataGridPredefinedCommands/DataGridPredefinedCommands.md | Adds DataGrid-specific predefined commands and argument shapes (includes summary/grouping). |
| api-reference/10 UI Components/dxDataGrid/9 Types/DataGridPredefinedCommandNames/DataGridPredefinedCommandNames.md | Adds DataGrid-specific command names list. |
| api-reference/10 UI Components/dxDataGrid/9 Types/DataGridCommandInfo/DataGridCommandInfo.md | Adds DataGrid-specific command info type doc. |
| api-reference/10 UI Components/dxDataGrid/1 Configuration/aiAssistant/customizeResponseTitle.md | Adds DataGrid option doc for response title customization with examples. |
| api-reference/10 UI Components/dxDataGrid/1 Configuration/aiAssistant/customizeResponseText.md | Adds DataGrid option doc for response text customization with examples. |
| api-reference/10 UI Components/dxDataGrid/1 Configuration/aiAssistant/aiAssistant.md | Updates AI Assistant option short description and inheritance metadata. |
Comments suppressed due to low confidence (4)
api-reference/40 Common Types/15 grids/AIAssistant/customizeResponseText.md:140
- The React example defines
customizeResponseText, but the component is configured withcustomizeResponseTitle={customizeResponseTitle}. This looks like a copy/paste error and will not work when copied; passcustomizeResponseTextinstead.
function App() {
return (
<{WidgetName}>
<AIAssistant
enabled={true}
customizeResponseTitle={customizeResponseTitle}
/>
api-reference/10 UI Components/dxDataGrid/1 Configuration/aiAssistant/customizeResponseText.md:140
- The React example defines
customizeResponseText, but the component is configured withcustomizeResponseTitle={customizeResponseTitle}. This looks like a copy/paste error and will not work when copied; passcustomizeResponseTextinstead.
function App() {
return (
<{WidgetName}>
<AIAssistant
enabled={true}
customizeResponseTitle={customizeResponseTitle}
/>
api-reference/40 Common Types/15 grids/ResponseStatus.md:12
- The updated
shortDescriptionis helpful, but the main description section still contains the placeholder<!-- Description goes here -->. Replace this placeholder with an actual description (or remove the section if this type intentionally has no long description).
api-reference/10 UI Components/dxDataGrid/1 Configuration/aiAssistant/aiAssistant.md:11 - This option now has a
shortDescription, but the main description section still contains the placeholder<!-- Description goes here -->. Replace this placeholder with an actual description (or remove it) to avoid publishing placeholder text.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 36 out of 37 changed files in this pull request and generated 10 comments.
Comments suppressed due to low confidence (2)
api-reference/40 Common Types/15 grids/ResponseStatus.md:12
- This topic still contains the placeholder
<!-- Description goes here -->in the main description section. Please replace it with the actual description (or remove the section) so the published API reference does not expose placeholders.
api-reference/10 UI Components/dxDataGrid/1 Configuration/aiAssistant/aiAssistant.md:11 - This topic still contains the placeholder
<!-- Description goes here -->in the main description section. Please replace it with an actual description (or remove the section) so the published API reference does not expose placeholders.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 36 out of 37 changed files in this pull request and generated 11 comments.
Comments suppressed due to low confidence (1)
api-reference/40 Common Types/15 grids/ResponseStatus.md:13
- The long description section still contains the
<!-- Description goes here -->placeholder. Please replace it with an actual description of thesuccess/failurevalues (or remove the placeholder if no long description is intended) so the page is not published with template text.
| - **clearSorting** | ||
|
|
||
| #####See Also##### | ||
| - [PredefinedCommands]({basewidgetpath}/PredefinedCommands) No newline at end of file |
| - **clearSummary** | ||
|
|
||
| #####See Also##### | ||
| - [DataGridPredefinedCommands]({basewidgetpath}/Types/DataGridPredefinedCommands) No newline at end of file |
Comment on lines
+19
to
+22
| Use this function to customize the titles of AI Assistant response messages. | ||
|
|
||
| You can use this function to translate response texts. The following code snippet uses the [locale()](/Documentation/ApiReference/Common/Utils/localization/#locale) method to specify texts for multiple locales: | ||
|
|
Comment on lines
+47
to
+50
| <dxo-data-grid-ai-assistant | ||
| [enabled]="true" | ||
| [customizeResponseTitle]="customizeResponseTitle" | ||
| ></dxo-data-grid-ai-assistant> |
| --- | ||
| Use this function to customize the titles of AI Assistant response messages. | ||
|
|
||
| You can use this function to translate response texts. The following code snippet uses the [locale()](/Documentation/ApiReference/Common/Utils/localization/#locale) method to specify texts for multiple locales: |
Comment on lines
+61
to
+64
| <dxo-data-grid-ai-assistant | ||
| [enabled]="true" | ||
| [customizeResponseText]="customizeResponseText" | ||
| ></dxo-data-grid-ai-assistant> |
| --- | ||
| Use this function to customize response message texts for AI Assistant commands. **customizeResponseText** is called for each requested command. The AI Assistant chat displays these texts below the response title. When a response includes multiple commands, the chat displays each command's text on separate lines. | ||
|
|
||
| When a command succeeds, the AI Assistant chat displays the response text in green and prefixes the text with a checkmark button emoji (✅). When a command fails, the AI Assistant chat displays the text in red and prefixes with a cross mark emoji (❌) instead. |
Comment on lines
+16
to
+20
| - [dataSource](/Documentation/ApiReference/UI_Components/dxChat/Configuration/#dataSource) | ||
| - [editing](/api-reference/10%20UI%20Components/dxChat/1%20Configuration/editing '/Documentation/ApiReference/UI_Components/dxChat/Configuration/editing/') | ||
| - [messageTemplate](/api-reference/10%20UI%20Components/dxChat/1%20Configuration/messageTemplate.md '/Documentation/ApiReference/UI_Components/dxChat/Configuration/#messageTemplate') | ||
| - [onMessageEntered](/Documentation/ApiReference/UI_Components/dxChat/Configuration/#onMessageEntered) | ||
| - [reloadOnChange](/Documentation/ApiReference/UI_Components/dxChat/Configuration/#reloadOnChange) |
Comment on lines
+18
to
+19
| - [onHidden](/Documentation/ApiReference/UI_Components/dxPopup/Configuration/#onHidden) | ||
| - [onShowing](/Documentation/ApiReference/UI_Components/dxPopup/Configuration/#onShowing) |
| <tr> | ||
| <td><i>aiAssistantButton</i></td> | ||
| <td><img src="/images/DataGrid/icons/aiAssistantButton.png" alt="DevExtreme JavaScript jQuery Angular UI component {WidgetName} Toolbar AI Assistant Button" style="margin:1px; vertical-align:middle"/></td> | ||
| <td><a href="{basewidgetpath}/Configuration/#aiIntegration">aiIntegration</a> or <b>aiAssistant</b>.<a href="{basewidgetpath}/Configuration/aiAssistant/#aiIntegration">aiIntegration</a> is configured and <b>aiAssistant</b>.<a href="{basewidgetpath}/Configuration/aiAssistant/#enabled">enabled</a> is <b>true</b></td> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.