@alicloud/dms20250414 2.1.0 → 2.1.1

package/src/models/CreateAgentResponseBody.ts

@@ -3,20 +3,122 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class CreateAgentResponseBodyDataApiKey extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the agent to which the API key belongs.
+   * 
+   * @example
+   * agt-1a2b3c4d5e6f
+   */
   agentId?: string;
+  /**
+   * @remarks
+   * The name of the agent to which the API key belongs.
+   * 
+   * @example
+   * order-analysis-agent
+   */
   agentName?: string;
+  /**
+   * @remarks
+   * The permission inheritance type of the agent to which the API key belongs.
+   * 
+   * @example
+   * HUMAN_BOUND
+   */
   agentType?: string;
+  /**
+   * @remarks
+   * The time when the API key was created. The value is a time string in RFC 3339 format.
+   * 
+   * @example
+   * 2025-12-11T14:04:32Z
+   */
   createdAt?: string;
+  /**
+   * @remarks
+   * The user ID of the user who created the API key.
+   * 
+   * @example
+   * usr-1a2b3c4d
+   */
   creatorId?: string;
+  /**
+   * @remarks
+   * The name of the user who created the API key.
+   * 
+   * @example
+   * John Doe
+   */
   creatorName?: string;
+  /**
+   * @remarks
+   * The description of the API key.
+   * 
+   * @example
+   * Access Token automatically issued when the Agent is created
+   */
   description?: string;
+  /**
+   * @remarks
+   * The expiration time of the API key. The value is a time string in RFC 3339 format.
+   * 
+   * @example
+   * 2026-12-11T14:04:32Z
+   */
   expireTime?: string;
+  /**
+   * @remarks
+   * The primary key ID of the API key.
+   * 
+   * @example
+   * 1001
+   */
   id?: number;
+  /**
+   * @remarks
+   * Indicates whether the API key has been revoked.
+   */
   isRevoked?: boolean;
+  /**
+   * @remarks
+   * The non-sensitive visible prefix of the API key plaintext, used to identify the credential. The plaintext secret is not returned again.
+   * 
+   * @example
+   * dms_sk_1a2b
+   */
   keyPrefix?: string;
+  /**
+   * @remarks
+   * The time when the API key was last used. The value is a time string in RFC 3339 format. This parameter is empty if the API key has never been used.
+   * 
+   * @example
+   * 2025-12-12T09:30:00Z
+   */
   lastUsedTime?: string;
+  /**
+   * @remarks
+   * The name of the API key.
+   * 
+   * @example
+   * order-analysis-agent-default
+   */
   name?: string;
+  /**
+   * @remarks
+   * The plaintext secret of the API key. This value is returned only once in this creation response. Store it securely. Subsequent API calls do not return the plaintext secret again.
+   * 
+   * @example
+   * dms_sk_1a2b3c4d****
+   */
   secret?: string;
+  /**
+   * @remarks
+   * The credential source. Valid values: console (issued from the console), oauth (issued through the OAuth flow), install_token (issued through the install-and-authenticate flow). The API key automatically issued by this operation is always console.
+   * 
+   * @example
+   * console
+   */
   source?: string;
   static names(): { [key: string]: string } {
     return {
@@ -68,14 +170,74 @@ export class CreateAgentResponseBodyDataApiKey extends $dara.Model {
 }
 
 export class CreateAgentResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The globally unique ID of the agent.
+   * 
+   * @example
+   * agt-1a2b3c4d5e6f
+   */
   agentId?: string;
+  /**
+   * @remarks
+   * The agent name.
+   * 
+   * @example
+   * order-analysis-agent
+   */
   agentName?: string;
+  /**
+   * @remarks
+   * The permission inheritance type of the agent. Valid values: HUMAN_BOUND (inherits user permissions), PERMISSION_NARROW (narrows permissions), STANDALONE (operates as an independent identity principal without inheriting permissions from other principals).
+   * 
+   * @example
+   * HUMAN_BOUND
+   */
   agentType?: string;
+  /**
+   * @remarks
+   * The automatically issued API key for the new agent. The plaintext secret is returned only once in this response.
+   */
   apiKey?: CreateAgentResponseBodyDataApiKey;
+  /**
+   * @remarks
+   * The time when the agent was created. The value is a time string in RFC 3339 format.
+   * 
+   * @example
+   * 2025-12-11T14:04:32Z
+   */
   createdAt?: string;
+  /**
+   * @remarks
+   * The creation method of the agent. Valid values: manual (manually created in the console), auto (automatic creation by the system). Agents created by this operation are always manual.
+   * 
+   * @example
+   * manual
+   */
   creationType?: string;
+  /**
+   * @remarks
+   * The description of the agent.
+   * 
+   * @example
+   * An agent for querying and analyzing order data
+   */
   description?: string;
+  /**
+   * @remarks
+   * The user ID of the agent owner, which is the current user who initiated the creation request.
+   * 
+   * @example
+   * usr-1a2b3c4d
+   */
   ownerId?: string;
+  /**
+   * @remarks
+   * The status of the agent. Valid values: active (enabled), disabled (disabled), deleted (deleted). A newly created agent is always active.
+   * 
+   * @example
+   * active
+   */
   status?: string;
   static names(): { [key: string]: string } {
     return {
@@ -118,10 +280,39 @@ export class CreateAgentResponseBodyData extends $dara.Model {
 }
 
 export class CreateAgentResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The agent information and the automatically issued API key returned after the agent is created.
+   */
   data?: CreateAgentResponseBodyData;
+  /**
+   * @remarks
+   * The status code of the request result. A value of success indicates success. A specific error code is returned upon failure.
+   * 
+   * @example
+   * success
+   */
   errorCode?: string;
+  /**
+   * @remarks
+   * The error message returned when the request fails. This parameter is empty when the request succeeds.
+   * 
+   * @example
+   * agentName must not be blank
+   */
   errorMessage?: string;
+  /**
+   * @remarks
+   * The unique ID of the request. You can use this ID for troubleshooting and tracing.
+   * 
+   * @example
+   * 67E910F2-4B62-5B0C-ACA3-7547695C****
+   */
   requestId?: string;
+  /**
+   * @remarks
+   * Indicates whether the request was successful.
+   */
   success?: boolean;
   static names(): { [key: string]: string } {
     return {

package/src/models/CreateDataAgentSessionRequest.ts

@@ -2,6 +2,86 @@
 import * as $dara from '@darabonba/typescript';
 
 
+export class CreateDataAgentSessionRequestSessionConfigMcpHeadersMcpHeader extends $dara.Model {
+  /**
+   * @remarks
+   * The key to add to the header.
+   * 
+   * @example
+   * UserId
+   */
+  key?: string;
+  /**
+   * @remarks
+   * The value to add to the header.
+   * 
+   * @example
+   * 421****571
+   */
+  value?: string;
+  static names(): { [key: string]: string } {
+    return {
+      key: 'Key',
+      value: 'Value',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      key: 'string',
+      value: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class CreateDataAgentSessionRequestSessionConfigMcpHeaders extends $dara.Model {
+  /**
+   * @remarks
+   * The MCP header configuration.
+   */
+  mcpHeader?: CreateDataAgentSessionRequestSessionConfigMcpHeadersMcpHeader[];
+  /**
+   * @remarks
+   * The ID of the MCP server.
+   * 
+   * @example
+   * 1fl4r*****1qi
+   */
+  mcpServerId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      mcpHeader: 'McpHeader',
+      mcpServerId: 'McpServerId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      mcpHeader: { 'type': 'array', 'itemType': CreateDataAgentSessionRequestSessionConfigMcpHeadersMcpHeader },
+      mcpServerId: 'string',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.mcpHeader)) {
+      $dara.Model.validateArray(this.mcpHeader);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
 export class CreateDataAgentSessionRequestSessionConfig extends $dara.Model {
   /**
    * @remarks
@@ -14,8 +94,8 @@ export class CreateDataAgentSessionRequestSessionConfig extends $dara.Model {
   /**
    * @remarks
    * The stage of the custom agent. Valid values:
-   * - **debug**: Debug stage.
-   * - **prod**: Production stage.
+   * - **debug**: the debugging stage.
+   * - **prod**: the production stage.
    * 
    * @example
    * debug
@@ -60,6 +140,11 @@ export class CreateDataAgentSessionRequestSessionConfig extends $dara.Model {
    * CHINESE
    */
   language?: string;
+  /**
+   * @remarks
+   * The list of MCP header configurations.
+   */
+  mcpHeaders?: CreateDataAgentSessionRequestSessionConfigMcpHeaders[];
   /**
    * @remarks
    * The list of MCP server IDs in the session configuration.
@@ -68,9 +153,9 @@ export class CreateDataAgentSessionRequestSessionConfig extends $dara.Model {
   /**
    * @remarks
    * The mode. Valid values:
-   * - **ASK_DATA**: Ask data mode.
-   * - **ANALYSIS**: Analysis mode.
-   * - **INSIGHT**: Insight mode.
+   *  - **ASK_DATA**: the data query mode.
+   *  - **ANALYSIS**: the analysis mode.
+   *  - **INSIGHT**: the insight mode.
    * 
    * @example
    * ANALYSIS
@@ -94,8 +179,7 @@ export class CreateDataAgentSessionRequestSessionConfig extends $dara.Model {
   reportWaterMark?: string;
   /**
    * @remarks
-   * The name of the user OSS bucket.
-   * - Analysis process files and report artifacts can be uploaded to the specified OSS bucket.
+   * The name of the user OSS bucket. Analysis process files and report artifacts can be uploaded to the specified OSS bucket.
    * 
    * @example
    * user-oss-bucket
@@ -110,6 +194,7 @@ export class CreateDataAgentSessionRequestSessionConfig extends $dara.Model {
       encryptType: 'EncryptType',
       kbUuidList: 'KbUuidList',
       language: 'Language',
+      mcpHeaders: 'McpHeaders',
       mcpServerIds: 'McpServerIds',
       mode: 'Mode',
       reportPageWidth: 'ReportPageWidth',
@@ -127,6 +212,7 @@ export class CreateDataAgentSessionRequestSessionConfig extends $dara.Model {
       encryptType: 'string',
       kbUuidList: { 'type': 'array', 'itemType': 'string' },
       language: 'string',
+      mcpHeaders: { 'type': 'array', 'itemType': CreateDataAgentSessionRequestSessionConfigMcpHeaders },
       mcpServerIds: { 'type': 'array', 'itemType': 'string' },
       mode: 'string',
       reportPageWidth: 'number',
@@ -139,6 +225,9 @@ export class CreateDataAgentSessionRequestSessionConfig extends $dara.Model {
     if(Array.isArray(this.kbUuidList)) {
       $dara.Model.validateArray(this.kbUuidList);
     }
+    if(Array.isArray(this.mcpHeaders)) {
+      $dara.Model.validateArray(this.mcpHeaders);
+    }
     if(Array.isArray(this.mcpServerIds)) {
       $dara.Model.validateArray(this.mcpServerIds);
     }

package/src/models/CreateDataAgentSessionResponseBody.ts

@@ -14,8 +14,8 @@ export class CreateDataAgentSessionResponseBodyDataSessionConfig extends $dara.M
   /**
    * @remarks
    * The stage of the custom agent. Valid values:
-   * - **debug**: Debug stage.
-   * - **prod**: Production stage.
+   * - **debug**: the debugging stage.
+   * - **prod**: the production stage.
    * 
    * @example
    * debug
@@ -68,9 +68,9 @@ export class CreateDataAgentSessionResponseBodyDataSessionConfig extends $dara.M
   /**
    * @remarks
    * The mode. Valid values:
-   * - **ASK_DATA**: Ask data mode.
-   * - **ANALYSIS**: Analysis mode.
-   * - **INSIGHT**: Insight mode.
+   *  - **ASK_DATA**: the data query mode.
+   *  - **ANALYSIS**: the analysis mode.
+   *  - **INSIGHT**: the insight mode.
    * 
    * @example
    * ANALYSIS
@@ -94,8 +94,7 @@ export class CreateDataAgentSessionResponseBodyDataSessionConfig extends $dara.M
   reportWaterMark?: string;
   /**
    * @remarks
-   * The name of the user OSS bucket.
-   * - Analysis process files and report artifacts can be uploaded to the specified OSS bucket.
+   * The name of the user OSS bucket. Analysis process files and report artifacts can be uploaded to the specified OSS bucket.
    * 
    * @example
    * user-oss-bucket
@@ -169,7 +168,7 @@ export class CreateDataAgentSessionResponseBodyData extends $dara.Model {
   agentStatus?: string;
   /**
    * @remarks
-   * The time when the session was created.
+   * The creation time of the session.
    * 
    * @example
    * 1765262307992
@@ -177,7 +176,7 @@ export class CreateDataAgentSessionResponseBodyData extends $dara.Model {
   createTime?: number;
   /**
    * @remarks
-   * The basic information about the file.
+   * The basic information of the file.
    * 
    * @example
    * f-8*******01m
@@ -276,7 +275,7 @@ export class CreateDataAgentSessionResponseBody extends $dara.Model {
   errorCode?: string;
   /**
    * @remarks
-   * The error message returned when the request failed.
+   * The error message returned if the request failed.
    * 
    * @example
    * UnknownError

package/src/models/GetDataAgentThemeUploadSignatureRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetDataAgentThemeUploadSignatureRequest extends $dara.Model {
   /**
    * @remarks
-   * The theme UUID. By default, you do not need to specify this parameter because the backend automatically generates and returns a UUID. Specify this parameter to regenerate a signature only when the previous signature has expired.
+   * The UUID of the theme. By default, you do not need to specify this parameter because the backend automatically generates and returns a UUID. Specify this parameter to regenerate the signature only when the previous signature has expired.
    * 
    * @example
    * 0f8b2c1d-****-****-****-9a3e5f7b1c2d

package/src/models/GetDataAgentThemeUploadSignatureResponseBody.ts

@@ -13,7 +13,7 @@ export class GetDataAgentThemeUploadSignatureResponseBodyData extends $dara.Mode
   expireTime?: string;
   /**
    * @remarks
-   * The target object key, which is exactly locked by the policy.
+   * The target object key that is exactly locked by the policy.
    */
   objectKey?: string;
   /**
@@ -63,7 +63,7 @@ export class GetDataAgentThemeUploadSignatureResponseBodyData extends $dara.Mode
   policy?: string;
   /**
    * @remarks
-   * The theme business identifier generated or reused for this request. Pass this identifier to the CreateDataAgentTheme operation after the upload is complete to register the metadata.
+   * The theme business ID generated or reused for this request. After the upload is complete, pass this ID to the CreateDataAgentTheme operation to register the metadata.
    * 
    * @example
    * 0f8b2c1d****a3e5f7b1c2d
@@ -76,7 +76,7 @@ export class GetDataAgentThemeUploadSignatureResponseBodyData extends $dara.Mode
   uploadDir?: string;
   /**
    * @remarks
-   * The PostObject destination address over the public network.
+   * The PostObject target address over the public network.
    * 
    * @example
    * https://**********.oss-cn-hangzhou.aliyuncs.com
@@ -131,7 +131,7 @@ export class GetDataAgentThemeUploadSignatureResponseBody extends $dara.Model {
   data?: GetDataAgentThemeUploadSignatureResponseBodyData;
   /**
    * @remarks
-   * The error code returned when the request fails.
+   * The error code. This parameter is returned only if the request fails.
    * 
    * @example
    * UnknownError
@@ -139,7 +139,7 @@ export class GetDataAgentThemeUploadSignatureResponseBody extends $dara.Model {
   errorCode?: string;
   /**
    * @remarks
-   * The error message returned when the call fails.
+   * The error message returned if the request fails.
    * 
    * @example
    * UnknownError

package/src/models/ModifyDataAgentThemeRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDataAgentThemeRequest extends $dara.Model {
   /**
    * @remarks
-   * The description of the theme. Maximum length: 255 characters. A value of null indicates that the field is not modified. An empty string clears the field.
+   * The description. Maximum length: 255 characters. A null value indicates that the field is not modified, and an empty string clears the field.
    * 
    * @example
    * weekly report
@@ -13,7 +13,7 @@ export class ModifyDataAgentThemeRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The business identifier of the theme.
+   * The business ID of the theme.
    * 
    * @example
    * 0f8b2c1d-****-****-****-9a3e5f7b1c2d
@@ -21,7 +21,7 @@ export class ModifyDataAgentThemeRequest extends $dara.Model {
   themeId?: string;
   /**
    * @remarks
-   * The display name of the theme. Maximum length: 64 characters. A value of null indicates that the field is not modified. An empty string clears the field.
+   * The display name. Maximum length: 64 characters. A null value indicates that the field is not modified, and an empty string clears the field.
    * 
    * @example
    * weekly report

package/src/models/ModifyDataAgentThemeResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDataAgentThemeResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The error code returned when the request is abnormal.
+   * The error code returned if the request failed.
    * 
    * @example
    * UnknownError
@@ -13,7 +13,7 @@ export class ModifyDataAgentThemeResponseBody extends $dara.Model {
   errorCode?: string;
   /**
    * @remarks
-   * The error message returned when the call fails.
+   * The error message returned if the request failed.
    * 
    * @example
    * UnknownError

package/src/models/model.ts

@@ -23,6 +23,8 @@ export { CreateCustomAgentResponseBodyData } from './CreateCustomAgentResponseBo
 export { CreateDataAgentAccuracyTestResponseBodyData } from './CreateDataAgentAccuracyTestResponseBody';
 export { CreateDataAgentFeedbackResponseBodyData } from './CreateDataAgentFeedbackResponseBody';
 export { CreateDataAgentKnowledgeBaseResponseBodyData } from './CreateDataAgentKnowledgeBaseResponseBody';
+export { CreateDataAgentSessionRequestSessionConfigMcpHeadersMcpHeader } from './CreateDataAgentSessionRequest';
+export { CreateDataAgentSessionRequestSessionConfigMcpHeaders } from './CreateDataAgentSessionRequest';
 export { CreateDataAgentSessionRequestSessionConfig } from './CreateDataAgentSessionRequest';
 export { CreateDataAgentSessionResponseBodyDataSessionConfig } from './CreateDataAgentSessionResponseBody';
 export { CreateDataAgentSessionResponseBodyData } from './CreateDataAgentSessionResponseBody';