Grids AI Assistant: Add API Descriptions#8691
Open
arman-boyakhchyan wants to merge 7 commits intoDevExpress:26_1from
Open
Grids AI Assistant: Add API Descriptions#8691arman-boyakhchyan wants to merge 7 commits intoDevExpress:26_1from
arman-boyakhchyan wants to merge 7 commits intoDevExpress:26_1from
Conversation
There was a problem hiding this comment.
Pull request overview
This PR fills in missing API reference descriptions for the Grids AI Assistant feature, primarily by adding shortDescription text and brief guidance for configuration/event-related docs.
Changes:
- Added short descriptions for AI Assistant common types and options (enabled, title, integration, popup/chat configuration).
- Documented
onAIAssistantRequestCreating(GridBase, dxDataGrid, dxTreeList) and the associated event argument types. - Added a GridBase event page description and linked it to the main configuration article.
Reviewed changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| api-reference/40 Common Types/15 grids/AIAssistantRequestCreatingInfo/responseSchema.md | Adds short description for responseSchema. |
| api-reference/40 Common Types/15 grids/AIAssistantRequestCreatingInfo/context.md | Adds short description for context. |
| api-reference/40 Common Types/15 grids/AIAssistant/title.md | Adds short description for the popup title option. |
| api-reference/40 Common Types/15 grids/AIAssistant/popup.md | Adds popup configuration description and guidance note. |
| api-reference/40 Common Types/15 grids/AIAssistant/enabled.md | Adds enablement description + activation guidance. |
| api-reference/40 Common Types/15 grids/AIAssistant/chat.md | Adds chat configuration description and guidance note. |
| api-reference/40 Common Types/15 grids/AIAssistant/aiIntegration.md | Adds integration description + activation guidance. |
| api-reference/40 Common Types/15 grids/AIAssistant/AIAssistant.md | Adds short description for the AIAssistant object. |
| api-reference/10 UI Components/dxTreeList/9 Types/AIAssistantRequestCreatingEvent/AIAssistantRequestCreatingEvent.md | Adds short description for the event argument type. |
| api-reference/10 UI Components/dxTreeList/1 Configuration/onAIAssistantRequestCreating.md | Documents the TreeList pre-request event handler and fields. |
| api-reference/10 UI Components/dxDataGrid/9 Types/AIAssistantRequestCreatingEvent/AIAssistantRequestCreatingEvent.md | Adds short description for the event argument type. |
| api-reference/10 UI Components/dxDataGrid/1 Configuration/onAIAssistantRequestCreating.md | Documents the DataGrid pre-request event handler and fields. |
| api-reference/10 UI Components/GridBase/4 Events/aIAssistantRequestCreating.md | Adds event description + link to the main configuration article. |
| api-reference/10 UI Components/GridBase/1 Configuration/onAIAssistantRequestCreating.md | Documents the base pre-request handler fields. |
| api-reference/10 UI Components/GridBase/1 Configuration/aiAssistant.md | Adds inheritsType metadata and short description. |
There was a problem hiding this comment.
Pull request overview
Adds missing API descriptions for the Grid AI Assistant feature across common types and grid-specific configuration/events, improving generated API reference readability.
Changes:
- Filled in
shortDescription(and some extended descriptions) for AI Assistant-related common types and configuration options. - Documented the
onAIAssistantRequestCreatingevent argument fields for DataGrid/TreeList and added a GridBase event page description. - Added an
inheritsTypeentry forGridBase.Options.aiAssistantand added/updated an error description for missingaiAssistant.aiIntegration.
Reviewed changes
Copilot reviewed 18 out of 18 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| api-reference/40 Common Types/ExecuteGridAssistantCommandResponse/actions.md | Adds a short description for response actions. |
| api-reference/40 Common Types/ExecuteGridAssistantCommandResponse/ExecuteGridAssistantCommandResponse.md | Adds a short description for the assistant command response type. |
| api-reference/40 Common Types/15 grids/AIAssistantRequestCreatingInfo/responseSchema.md | Describes the AI response JSON schema field. |
| api-reference/40 Common Types/15 grids/AIAssistantRequestCreatingInfo/context.md | Describes the context payload included in assistant requests. |
| api-reference/40 Common Types/15 grids/AIAssistant/title.md | Describes the AI Assistant popup title option. |
| api-reference/40 Common Types/15 grids/AIAssistant/popup.md | Documents how to configure the assistant popup and which Popup options to avoid. |
| api-reference/40 Common Types/15 grids/AIAssistant/enabled.md | Describes enabling the assistant and references required integration setup. |
| api-reference/40 Common Types/15 grids/AIAssistant/chat.md | Documents how to configure the assistant chat and which Chat options to avoid. |
| api-reference/40 Common Types/15 grids/AIAssistant/aiIntegration.md | Describes binding the assistant to an AI service and enabling it. |
| api-reference/40 Common Types/15 grids/AIAssistant/AIAssistant.md | Adds a short description for the AI Assistant configuration object. |
| api-reference/10 UI Components/dxTreeList/9 Types/AIAssistantRequestCreatingEvent/AIAssistantRequestCreatingEvent.md | Adds a short description for the TreeList event argument type. |
| api-reference/10 UI Components/dxTreeList/1 Configuration/onAIAssistantRequestCreating.md | Documents TreeList onAIAssistantRequestCreating and its event fields. |
| api-reference/10 UI Components/dxDataGrid/9 Types/AIAssistantRequestCreatingEvent/AIAssistantRequestCreatingEvent.md | Adds a short description for the DataGrid event argument type. |
| api-reference/10 UI Components/dxDataGrid/1 Configuration/onAIAssistantRequestCreating.md | Documents DataGrid onAIAssistantRequestCreating and its event fields. |
| api-reference/10 UI Components/GridBase/4 Events/aIAssistantRequestCreating.md | Adds a short description and cross-links for the GridBase event. |
| api-reference/10 UI Components/GridBase/1 Configuration/onAIAssistantRequestCreating.md | Documents the GridBase hook and most event fields (one field still placeholder). |
| api-reference/10 UI Components/GridBase/1 Configuration/aiAssistant.md | Adds inheritsType and a short description for GridBase AI Assistant configuration. |
| api-reference/10 UI Components/Errors and Warnings/E1068.md | Adds an error description and resolution link for missing aiAssistant.aiIntegration. |
dmirgaev
reviewed
May 5, 2026
dmirgaev
reviewed
May 5, 2026
dmirgaev
reviewed
May 5, 2026
dmirgaev
reviewed
May 5, 2026
There was a problem hiding this comment.
There is a lack of two additional options: customizeResponseTitle and customizeResponseText
dmirgaev
requested changes
May 5, 2026
dmirgaev
approved these changes
May 6, 2026
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.