Grids AI Assistant: Add API Descriptions Part 2

api-reference/10 UI Components/dxDataGrid/1 Configuration/aiAssistant.md → api-reference/10 UI Components/dxDataGrid/1 Configuration/aiAssistant/aiAssistant.md

@@ -1,10 +1,11 @@
 ---
 id: dxDataGrid.Options.aiAssistant
 type: AIAssistant
+inheritsType: AIAssistant
 ---
 ---
 ##### shortDescription
-<!-- Description goes here -->
+Configures the {WidgetName} AI Assistant.
 
 ---
 <!-- Description goes here -->

api-reference/10 UI Components/dxDataGrid/1 Configuration/aiAssistant/customizeResponseText.md

@@ -0,0 +1,145 @@
+---
+id: dxDataGrid.Options.aiAssistant.customizeResponseText
+type: function(command)
+---
+---
+##### shortDescription
+Customizes AI Assistant response texts for each requested command.
+
+##### param(command): DataGridCommandInfo
+Information about the command.
+
+##### return: ResponseStatusTexts
+Custom texts for **success** and **failure** response statuses.
+
+---
+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.
+
+The **command** parameter contains the following fields:
+
+- **name**: The command's name ([DataGridPredefinedCommandNames]({basewidgetpath}/Types/DataGridPredefinedCommandNames/)).
+- **args**: Command arguments. Refer to [DataGridPredefinedCommands]({basewidgetpath}/Types/DataGridPredefinedCommands/) for information about the arguments of each available command.
+
+Configure **customizeResponseText** to return an object with the following fields:
+
+- **success**: Text to display when the command succeeds.
+- **failure**: Text to display when the command fails.
+
+Omit a field in the return object to use default texts.
+
+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:
+
+---
+
+##### jQuery
+
+    <!-- tab: index.js -->
+    const currentLocale = DevExpress.localization.locale();
+
+    $('#{widget-name}-container').dx{WidgetName}({
+        aiAssistant: {
+            customizeResponseText(command) {
+                switch (currentLocale) {
+                    case 'en':
+                        return {
+                            success: `Command succeeded: ${command.name}`,
+                            failure: `Command failed: ${command.name}`,
+                        };
+                    case 'fr':
+                        return { /* Translated texts */ };
+                }
+            },
+        },
+    });
+
+##### Angular
+
+    <!-- tab: app.component.html -->
+    <dx-{widget-name}>
+        <dxo-{widget-name}-ai-assistant
+            [enabled]="true"
+            [customizeResponseText]="customizeResponseText"
+        ></dxo-{widget-name}-ai-assistant>
+    </dx-{widget-name}>
+
+    <!-- tab: app.component.ts -->
+    import { Dx{WidgetName}Module, type Dx{WidgetName}Types } from 'devextreme-angular/ui/{widget-name}';
+    import { locale } from "devextreme/localization";
+
+    export class AppComponent {
+        currentLocale = locale();
+        customizeResponseText = (command) => {
+            switch (this.currentLocale) {
+                case 'en':
+                    return {
+                        success: `Command succeeded: ${command.name}`,
+                        failure: `Command failed: ${command.name}`,
+                    };
+                case 'fr':
+                    return { /* Translated texts */ };
+            }
+        };
+    }
+
+##### Vue
+
+    <!-- tab: App.vue -->
+    <template>
+        <Dx{WidgetName}>
+            <DxAIAssistant
+                :customize-response-text="customizeResponseText"
+            />
+        </Dx{WidgetName}>
+    </template>
+
+    <script setup lang="ts">
+    import { Dx{WidgetName}, DxAIAssistant, type Dx{WidgetName}Types } from 'devextreme-vue/{widget-name}';
+    import { locale } from "devextreme/localization";
+
+    const currentLocale = locale();
+    function customizeResponseText(command) {
+        switch (currentLocale) {
+            case 'en':
+                return {
+                    success: `Command succeeded: ${command.name}`,
+                    failure: `Command failed: ${command.name}`,
+                };
+            case 'fr':
+                return { /* Translated texts */ };
+        }
+    };
+    </script>
+
+##### React
+
+    <!-- tab: App.tsx -->
+    import { {WidgetName}, AIAssistant, type {WidgetName}Types } from 'devextreme-react/{widget-name}';
+    import { locale } from "devextreme/localization";
+
+    const currentLocale = locale();
+    function customizeResponseText(command) {
+        switch (currentLocale) {
+            case 'en':
+                return {
+                    success: `Command succeeded: ${command.name}`,
+                    failure: `Command failed: ${command.name}`,
+                };
+            case 'fr':
+                return { /* Translated texts */ };
+        }
+    };
+
+    function App() {
+        return (
+            <{WidgetName}>
+                <AIAssistant
+                    enabled={true}
+                    customizeResponseText={customizeResponseText}
+                />
+            </{WidgetName}>
+        );
+    };
+
+---

api-reference/10 UI Components/dxDataGrid/1 Configuration/aiAssistant/customizeResponseTitle.md

@@ -0,0 +1,215 @@
+---
+id: dxDataGrid.Options.aiAssistant.customizeResponseTitle
+type: function(status, commandNames)
+---
+---
+##### shortDescription
+Customizes AI Assistant response titles.
+
+##### param(status): Enums.ResponseStatus
+The response status. If a response includes multiple requested commands, all must succeed for this parameter's value to equal *"success"*.
+
+##### param(commandNames): Array<String>
+An array of requested commands ([DataGridPredefinedCommandNames]({basewidgetpath}/Types/DataGridPredefinedCommandNames/)).
+
+##### return: String
+The custom response title.
+
+---
+Use this function to customize the titles of AI Assistant response messages. The following code snippet adds response statuses to titles:
+
+---
+
+##### jQuery
+
+    <!-- tab: index.js -->
+    $('#{widget-name}-container').dx{WidgetName}({
+        aiAssistant: {
+            customizeResponseTitle(status, commandNames) {
+                switch (status) {
+                    case 'success':
+                        return `Completed: ${commandNames.join(', ')}`;
+                    case 'failure':
+                        return `Failed: ${commandNames.join(', ')}`;
+                }
+            },
+        },
+    });
+
+##### Angular
+
+    <!-- tab: app.component.html -->
+    <dx-{widget-name}>
+        <dxo-{widget-name}-ai-assistant
+            [enabled]="true"
+            [customizeResponseTitle]="customizeResponseTitle"
+        ></dxo-{widget-name}-ai-assistant>
+    </dx-{widget-name}>
+
+    <!-- tab: app.component.ts -->
+    import { Dx{WidgetName}Module, type Dx{WidgetName}Types } from 'devextreme-angular/ui/{widget-name}';
+
+    export class AppComponent {
+        customizeResponseTitle = (status, commandNames) => {
+            switch (status) {
+                case 'success':
+                    return `Completed: ${commandNames.join(', ')}`;
+                case 'failure':
+                    return `Failed: ${commandNames.join(', ')}`;
+            }
+        };
+    }
+
+##### Vue
+
+    <!-- tab: App.vue -->
+    <template>
+        <Dx{WidgetName}>
+            <DxAIAssistant
+                :customize-response-title="customizeResponseTitle"
+            />
+        </Dx{WidgetName}>
+    </template>
+
+    <script setup lang="ts">
+    import { Dx{WidgetName}, DxAIAssistant, type Dx{WidgetName}Types } from 'devextreme-vue/{widget-name}';
+
+    function customizeResponseTitle(status, commandNames) {
+        switch (status) {
+            case 'success':
+                return `Completed: ${commandNames.join(', ')}`;
+            case 'failure':
+                return `Failed: ${commandNames.join(', ')}`;
+        }
+    };
+    </script>
+
+##### React
+
+    <!-- tab: App.tsx -->
+    import { {WidgetName}, AIAssistant, type {WidgetName}Types } from 'devextreme-react/{widget-name}';
+
+    function customizeResponseTitle(status, commandNames) {
+        switch (status) {
+            case 'success':
+                return `Completed: ${commandNames.join(', ')}`;
+            case 'failure':
+                return `Failed: ${commandNames.join(', ')}`;
+        }
+    };
+
+    function App() {
+        return (
+            <{WidgetName}>
+                <AIAssistant
+                    enabled={true}
+                    customizeResponseTitle={customizeResponseTitle}
+                />
+            </{WidgetName}>
+        );
+    };
+
+---
+
+You can use this function to translate response titles. The following code snippet uses the [locale()](/Documentation/ApiReference/Common/Utils/localization/#locale) method to specify texts for multiple locales:
+
+---
+
+##### jQuery
+
+    <!-- tab: index.js -->
+    const currentLocale = DevExpress.localization.locale();
+
+    $('#{widget-name}-container').dx{WidgetName}({
+        aiAssistant: {
+            customizeResponseTitle(status, commandNames) {
+                switch (currentLocale) {
+                    case 'en':
+                        return `${status.toUpperCase()}: ${commandNames.join(', ')}`;
+                    case 'fr':
+                        return /* Translated texts */;
+                }
+            },
+        },
+    });
+
+##### Angular
+
+    <!-- tab: app.component.html -->
+    <dx-{widget-name}>
+        <dxo-{widget-name}-ai-assistant
+            [enabled]="true"
+            [customizeResponseTitle]="customizeResponseTitle"
+        ></dxo-{widget-name}-ai-assistant>
+    </dx-{widget-name}>
+
+    <!-- tab: app.component.ts -->
+    import { Dx{WidgetName}Module, type Dx{WidgetName}Types } from 'devextreme-angular/ui/{widget-name}';
+    import { locale } from "devextreme/localization";
+
+    export class AppComponent {
+        currentLocale = locale();
+        customizeResponseTitle = (status, commandNames) => {
+            switch (this.currentLocale) {
+                case 'en':
+                    return `${status.toUpperCase()}: ${commandNames.join(', ')}`;
+                case 'fr':
+                    return /* Translated texts */;
+            }
+        };
+    }
+
+##### Vue
+
+    <!-- tab: App.vue -->
+    <template>
+        <Dx{WidgetName}>
+            <DxAIAssistant
+                :customize-response-title="customizeResponseTitle"
+            />
+        </Dx{WidgetName}>
+    </template>
+
+    <script setup lang="ts">
+    import { Dx{WidgetName}, DxAIAssistant, type Dx{WidgetName}Types } from 'devextreme-vue/{widget-name}';
+    import { locale } from "devextreme/localization";
+
+    const currentLocale = locale();
+    function customizeResponseTitle(status, commandNames) {
+        switch (currentLocale) {
+            case 'en':
+                return `${status.toUpperCase()}: ${commandNames.join(', ')}`;
+            case 'fr':
+                return /* Translated texts */;
+        }
+    };
+    </script>
+
+##### React
+
+    <!-- tab: App.tsx -->
+    import { {WidgetName}, AIAssistant, type {WidgetName}Types } from 'devextreme-react/{widget-name}';
+    import { locale } from "devextreme/localization";
+
+    const currentLocale = locale();
+    function customizeResponseTitle(status, commandNames) {
+        switch (currentLocale) {
+            case 'en':
+                return `${status.toUpperCase()}: ${commandNames.join(', ')}`;
+            case 'fr':
+                return /* Translated texts */;
+        }
+    };
+
+    function App() {
+        return (
+            <{WidgetName}>
+                <AIAssistant
+                    enabled={true}
+                    customizeResponseTitle={customizeResponseTitle}
+                />
+            </{WidgetName}>
+        );
+    };
+
+---

api-reference/10 UI Components/dxDataGrid/9 Types/DataGridCommandInfo/DataGridCommandInfo.md

@@ -0,0 +1,16 @@
+---
+id: DataGridCommandInfo
+module: ui/data_grid
+export: DataGridCommandInfo
+type: CommandInfo
+generateTypeLink: 
+---
+---
+##### shortDescription
+Information about a predefined DataGrid command.
+
+---
+**DataGridCommandInfo** contains the following fields:
+
+- **name**: The predefined command's name ([DataGridPredefinedCommandNames]({basewidgetpath}/Types/DataGridPredefinedCommandNames/)).
+- **args**: Command arguments. Refer to [DataGridPredefinedCommands]({basewidgetpath}/Types/DataGridPredefinedCommands/) for information about the arguments of each available command.