[DRAFT] Grids AI Assistant WIP Docgen - Version 2#8765
Open
arman-boyakhchyan wants to merge 1 commit into
Open
[DRAFT] Grids AI Assistant WIP Docgen - Version 2#8765arman-boyakhchyan wants to merge 1 commit into
arman-boyakhchyan wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
Pull request overview
Adds draft API reference scaffolding for grid AI Assistant command/response customization and updates DataGrid/TreeList AI Assistant request event documentation.
Changes:
- Adds new AI Assistant-related API type topics and response status enum metadata.
- Adds
customizeResponseTitleandcustomizeResponseTextfunction topics. - Updates AI Assistant request event argument docs and adds a DataGrid
aiAssistantoption topic.
Reviewed changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 14 comments.
Show a summary per file
| File | Description |
|---|---|
api-reference/NewTopics/ResponseStatusTexts/ResponseStatusTexts.md |
Adds a new response status text type topic. |
api-reference/NewTopics/PredefinedCommands/PredefinedCommands.md |
Adds a predefined commands type topic. |
api-reference/NewTopics/PredefinedCommandNames/PredefinedCommandNames.md |
Adds a predefined command names type topic. |
api-reference/NewTopics/DataGridPredefinedCommands/DataGridPredefinedCommands.md |
Adds a DataGrid-specific predefined commands topic. |
api-reference/NewTopics/DataGridPredefinedCommandNames/DataGridPredefinedCommandNames.md |
Adds a DataGrid-specific predefined command names topic. |
api-reference/NewTopics/DataGridCommandInfo/DataGridCommandInfo.md |
Adds a DataGrid command info type topic. |
api-reference/NewTopics/CommandInfo/CommandInfo.md |
Adds a shared command info type topic. |
api-reference/40 Common Types/15 grids/AIAssistantRequestCreatingInfo/AIAssistantRequestCreatingInfo.md |
Changes request-creating info metadata to a picked field set. |
api-reference/40 Common Types/15 grids/AIAssistant/customizeResponseTitle.md |
Adds a response title customization function topic. |
api-reference/40 Common Types/15 grids/AIAssistant/customizeResponseText.md |
Adds a response text customization function topic. |
api-reference/10 UI Components/dxTreeList/1 Configuration/onAIAssistantRequestCreating.md |
Removes several documented event fields. |
api-reference/10 UI Components/dxDataGrid/1 Configuration/onAIAssistantRequestCreating.md |
Removes several documented event fields. |
api-reference/10 UI Components/dxDataGrid/1 Configuration/aiAssistant.md |
Adds a DataGrid AI Assistant option topic. |
api-reference/_hidden/Enums/ResponseStatus.md |
Adds a hidden response status union enum. |
| @@ -0,0 +1,10 @@ | |||
| --- | |||
| id: dxDataGrid.Options.aiAssistant | |||
| type: AIAssistant | |||
|
|
||
| ##### 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
+6
to
+8
| type: Pick | ||
| generateTypeLink: | ||
| acceptValues: 'context' | 'responseSchema' | 'additionalInfo' |
Comment on lines
+9
to
+12
| <!-- Description goes here --> | ||
|
|
||
| --- | ||
| <!-- Description goes here --> No newline at end of file |
Comment on lines
+9
to
+12
| <!-- Description goes here --> | ||
|
|
||
| --- | ||
| <!-- Description goes here --> No newline at end of file |
Comment on lines
+9
to
+12
| <!-- Description goes here --> | ||
|
|
||
| --- | ||
| <!-- Description goes here --> No newline at end of file |
Comment on lines
+7
to
+10
| <!-- Description goes here --> | ||
|
|
||
| --- | ||
| <!-- Description goes here --> No newline at end of file |
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.