@alicloud/dms20250414 1.14.0 → 1.14.2

package/src/models/ListDataAgentSessionRequest.ts

@@ -4,47 +4,81 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListDataAgentSessionRequest extends $dara.Model {
   /**
+   * @remarks
+   * Session creation end time
+   * 
    * @example
    * 1770912000000
    */
   createEndTime?: number;
   /**
+   * @remarks
+   * Session creation start time
+   * 
    * @example
    * 1770825600000
    */
   createStartTime?: number;
   /**
+   * @remarks
+   * Custom Agent ID
+   * 
    * @example
    * ca-4y3ca4khkcu**********ysf
    */
   customAgentId?: string;
   /**
+   * @remarks
+   * Current DMS unit
+   * 
    * @example
    * cn-hangzhou
    */
   DMSUnit?: string;
   /**
+   * @remarks
+   * Whether to return only saved sessions
+   * 
    * @example
    * true
    */
   isSaved?: boolean;
   /**
+   * @remarks
+   * Page number for pagination
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * Number of records per page
+   * 
    * @example
    * 10
    */
   pageSize?: number;
   /**
+   * @remarks
+   * Session type. Required when you specify a collaboration workspace.
+   * 
    * @example
    * myFavorite
    */
   queryType?: string;
+  /**
+   * @remarks
+   * Data Agent title (supports fuzzy search)
+   * 
+   * @example
+   * 帮我分析一下这份数据
+   */
   title?: string;
   /**
+   * @remarks
+   * Collaboration workspace ID
+   * 
    * @example
    * 20923*****7291
    */

package/src/models/ListDataAgentSessionResponseBody.ts

@@ -4,31 +4,65 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListDataAgentSessionResponseBodyDataSessionConfig extends $dara.Model {
   /**
+   * @remarks
+   * Custom Agent ID
+   * 
    * @example
    * ca-e*******ckd
    */
   customAgentId?: string;
   /**
+   * @remarks
+   * Custom Agent usage stage:
+   * 
+   * - **debug** Debug stage
+   * 
+   * - **prod** Production stage
+   * 
    * @example
    * prod
    */
   customAgentStage?: string;
   /**
+   * @remarks
+   * Whether web search is enabled
+   * 
    * @example
    * true
    */
   enableSearch?: boolean;
   /**
+   * @remarks
+   * Language
+   * 
+   * - **CHINESE** Chinese
+   * 
+   * - **ENGLISH** English
+   * 
    * @example
    * CHINESE
    */
   language?: string;
   /**
+   * @remarks
+   * Mode:
+   * 
+   * - **ASK_DATA** Quick Inquiry Mode
+   * 
+   * - **ANALYSIS** Analysis mode
+   * 
+   * - **INSIGHT** Insight mode
+   * 
    * @example
    * ANALYSIS
    */
   mode?: string;
   /**
+   * @remarks
+   * User OSS bucket name
+   * 
+   * - Files and reports generated during analysis can be uploaded to the user-specified OSS bucket.
+   * 
    * @example
    * user-oss-bucket
    */
@@ -66,48 +100,86 @@ export class ListDataAgentSessionResponseBodyDataSessionConfig extends $dara.Mod
 
 export class ListDataAgentSessionResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * Current Agent ID
+   * 
    * @example
    * cu0cs*******mf
    */
   agentId?: string;
   /**
+   * @remarks
+   * Current Agent status
+   * 
    * @example
    * RUNNING
    */
   agentStatus?: string;
   /**
+   * @remarks
+   * Session creation time
+   * 
    * @example
    * 1731645908000
    */
   createTime?: number;
   /**
+   * @remarks
+   * Whether the session is saved by the current user in the workspace
+   * 
    * @example
    * true
    */
   favoriteInWorkspace?: boolean;
   /**
+   * @remarks
+   * File ID
+   * 
    * @example
    * f-8*******01m
    */
   file?: string;
   /**
+   * @remarks
+   * Whether the session is saved by the current user
+   * 
    * @example
    * true
    */
   saved?: boolean;
+  /**
+   * @remarks
+   * Session configuration
+   */
   sessionConfig?: ListDataAgentSessionResponseBodyDataSessionConfig;
   /**
+   * @remarks
+   * Data Agent session ID
+   * 
    * @example
    * h8r********4fch
    */
   sessionId?: string;
   /**
+   * @remarks
+   * Session status
+   * 
    * @example
    * RUNNING
    */
   sessionStatus?: string;
+  /**
+   * @remarks
+   * Title
+   * 
+   * @example
+   * 分析一下这份文件，给出报告。
+   */
   title?: string;
   /**
+   * @remarks
+   * Session owner ID
+   * 
    * @example
    * 2096******
    */
@@ -157,46 +229,75 @@ export class ListDataAgentSessionResponseBodyData extends $dara.Model {
 }
 
 export class ListDataAgentSessionResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * Response data
+   */
   data?: ListDataAgentSessionResponseBodyData[];
   /**
+   * @remarks
+   * Error code. Returned when the request fails.
+   * 
    * @example
    * success
    */
   errorCode?: string;
   /**
+   * @remarks
+   * Error message returned when the call fails.
+   * 
    * @example
    * UnknownError
    */
   errorMessage?: string;
   /**
+   * @remarks
+   * Current page number
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * Current page size
+   * 
    * @example
    * 10
    */
   pageSize?: number;
   /**
    * @remarks
-   * Id of the request
+   * Request ID
    * 
    * @example
    * E0D21075-CD3E-4D98-8264-****
    */
   requestId?: string;
   /**
+   * @remarks
+   * Whether the request succeeded. Possible values:
+   * 
+   * - **true**: The request succeeded.
+   * 
+   * - **false**: The request failed.
+   * 
    * @example
    * true
    */
   success?: boolean;
   /**
+   * @remarks
+   * Total number of records
+   * 
    * @example
    * 3
    */
   total?: number;
   /**
+   * @remarks
+   * Total number of pages
+   * 
    * @example
    * 1
    */

package/src/models/ListDataAgentWorkspaceMemberRequest.ts

@@ -4,51 +4,81 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListDataAgentWorkspaceMemberRequest extends $dara.Model {
   /**
+   * @remarks
+   * The current DMS unit.
+   * 
    * @example
    * cn-hangzhou
    */
   DMSUnit?: string;
   /**
+   * @remarks
+   * The number of entries per page.
+   * 
    * @example
    * 20
    */
   maxResults?: number;
   /**
+   * @remarks
+   * The token.
+   * 
    * @example
    * NesLoK****
    */
   nextToken?: string;
   /**
+   * @remarks
+   * The sort order.
+   * 
    * @example
    * Desc
    */
   order?: string;
   /**
+   * @remarks
+   * The sort field.
+   * 
    * @example
    * gmt_create
    */
   orderBy?: string;
   /**
+   * @remarks
+   * The page number.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries to return on each page.
+   * 
    * @example
    * 10
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The prefix of the member ID to query.
+   * 
    * @example
    * 20273
    */
   searchMemberId?: string;
   /**
+   * @remarks
+   * The prefix of the member name to query.
+   * 
    * @example
    * yunqi
    */
   searchRoleName?: string;
   /**
+   * @remarks
+   * The workspace ID.
+   * 
    * @example
    * 20923*****7291
    */

package/src/models/ListDataAgentWorkspaceMemberResponseBody.ts

@@ -4,31 +4,49 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListDataAgentWorkspaceMemberResponseBodyDataContent extends $dara.Model {
   /**
+   * @remarks
+   * The time when the user joined the workspace. This is a UNIX timestamp in seconds.
+   * 
    * @example
    * 1765961516
    */
   joinTime?: string;
   /**
+   * @remarks
+   * The Alibaba Cloud UID of the user.
+   * 
    * @example
    * 20282*****7591
    */
   memberId?: string;
   /**
+   * @remarks
+   * The name of the user\\"s role in the workspace.
+   * 
    * @example
    * member
    */
   roleName?: string;
   /**
+   * @remarks
+   * The number of tasks that are running for the user in the workspace.
+   * 
    * @example
    * 15
    */
   runningTaskNumber?: number;
   /**
+   * @remarks
+   * The total number of tasks initiated by the user in the workspace.
+   * 
    * @example
    * 30
    */
   totalTaskNumber?: number;
   /**
+   * @remarks
+   * The RAM username of the user.
+   * 
    * @example
    * yunqitest
    */
@@ -65,33 +83,55 @@ export class ListDataAgentWorkspaceMemberResponseBodyDataContent extends $dara.M
 }
 
 export class ListDataAgentWorkspaceMemberResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The data content.
+   */
   content?: ListDataAgentWorkspaceMemberResponseBodyDataContent[];
   /**
+   * @remarks
+   * The number of entries per page.
+   * 
    * @example
    * 20
    */
   maxResults?: number;
   /**
+   * @remarks
+   * The token for the next query.
+   * 
    * @example
    * no use
    */
   nextToken?: string;
   /**
+   * @remarks
+   * The total number of pages.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries returned per page.
+   * 
    * @example
    * 50
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The total number of entries.
+   * 
    * @example
    * no use
    */
   totalElements?: number;
   /**
+   * @remarks
+   * The total number of pages.
+   * 
    * @example
    * no use
    */
@@ -133,23 +173,39 @@ export class ListDataAgentWorkspaceMemberResponseBodyData extends $dara.Model {
 }
 
 export class ListDataAgentWorkspaceMemberResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The returned data.
+   */
   data?: ListDataAgentWorkspaceMemberResponseBodyData;
   /**
+   * @remarks
+   * The error code.
+   * 
    * @example
    * DMS-DA-40114
    */
   errorCode?: string;
   /**
+   * @remarks
+   * The error message.
+   * 
    * @example
    * Specified parameter is not valid.
    */
   errorMessage?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * E0D2-*****-A63B6
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful.
+   * 
    * @example
    * true
    */

package/src/models/ListDataAgentWorkspaceRequest.ts

@@ -4,32 +4,49 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListDataAgentWorkspaceRequest extends $dara.Model {
   /**
+   * @remarks
+   * The current DMS unit.
+   * 
    * @example
    * cn-hangzhou
    */
   DMSUnit?: string;
   /**
+   * @remarks
+   * This parameter is reserved for future use.
+   * 
    * @example
    * no use
    */
   maxResults?: number;
   /**
+   * @remarks
+   * This parameter is reserved for future use.
+   * 
    * @example
    * no use
    */
   nextToken?: string;
   /**
+   * @remarks
+   * The sort order.
+   * 
    * @example
    * DESC
    */
   order?: string;
   /**
+   * @remarks
+   * The field to sort by.
+   * 
    * @example
    * CreateTime
    */
   orderBy?: string;
   /**
    * @remarks
+   * The page number.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -38,6 +55,8 @@ export class ListDataAgentWorkspaceRequest extends $dara.Model {
   pageNumber?: string;
   /**
    * @remarks
+   * The number of entries to return on each page.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -45,12 +64,17 @@ export class ListDataAgentWorkspaceRequest extends $dara.Model {
    */
   pageSize?: string;
   /**
+   * @remarks
+   * The workspace name.
+   * 
    * @example
    * workspaceTest
    */
   workspaceName?: string;
   /**
    * @remarks
+   * The workspace type.
+   * 
    * This parameter is required.
    * 
    * @example