[DRAFT] Grids AI Assistant WIP Docgen#8759
Open
arman-boyakhchyan wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
Adds initial (WIP) API reference topics for the Grids AI Assistant documentation, including new helper types, an enum for response status, and updates to the onAIAssistantRequestCreating event docs.
Changes:
- Introduces new “NewTopics” type stubs for AI Assistant command-related structures.
- Updates
AIAssistantRequestCreatingInfometadata and extendsGridBase.Options.onAIAssistantRequestCreatingwith anadditionalInfofield. - Adds AI Assistant customization callbacks (
customizeResponseTitle,customizeResponseText), aResponseStatusenum, and adxDataGrid.Options.aiAssistantoption page.
Reviewed changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
| api-reference/NewTopics/ResponseStatusTexts/ResponseStatusTexts.md | Adds a stub topic for response status text mappings. |
| api-reference/NewTopics/PredefinedCommands/PredefinedCommands.md | Adds a stub topic for predefined AI Assistant commands. |
| api-reference/NewTopics/PredefinedCommandNames/PredefinedCommandNames.md | Adds a stub topic for predefined command name type. |
| api-reference/NewTopics/GridCommandInfo/GridCommandInfo.md | Adds a stub topic for grid command metadata. |
| api-reference/NewTopics/GridBasePredefinedCommands/GridBasePredefinedCommands.md | Adds a stub topic intended as a base for predefined commands. |
| api-reference/NewTopics/CommandInfo/CommandInfo.md | Adds a stub topic for command info passed to callbacks. |
| api-reference/40 Common Types/15 grids/AIAssistantRequestCreatingInfo/AIAssistantRequestCreatingInfo.md | Changes the documented type metadata for request-creation info. |
| api-reference/40 Common Types/15 grids/AIAssistant/customizeResponseTitle.md | Adds a stub callback doc for customizing response titles. |
| api-reference/40 Common Types/15 grids/AIAssistant/customizeResponseText.md | Adds a stub callback doc for customizing response text(s). |
| api-reference/10 UI Components/GridBase/1 Configuration/onAIAssistantRequestCreating.md | Documents a new e.additionalInfo field in the event argument. |
| api-reference/10 UI Components/dxTreeList/1 Configuration/onAIAssistantRequestCreating.md | Removes documented event fields (context/responseSchema) from the option page. |
| api-reference/10 UI Components/dxDataGrid/1 Configuration/onAIAssistantRequestCreating.md | Removes documented event fields (context/responseSchema) from the option page. |
| api-reference/10 UI Components/dxDataGrid/1 Configuration/aiAssistant.md | Adds a stub page for dxDataGrid.Options.aiAssistant. |
| api-reference/_hidden/Enums/ResponseStatus.md | Adds a hidden union enum for AI Assistant response status. |
Comment on lines
5
to
9
| hidden: | ||
| type: Object | ||
| type: Pick | ||
| generateTypeLink: | ||
| acceptValues: 'context' | 'responseSchema' | 'additionalInfo' | ||
| --- |
| The JSON schema of the AI Assistant response. | ||
|
|
||
| ##### field(e.additionalInfo): Record | ||
| <!-- Description goes here --> |
|
|
||
| ##### field(e.element): DxElement | ||
| #include common-ref-elementparam with { element: "UI component" } | ||
|
|
|
|
||
| ##### field(e.element): DxElement | ||
| #include common-ref-elementparam with { element: "UI component" } | ||
|
|
Comment on lines
+4
to
+10
| --- | ||
| --- | ||
| ##### shortDescription | ||
| <!-- Description goes here --> | ||
|
|
||
| --- | ||
| <!-- Description goes here --> No newline at end of file |
| id: PredefinedCommands | ||
| module: ui/data_grid | ||
| export: PredefinedCommands | ||
| type: BasePredefinedCommands | Object |
| module: ui/data_grid | ||
| export: GridCommandInfo | ||
| hidden: | ||
| type: BaseCommandInfo |
| --- | ||
| id: GridBasePredefinedCommands | ||
| module: common/grids | ||
| export: PredefinedCommands |
Comment on lines
+7
to
+19
| <!-- Description goes here --> | ||
|
|
||
| ##### param(status): Enums.ResponseStatus | ||
| <!-- Description goes here --> | ||
|
|
||
| ##### param(commandNames): Array<String> | ||
| <!-- Description goes here --> | ||
|
|
||
| ##### return: String | ||
| <!-- Description goes here --> | ||
|
|
||
| --- | ||
| <!-- Description goes here --> No newline at end of file |
Comment on lines
+7
to
+16
| <!-- Description goes here --> | ||
|
|
||
| ##### param(command): CommandInfo | ||
| <!-- Description goes here --> | ||
|
|
||
| ##### return: ResponseStatusTexts | ||
| <!-- Description goes here --> | ||
|
|
||
| --- | ||
| <!-- Description goes here --> No newline at end of file |
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.