@alicloud/dms20250414 3.0.0 → 3.1.0

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);
+  }
+}
+

package/src/models/Dlcatalog.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class DLCatalog extends $dara.Model {
   /**
+   * @remarks
+   * The description of the data catalog.
+   * 
    * @example
    * init default catalog
    */
   description?: string;
   /**
+   * @remarks
+   * The storage path of the data catalog.
+   * 
    * @example
    * oss://xxxx
    */
   location?: string;
   /**
+   * @remarks
+   * The name of the data catalog.
+   * 
    * @example
    * hive
    */

package/src/models/ListCustomAgentMonitorSessionsRequest.ts

@@ -0,0 +1,100 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class ListCustomAgentMonitorSessionsRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The custom agent ID.
+   * - Required only when QueryType is set to CustomAgent.
+   * 
+   * @example
+   * ca-4y3ca4khkcu**********ysf
+   */
+  customAgentId?: string;
+  /**
+   * @remarks
+   * The end time for statistics (epoch millis).
+   * - Note: The maximum time range is 3 months.
+   * 
+   * @example
+   * 1756742400000
+   */
+  endTime?: number;
+  /**
+   * @remarks
+   * The page number, starting from 1. Default value: 1.
+   * 
+   * @example
+   * 1
+   */
+  pageNumber?: number;
+  /**
+   * @remarks
+   * The number of entries per page. Valid values: 1 to 200. Default value: 20.
+   * 
+   * @example
+   * 20
+   */
+  pageSize?: number;
+  /**
+   * @remarks
+   * The query 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 for statistics (epoch millis).
+   * - Note: The maximum time range is 3 months.
+   * 
+   * @example
+   * 1756656000000
+   */
+  startTime?: number;
+  /**
+   * @remarks
+   * The workspace ID.
+   * 
+   * @example
+   * 56kv1pvl9uvt9**********bb
+   */
+  workspaceId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      customAgentId: 'CustomAgentId',
+      endTime: 'EndTime',
+      pageNumber: 'PageNumber',
+      pageSize: 'PageSize',
+      queryType: 'QueryType',
+      startTime: 'StartTime',
+      workspaceId: 'WorkspaceId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      customAgentId: 'string',
+      endTime: 'number',
+      pageNumber: 'number',
+      pageSize: 'number',
+      queryType: 'string',
+      startTime: 'number',
+      workspaceId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/ListCustomAgentMonitorSessionsResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { ListCustomAgentMonitorSessionsResponseBody } from "./ListCustomAgentMonitorSessionsResponseBody";
+
+
+export class ListCustomAgentMonitorSessionsResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: ListCustomAgentMonitorSessionsResponseBody;
+  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: ListCustomAgentMonitorSessionsResponseBody,
+    };
+  }
+
+  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/ListCustomAgentMonitorSessionsResponseBody.ts

@@ -0,0 +1,283 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class ListCustomAgentMonitorSessionsResponseBodyDataContent extends $dara.Model {
+  /**
+   * @remarks
+   * The Alibaba Cloud UID of the creator.
+   * 
+   * @example
+   * 20372822********
+   */
+  aliyunUid?: string;
+  /**
+   * @remarks
+   * The display name of the creator.
+   * 
+   * @example
+   * HaoY***
+   */
+  creatorUserName?: string;
+  /**
+   * @remarks
+   * The custom agent ID.
+   * 
+   * @example
+   * ca-4y3ca4khkcu**********ysf
+   */
+  customAgentId?: string;
+  /**
+   * @remarks
+   * The number of dislikes for the session.
+   * 
+   * @example
+   * 0
+   */
+  dislikeCount?: number;
+  /**
+   * @remarks
+   * The creation time.
+   * 
+   * @example
+   * 2026-03-18T10:02:04+08:00
+   */
+  gmtCreated?: string;
+  /**
+   * @remarks
+   * The modification time.
+   * 
+   * @example
+   * 2025-12-11T14:04:32.000+00:00
+   */
+  gmtModified?: string;
+  /**
+   * @remarks
+   * The number of likes for the session.
+   * 
+   * @example
+   * 2
+   */
+  likeCount?: number;
+  /**
+   * @remarks
+   * The session ID.
+   * 
+   * @example
+   * 2gum46f149******ndfxxo
+   */
+  sessionId?: string;
+  /**
+   * @remarks
+   * The session status. Valid values:
+   * - init: The session is in the initial state.
+   * - INITIALIZING: The session is being initialized.
+   * - RUNNING: The session is running.
+   * - IDLE: The session is idle.
+   * - RECOVERABLE: The session is completed and can accept further questions.
+   * - UNAVAILABLE: The session is completed and cannot accept further questions.
+   * 
+   * @example
+   * RUNNING
+   */
+  state?: string;
+  /**
+   * @remarks
+   * The session name.
+   * 
+   * @example
+   * Please analyze this data
+   */
+  title?: string;
+  /**
+   * @remarks
+   * The total number of turns in the session.
+   * 
+   * @example
+   * 10
+   */
+  turnCount?: number;
+  static names(): { [key: string]: string } {
+    return {
+      aliyunUid: 'AliyunUid',
+      creatorUserName: 'CreatorUserName',
+      customAgentId: 'CustomAgentId',
+      dislikeCount: 'DislikeCount',
+      gmtCreated: 'GmtCreated',
+      gmtModified: 'GmtModified',
+      likeCount: 'LikeCount',
+      sessionId: 'SessionId',
+      state: 'State',
+      title: 'Title',
+      turnCount: 'TurnCount',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      aliyunUid: 'string',
+      creatorUserName: 'string',
+      customAgentId: 'string',
+      dislikeCount: 'number',
+      gmtCreated: 'string',
+      gmtModified: 'string',
+      likeCount: 'number',
+      sessionId: 'string',
+      state: 'string',
+      title: 'string',
+      turnCount: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class ListCustomAgentMonitorSessionsResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The session details list for the current page, sorted by creation time in descending order.
+   */
+  content?: ListCustomAgentMonitorSessionsResponseBodyDataContent[];
+  /**
+   * @remarks
+   * The current page number.
+   * 
+   * @example
+   * 1
+   */
+  pageNumber?: number;
+  /**
+   * @remarks
+   * The number of entries per page.
+   * 
+   * @example
+   * 20
+   */
+  pageSize?: number;
+  /**
+   * @remarks
+   * The total number of sessions within the filter scope.
+   * 
+   * @example
+   * 5
+   */
+  totalElements?: number;
+  /**
+   * @remarks
+   * The total number of pages.
+   * 
+   * @example
+   * 1
+   */
+  totalPages?: number;
+  static names(): { [key: string]: string } {
+    return {
+      content: 'Content',
+      pageNumber: 'PageNumber',
+      pageSize: 'PageSize',
+      totalElements: 'TotalElements',
+      totalPages: 'TotalPages',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      content: { 'type': 'array', 'itemType': ListCustomAgentMonitorSessionsResponseBodyDataContent },
+      pageNumber: 'number',
+      pageSize: 'number',
+      totalElements: 'number',
+      totalPages: 'number',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.content)) {
+      $dara.Model.validateArray(this.content);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class ListCustomAgentMonitorSessionsResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The response struct.
+   */
+  data?: ListCustomAgentMonitorSessionsResponseBodyData;
+  /**
+   * @remarks
+   * The error code returned if the call fails.
+   * 
+   * @example
+   * InvalidTid
+   */
+  errorCode?: string;
+  /**
+   * @remarks
+   * The error message returned if 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 was successful. Valid values:
+   * 
+   * - **true**: The request was successful.
+   * - **false**: The request failed.
+   * 
+   * @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: ListCustomAgentMonitorSessionsResponseBodyData,
+      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);
+  }
+}
+