@alicloud/dms20250414 4.0.0 → 4.1.0

package/src/models/CreateCustomAgentShrinkRequest.ts

@@ -14,19 +14,19 @@ export class CreateCustomAgentShrinkRequest extends $dara.Model {
   DMSUnit?: string;
   /**
    * @remarks
-   * The specified data scope in **JSON character string format**.
-   * - Common metric description
-   *   - tableFlag: true indicates that a data scope is specified.
+   * The specified data scope, in **JSON character string format**.
+   * - Common parameter description
+   *   - tableFlag: true specifies the data scope.
    *   - scope: personal is a fixed value.
-   *   - personal: pass parameters for file or database types.
+   *   - personal: the parameters for file and database types.
    * 
-   * **File type**. Pass parameters in the following format:
+   * **File type**: Pass parameters in the following format:
    * - DataSourceType: remote_data_center is a fixed value.
-   * - FileId: the file ID.
-   * - Database: the database name returned by the ListDataCenterTable operation, which is typically the file name.
-   * - Tables: the table name returned by the ListDataCenterTable operation.
-   * - TableIds: the TableId returned by the ListDataCenterTable operation.
-   * - RegionId: the current region.
+   * - FileId: The file ID.
+   * - Database: The database name returned by the ListDataCenterTable operation, which is usually the file name.
+   * - Tables: The table names returned by the ListDataCenterTable operation.
+   * - TableIds: The table IDs returned by the ListDataCenterTable operation.
+   * - RegionId: The current region.
    * ```
    * {
    *   "tableFlag": true,
@@ -46,17 +46,17 @@ export class CreateCustomAgentShrinkRequest extends $dara.Model {
    * }
    * ```
    * 
-   * **Database type**. Pass parameters as follows:
+   * **Database type**: Pass parameters as follows:
    * - DataSourceType: database is a fixed value.
-   * - DmsInstanceId: the DMS instance ID returned by the data center operation.
-   * - DmsDatabaseId: the DMS database ID returned by the data center operation.
-   * - FileId: the instance name (deprecated).
-   * - DbName: the database name returned by the data center operation.
-   * - Database: the database name returned by the data center operation.
-   * - Tables: the table name returned by the data center operation.
-   * - TableIds: the TableId returned by the data center operation.
-   * - Engine: the DPI engine type (mysql or postgresql).
-   * - RegionId: the current region.
+   * - DmsInstanceId: The DMS instance ID returned by the Data Center API.
+   * - DmsDatabaseId: The DMS database ID returned by the Data Center API.
+   * - FileId: The instance name. **[Deprecated]**
+   * - DbName: The database name returned by the Data Center API.
+   * - Database: The database name returned by the Data Center API.
+   * - Tables: The table names returned by the Data Center API.
+   * - TableIds: The table IDs returned by the Data Center API.
+   * - Engine: The engine type, such as mysql or postgresql.
+   * - RegionId: The current region.
    * ```
    * {
    *   "tableFlag": true,
@@ -87,7 +87,7 @@ export class CreateCustomAgentShrinkRequest extends $dara.Model {
    *   "personal" : {
    *     "DataSourceType" : "remote_data_center",
    *     "FileId" : "f-5qlrwaw10********s3gpw1z",
-   *     "Database" : "测试表格******.xlsx",
+   *     "Database" : "TestTable******.xlsx",
    *     "Tables" : [ "Sheet1" ],
    *     "TableIds" : [ "******" ],
    *     "RegionId" : "cn-hangzhou"
@@ -100,7 +100,7 @@ export class CreateCustomAgentShrinkRequest extends $dara.Model {
    * The description of the custom agent.
    * 
    * @example
-   * AgentTestDescription
+   * Agent test description
    */
   description?: string;
   /**
@@ -110,33 +110,33 @@ export class CreateCustomAgentShrinkRequest extends $dara.Model {
   executionConfigShrink?: string;
   /**
    * @remarks
-   * The instruction.
-   * - Input limit: a maximum of 10000 characters.
+   * The instructions.
+   * - Input limit: A maximum of 10,000 characters.
    * 
    * @example
    * Core metric definitions:
-   * 1. GMV (Gross Merchandise Volume) refers to the total order amount, including paid and unpaid orders.
-   * 2. Order volume is the number of valid orders placed per day.
-   * 3. UV (Unique Visitors) refers to the deduplicated number of users who visit the website or app.
-   * 4. Conversion rate = number of paid orders / UV, reflecting traffic conversion efficiency
+   * 1. GMV (Gross Merchandise Volume) refers to the total order amount, including both paid and unpaid orders.
+   * 2. Order volume refers to the number of valid orders placed per day.
+   * 3. UV (Unique Visitors) refers to the number of deduplicated users who visit the website or app.
+   * 4. Conversion rate = Number of paid orders / UV, which reflects the traffic conversion efficiency
    */
   instruction?: string;
   /**
    * @remarks
    * The knowledge.
-   * - Input limit: a maximum of 10000 characters.
+   * - Input limit: A maximum of 10,000 characters.
    * 
    * @example
    * Core metric definitions:
-   * 1. GMV (Gross Merchandise Volume) refers to the total order amount, including paid and unpaid orders.
-   * 2. Order volume is the number of valid orders placed per day.
-   * 3. UV (Unique Visitors) refers to the deduplicated number of users who visit the website or app.
-   * 4. Conversion rate = number of paid orders / UV, reflecting traffic conversion efficiency
+   * 1. GMV (Gross Merchandise Volume) refers to the total order amount, including both paid and unpaid orders.
+   * 2. Order volume refers to the number of valid orders placed per day.
+   * 3. UV (Unique Visitors) refers to the number of deduplicated users who visit the website or app.
+   * 4. Conversion rate = Number of paid orders / UV, which reflects the traffic conversion efficiency
    */
   knowledge?: string;
   /**
    * @remarks
-   * The external knowledge base.
+   * The external knowledge bases.
    */
   knowledgeConfigListShrink?: string;
   knowledgeSemanticConfigListShrink?: string;
@@ -145,12 +145,15 @@ export class CreateCustomAgentShrinkRequest extends $dara.Model {
    * The name of the custom agent.
    * 
    * @example
-   * AgentTestName
+   * Agent test name
    */
   name?: string;
   /**
    * @remarks
    * The ID of the referenced historical session.
+   * 
+   * @example
+   * 99crainsjnveo*******vynid
    */
   relatedSessionId?: string;
   /**
@@ -163,18 +166,29 @@ export class CreateCustomAgentShrinkRequest extends $dara.Model {
    * The text report format.
    * 
    * @example
-   * The text report requires all numbers to be expressed in Chinese characters instead of Arabic numerals
+   * All numbers in the text report must be written in Chinese characters instead of Arabic numerals
    */
   textReportConfig?: string;
+  /**
+   * @remarks
+   * The list of user-specified skills.
+   */
   userSpecifiedSkillListShrink?: string;
   /**
    * @remarks
    * The web report format.
    * 
    * @example
-   * The web report requires all numbers to be expressed in Chinese characters instead of Arabic numerals
+   * All numbers in the web report must be written in Chinese characters instead of Arabic numerals
    */
   webReportConfig?: string;
+  /**
+   * @remarks
+   * The web report theme.
+   * 
+   * @example
+   * Default
+   */
   webReportTheme?: string;
   /**
    * @remarks

package/src/models/DescribeCustomAgentMonitorMetricsRequest.ts

@@ -0,0 +1,92 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeCustomAgentMonitorMetricsRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The custom agent ID.
+   * - Required only when QueryType is set to CustomAgent.
+   * 
+   * @example
+   * ca-a9fd******0lnq4g6c
+   */
+  customAgentId?: string;
+  /**
+   * @remarks
+   * The end time of the statistical period (epoch millis).
+   * - Note: The maximum time range is 3 months.
+   * 
+   * @example
+   * 1756742400000
+   */
+  endTime?: number;
+  /**
+   * @remarks
+   * The aggregation granularity. Valid values:
+   * - DAY: daily. The maximum supported time range is 3 months.
+   * - HOUR: hourly. The maximum supported time range is 72 hours.
+   * 
+   * @example
+   * DAY
+   */
+  granularity?: string;
+  /**
+   * @remarks
+   * The statistical scope. Default value: All. Valid values:
+   * - Default: default DataAgent sessions.
+   * - CustomAgent: specified custom agent sessions.
+   * - All: all sessions in the workspace.
+   * 
+   * @example
+   * All
+   */
+  queryType?: string;
+  /**
+   * @remarks
+   * The start time of the statistical period (epoch millis).
+   * - Note: The maximum time range is 3 months.
+   * 
+   * @example
+   * 1756656000000
+   */
+  startTime?: number;
+  /**
+   * @remarks
+   * The workspace ID.
+   * 
+   * @example
+   * 99fad******qg6c0l4nlacu
+   */
+  workspaceId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      customAgentId: 'CustomAgentId',
+      endTime: 'EndTime',
+      granularity: 'Granularity',
+      queryType: 'QueryType',
+      startTime: 'StartTime',
+      workspaceId: 'WorkspaceId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      customAgentId: 'string',
+      endTime: 'number',
+      granularity: 'string',
+      queryType: 'string',
+      startTime: 'number',
+      workspaceId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeCustomAgentMonitorMetricsResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { DescribeCustomAgentMonitorMetricsResponseBody } from "./DescribeCustomAgentMonitorMetricsResponseBody";
+
+
+export class DescribeCustomAgentMonitorMetricsResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: DescribeCustomAgentMonitorMetricsResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: DescribeCustomAgentMonitorMetricsResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeCustomAgentMonitorMetricsResponseBody.ts

@@ -0,0 +1,267 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeCustomAgentMonitorMetricsResponseBodyDataTrend extends $dara.Model {
+  /**
+   * @remarks
+   * The number of active users within the statistical period.
+   * 
+   * @example
+   * 2
+   */
+  activeUserCount?: number;
+  /**
+   * @remarks
+   * The number of dislikes within the statistical period.
+   * 
+   * @example
+   * 0
+   */
+  dislikeCount?: number;
+  /**
+   * @remarks
+   * The number of likes within the statistical period.
+   * 
+   * @example
+   * 1
+   */
+  likeCount?: number;
+  /**
+   * @remarks
+   * The number of sessions within the statistical period.
+   * 
+   * @example
+   * 10
+   */
+  sessionCount?: number;
+  /**
+   * @remarks
+   * The statistical time. For daily granularity, the format is 2026-09-01. For hourly granularity, the format is 2026-09-01 13:00.
+   * 
+   * @example
+   * 2026-09-01
+   */
+  statTime?: string;
+  /**
+   * @remarks
+   * The start timestamp of the statistical period (epoch millis).
+   * 
+   * @example
+   * 1782835200000
+   */
+  timestamp?: number;
+  static names(): { [key: string]: string } {
+    return {
+      activeUserCount: 'ActiveUserCount',
+      dislikeCount: 'DislikeCount',
+      likeCount: 'LikeCount',
+      sessionCount: 'SessionCount',
+      statTime: 'StatTime',
+      timestamp: 'Timestamp',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      activeUserCount: 'number',
+      dislikeCount: 'number',
+      likeCount: 'number',
+      sessionCount: 'number',
+      statTime: 'string',
+      timestamp: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribeCustomAgentMonitorMetricsResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The number of active users.
+   * 
+   * @example
+   * 6
+   */
+  activeUserCount?: number;
+  /**
+   * @remarks
+   * The custom agent ID.
+   * 
+   * @example
+   * ca-4y3ca4khkcu**********ysf
+   */
+  customAgentId?: string;
+  /**
+   * @remarks
+   * The total number of dislikes.
+   * 
+   * @example
+   * 0
+   */
+  dislikeCount?: number;
+  /**
+   * @remarks
+   * The end time of the statistical period (epoch millis).
+   * 
+   * @example
+   * 1756742400000
+   */
+  endTime?: number;
+  /**
+   * @remarks
+   * The aggregation granularity: DAY / HOUR.
+   * 
+   * @example
+   * DAY
+   */
+  granularity?: string;
+  /**
+   * @remarks
+   * The total number of likes.
+   * 
+   * @example
+   * 10
+   */
+  likeCount?: number;
+  /**
+   * @remarks
+   * The total number of sessions.
+   * 
+   * @example
+   * 102
+   */
+  sessionCount?: number;
+  /**
+   * @remarks
+   * The start time of the statistical period (epoch millis).
+   * 
+   * @example
+   * 1782835200000
+   */
+  startTime?: number;
+  /**
+   * @remarks
+   * The trend data aggregated by the specified granularity. Time points without data are filled with 0. The data is sorted in chronological order.
+   */
+  trend?: DescribeCustomAgentMonitorMetricsResponseBodyDataTrend[];
+  static names(): { [key: string]: string } {
+    return {
+      activeUserCount: 'ActiveUserCount',
+      customAgentId: 'CustomAgentId',
+      dislikeCount: 'DislikeCount',
+      endTime: 'EndTime',
+      granularity: 'Granularity',
+      likeCount: 'LikeCount',
+      sessionCount: 'SessionCount',
+      startTime: 'StartTime',
+      trend: 'Trend',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      activeUserCount: 'number',
+      customAgentId: 'string',
+      dislikeCount: 'number',
+      endTime: 'number',
+      granularity: 'string',
+      likeCount: 'number',
+      sessionCount: 'number',
+      startTime: 'number',
+      trend: { 'type': 'array', 'itemType': DescribeCustomAgentMonitorMetricsResponseBodyDataTrend },
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.trend)) {
+      $dara.Model.validateArray(this.trend);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribeCustomAgentMonitorMetricsResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The response struct.
+   */
+  data?: DescribeCustomAgentMonitorMetricsResponseBodyData;
+  /**
+   * @remarks
+   * The error code returned when the request fails.
+   * 
+   * @example
+   * InvalidTid
+   */
+  errorCode?: string;
+  /**
+   * @remarks
+   * The error message returned when the call fails.
+   * 
+   * @example
+   * Specified parameter Tid is not valid.
+   */
+  errorMessage?: string;
+  /**
+   * @remarks
+   * Id of the request
+   * 
+   * @example
+   * E0D21075-CD3E-4D98-8264-FD8AD04A63B6
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * Indicates whether the request is successful. Valid values:
+   * 
+   * - **true**: The request is successful.
+   * - **false**: The request fails.
+   * 
+   * @example
+   * true
+   */
+  success?: boolean;
+  static names(): { [key: string]: string } {
+    return {
+      data: 'Data',
+      errorCode: 'ErrorCode',
+      errorMessage: 'ErrorMessage',
+      requestId: 'RequestId',
+      success: 'Success',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      data: DescribeCustomAgentMonitorMetricsResponseBodyData,
+      errorCode: 'string',
+      errorMessage: 'string',
+      requestId: 'string',
+      success: 'boolean',
+    };
+  }
+
+  validate() {
+    if(this.data && typeof (this.data as any).validate === 'function') {
+      (this.data as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+