@alicloud/agentcore20260804 2.5.0 → 3.0.0

package/src/models/CreateCustomAgentResponseBody.ts

@@ -13,7 +13,7 @@ export class CreateCustomAgentResponseBodyDataAgenticFsMounts extends $dara.Mode
   mountPath?: string;
   /**
    * @remarks
-   * The relative directory within the mounted AccessPoint.
+   * The relative directory within the mounted access point.
    * 
    * @example
    * workspace/data
@@ -22,8 +22,8 @@ export class CreateCustomAgentResponseBodyDataAgenticFsMounts extends $dara.Mode
   /**
    * @remarks
    * Specifies whether the mount is read-only. Valid values:
-   * - true: The mount is read-only.
-   * - false: The mount is readable and writable.
+   * - true: Read-only.
+   * - false: Readable and writable.
    * 
    * @example
    * false
@@ -31,7 +31,7 @@ export class CreateCustomAgentResponseBodyDataAgenticFsMounts extends $dara.Mode
   readOnly?: boolean;
   /**
    * @remarks
-   * The domain name of the AgenticFS AccessPoint used for the mount.
+   * The domain name of the AgenticFS access point used for the mount.
    * 
    * @example
    * ap-0123456789abcdef0.0123456789-vlm36.cn-hangzhou.nas.aliyuncs.com
@@ -67,32 +67,32 @@ export class CreateCustomAgentResponseBodyDataAgenticFsMounts extends $dara.Mode
 export class CreateCustomAgentResponseBodyDataArtifactCode extends $dara.Model {
   /**
    * @remarks
-   * The startup entry point of the code package. Code package deployment is not supported.
+   * The startup command for the code package. This parameter is required in code package mode. The working directory is the root directory of the extracted code, which is /code. Example: python main.py. Quotes and escapes are supported. Environment variables, pipes, and logical operations are not automatically expanded. For complex commands, use a script within the package.
    * 
    * This parameter is required.
    * 
    * @example
-   * python app.py
+   * python main.py
    */
   entrypoint?: string;
   /**
    * @remarks
-   * The language runtime identifier of the code package. Code package deployment is not supported.
+   * The identifier of the code runtime environment in the currently saved configuration. The runtime image uses the saved snapshot. Adding a new version to the directory does not automatically change the existing configuration.
    * 
    * This parameter is required.
    * 
    * @example
-   * python
+   * python3.12
    */
   languageRuntime?: string;
   /**
    * @remarks
-   * The source URI of the code package. Code package deployment is not supported.
+   * The oss:// address of the platform-fixed code package referenced in the currently saved configuration. This address does not include the signature parameters of the source HTTPS link. You can use this address to reuse an existing code package. To download the content, call GetAgentCodePackageDownloadUrl.
    * 
    * This parameter is required.
    * 
    * @example
-   * oss://my-agent-bucket/packages/agent.zip
+   * oss://agentcore-platform-example/code-packages/workspaces/ws-a1b2c3d4e5f6/550e8400-e29b-41d4-a716-446655440000/package.zip
    */
   sourceUri?: string;
   static names(): { [key: string]: string } {
@@ -213,7 +213,7 @@ export class CreateCustomAgentResponseBodyDataArtifactContainer extends $dara.Mo
 export class CreateCustomAgentResponseBodyDataArtifact extends $dara.Model {
   /**
    * @remarks
-   * The code package configuration field. Code package deployment is not supported.
+   * The code package deployment configuration. This parameter is mutually exclusive with container. Code packages use the ZIP or TAR.GZ format. Dependencies must be packaged by the user. The platform does not install dependencies or perform online builds.
    */
   code?: CreateCustomAgentResponseBodyDataArtifactCode;
   /**
@@ -223,7 +223,7 @@ export class CreateCustomAgentResponseBodyDataArtifact extends $dara.Model {
   container?: CreateCustomAgentResponseBodyDataArtifactContainer;
   /**
    * @remarks
-   * The TCP port that the agent service listens on.
+   * The TCP port listened on by the agent service.
    * 
    * This parameter is required.
    * 
@@ -262,6 +262,76 @@ export class CreateCustomAgentResponseBodyDataArtifact extends $dara.Model {
   }
 }
 
+export class CreateCustomAgentResponseBodyDataCodePackageInfo extends $dara.Model {
+  /**
+   * @remarks
+   * The CRC64 checksum of the code package object.
+   * 
+   * @example
+   * 456
+   */
+  crc64?: string;
+  /**
+   * @remarks
+   * The ETag of the code package object.
+   * 
+   * @example
+   * fixed-etag
+   */
+  etag?: string;
+  /**
+   * @remarks
+   * The original file name of the code package.
+   * 
+   * @example
+   * main.zip
+   */
+  fileName?: string;
+  /**
+   * @remarks
+   * The compressed size of the code package.
+   * 
+   * @example
+   * 123
+   */
+  fileSize?: number;
+  /**
+   * @remarks
+   * The format of the code package.
+   * 
+   * @example
+   * zip
+   */
+  format?: string;
+  static names(): { [key: string]: string } {
+    return {
+      crc64: 'crc64',
+      etag: 'etag',
+      fileName: 'fileName',
+      fileSize: 'fileSize',
+      format: 'format',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      crc64: 'string',
+      etag: 'string',
+      fileName: 'string',
+      fileSize: 'number',
+      format: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
 export class CreateCustomAgentResponseBodyDataEnvironmentVariables extends $dara.Model {
   /**
    * @remarks
@@ -355,7 +425,7 @@ export class CreateCustomAgentResponseBodyDataHealthCheck extends $dara.Model {
   intervalSeconds?: number;
   /**
    * @remarks
-   * The HTTP health check path.
+   * The HTTP Health Check Path.
    * 
    * @example
    * /healthz
@@ -419,7 +489,7 @@ export class CreateCustomAgentResponseBodyDataHealthCheck extends $dara.Model {
 export class CreateCustomAgentResponseBodyDataImageCachePreparation extends $dara.Model {
   /**
    * @remarks
-   * The value is the same as imageCacheId in the same response and belongs to the current workspace.
+   * The ID of the cache associated with this request.
    * 
    * This parameter is required.
    * 
@@ -429,7 +499,7 @@ export class CreateCustomAgentResponseBodyDataImageCachePreparation extends $dar
   imageId?: string;
   /**
    * @remarks
-   * The acceptance snapshot of the current request, which can be PENDING, READY, or FAILED. This does not represent the real-time status. You can query the real-time status later by calling GetImageCache.
+   * The cache status at the time of acceptance.
    * 
    * This parameter is required.
    * 
@@ -439,7 +509,7 @@ export class CreateCustomAgentResponseBodyDataImageCachePreparation extends $dar
   statusAtAcceptance?: string;
   /**
    * @remarks
-   * The value is fixed as ACCEPTED, indicating that the logical association and preparation intent are confirmed.
+   * The acceptance status of the cache preparation.
    * 
    * This parameter is required.
    * 
@@ -475,7 +545,7 @@ export class CreateCustomAgentResponseBodyDataImageCachePreparation extends $dar
 export class CreateCustomAgentResponseBodyDataLatestExecutionError extends $dara.Model {
   /**
    * @remarks
-   * The reason code for the waiting or execution failure of the latest configuration. This code is used to determine the subsequent handling method.
+   * The reason code for the wait or execution failure of the latest configuration, which is used to determine the subsequent handling method.
    * 
    * This parameter is required.
    * 
@@ -485,7 +555,7 @@ export class CreateCustomAgentResponseBodyDataLatestExecutionError extends $dara
   code?: string;
   /**
    * @remarks
-   * The description of the reason why the latest configuration is waiting or failed to execute. Refer to code and retryable to determine what to do next.
+   * The description of the reason why the latest configuration failed to wait or execute. Use this field along with the code and retryable fields to determine What to do next.
    * 
    * This parameter is required.
    * 
@@ -495,7 +565,7 @@ export class CreateCustomAgentResponseBodyDataLatestExecutionError extends $dara
   message?: string;
   /**
    * @remarks
-   * Specifies whether automatic retries are performed. If the value is true, you can query again later. If the value is false, check and fix the configuration based on the reason, and then resubmit the request.
+   * Specifies whether the system automatically retries the operation. If the value is true, you can query the status again later. If the value is false, check and fix the configuration based on the failure reason, and then resubmit the request.
    * 
    * This parameter is required.
    */
@@ -652,12 +722,12 @@ export class CreateCustomAgentResponseBodyDataNetworkAccessVpc extends $dara.Mod
 export class CreateCustomAgentResponseBodyDataNetwork extends $dara.Model {
   /**
    * @remarks
-   * The Internet access configuration of the agent. If this parameter is not configured, Internet access is allowed on the agent side but is still restricted by the workspace.
+   * The Internet access configuration of the agent. If this field is not configured, Internet access is allowed on the agent side but is still restricted by the workspace.
    */
   accessInternet?: CreateCustomAgentResponseBodyDataNetworkAccessInternet;
   /**
    * @remarks
-   * The user VPC access configuration of the agent. If this parameter is not configured, user VPC access is allowed on the agent side but is still restricted by the workspace.
+   * The user VPC access configuration of the agent. If this field is not configured, user VPC access is allowed on the agent side but is still restricted by the workspace.
    */
   accessVpc?: CreateCustomAgentResponseBodyDataNetworkAccessVpc;
   static names(): { [key: string]: string } {
@@ -692,7 +762,7 @@ export class CreateCustomAgentResponseBodyDataNetwork extends $dara.Model {
 export class CreateCustomAgentResponseBodyDataObservability extends $dara.Model {
   /**
    * @remarks
-   * Default value: true. If set to false, the platform Python probe is not loaded at runtime, and you must collect observability data yourself.
+   * Specifies whether to enable agent observability.
    */
   enabled?: boolean;
   static names(): { [key: string]: string } {
@@ -744,8 +814,8 @@ export class CreateCustomAgentResponseBodyDataOssMounts extends $dara.Model {
   /**
    * @remarks
    * Specifies whether the mount is read-only. Valid values:
-   * - true: The mount is read-only.
-   * - false: The mount is readable and writable.
+   * - true: Read-only.
+   * - false: Readable and writable.
    */
   readOnly?: boolean;
   static names(): { [key: string]: string } {
@@ -778,7 +848,7 @@ export class CreateCustomAgentResponseBodyDataOssMounts extends $dara.Model {
 export class CreateCustomAgentResponseBodyDataProtocolPaths extends $dara.Model {
   /**
    * @remarks
-   * The purpose description of the current API path.
+   * The usage description of the current API path.
    * 
    * @example
    * AG-UI conversation API
@@ -820,7 +890,7 @@ export class CreateCustomAgentResponseBodyDataProtocolPaths extends $dara.Model
 export class CreateCustomAgentResponseBodyDataProtocol extends $dara.Model {
   /**
    * @remarks
-   * The request header configuration for the current protocol. The key is the name and the value is a string.
+   * The request header configuration for the current protocol. The key is the header name, and the value is a string.
    */
   headers?: { [key: string]: string };
   /**
@@ -830,7 +900,7 @@ export class CreateCustomAgentResponseBodyDataProtocol extends $dara.Model {
   paths?: CreateCustomAgentResponseBodyDataProtocolPaths[];
   /**
    * @remarks
-   * The invocation protocol type. Valid values: agui: AG-UI protocol; openai-chat-completion: OpenAI Chat Completions compatible protocol; custom: custom protocol.
+   * The invocation protocol type. Valid values: agui: AG-UI protocol. openai-chat-completion: OpenAI Chat Completions compatible protocol. custom: Custom protocol.
    * 
    * This parameter is required.
    * 
@@ -872,7 +942,7 @@ export class CreateCustomAgentResponseBodyDataProtocol extends $dara.Model {
 export class CreateCustomAgentResponseBodyDataRuntimeCompute extends $dara.Model {
   /**
    * @remarks
-   * The compute specification. Valid values: INTERACTIVE: 1 vCPU and 2 GiB of memory; STANDARD: 2 vCPUs and 4 GiB of memory; HEAVY: 4 vCPUs and 8 GiB of memory.
+   * The compute specification. Valid values: INTERACTIVE: 1 vCPU and 2 GiB of memory. STANDARD: 2 vCPUs and 4 GiB of memory. HEAVY: 4 vCPUs and 8 GiB of memory.
    * 
    * This parameter is required.
    * 
@@ -904,7 +974,7 @@ export class CreateCustomAgentResponseBodyDataRuntimeCompute extends $dara.Model
 export class CreateCustomAgentResponseBodyDataRuntimeHpa extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether to enable elastic scaling. Valid values:
+   * Specifies whether elastic scaling is enabled. Valid values:
    * - true: Enabled.
    * - false: Disabled.
    * 
@@ -937,7 +1007,7 @@ export class CreateCustomAgentResponseBodyDataRuntimeHpa extends $dara.Model {
   minSandboxCount?: number;
   /**
    * @remarks
-   * The maximum idle time configured for a session, in seconds.
+   * The maximum idle time for a session, in seconds.
    * 
    * @example
    * 600
@@ -975,7 +1045,7 @@ export class CreateCustomAgentResponseBodyDataRuntimeHpa extends $dara.Model {
 export class CreateCustomAgentResponseBodyDataRuntimeSessionPolicy extends $dara.Model {
   /**
    * @remarks
-   * The name of the HTTP request header used by the session policy. This parameter is applicable to ISOLATED_HEADER_FIELD.
+   * The name of the HTTP request header used by the session policy. This parameter applies to ISOLATED_HEADER_FIELD.
    * 
    * @example
    * X-Session-Id
@@ -985,7 +1055,7 @@ export class CreateCustomAgentResponseBodyDataRuntimeSessionPolicy extends $dara
    * @remarks
    * The type of the session policy. Valid values:
    * - AFFINITY: Session affinity.
-   * - ISOLATED_HEADER_FIELD: Uses the request header specified by headerName to associate sessions.
+   * - ISOLATED_HEADER_FIELD: Associates sessions by using the request header specified by headerName.
    * ISOLATED_COOKIE is not recommended. The compatible value DISABLED in a request is returned as AFFINITY.
    * 
    * This parameter is required.
@@ -1094,7 +1164,12 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
   artifact?: CreateCustomAgentResponseBodyDataArtifact;
   /**
    * @remarks
-   * The creation method of the agent. The value is CUSTOM for custom agents.
+   * The currently saved code package information.
+   */
+  codePackageInfo?: CreateCustomAgentResponseBodyDataCodePackageInfo;
+  /**
+   * @remarks
+   * The creation method of the agent. For custom agents, the value is CUSTOM.
    * 
    * @example
    * CUSTOM
@@ -1102,7 +1177,7 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
   createMode?: string;
   /**
    * @remarks
-   * The creation time of the agent. The time is in ISO 8601 format. The trailing Z indicates the UTC time zone. Fractional seconds may be included.
+   * The time when the agent was created. The time is in ISO 8601 format. The trailing Z indicates the UTC time zone. Fractional seconds may be included.
    * 
    * @example
    * 2026-10-10T06:00:00Z
@@ -1118,15 +1193,15 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
   deployType?: string;
   /**
    * @remarks
-   * The description of the agent\\"s purpose.
+   * The description of the agent.
    * 
    * @example
-   * Custom agent that provides conversational services
+   * Custom agent that provides conversation services
    */
   description?: string;
   /**
    * @remarks
-   * The value is null if no effective version exists. Do not use latestSpecVersion as a substitute. This field cannot be used to release the occupation protection of old cache instances.
+   * The effective configuration version.
    * 
    * This parameter is required.
    * 
@@ -1149,7 +1224,7 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
   healthCheck?: CreateCustomAgentResponseBodyDataHealthCheck;
   /**
    * @remarks
-   * This field is always returned. If useImageCache is true, the value is the non-empty logical ID of the current workspace. If useImageCache is false, the value is null. The occupation of old instances after the feature is disabled is independently protected by the backend and is not backfilled as the current configuration association.
+   * The ID of the currently associated image cache.
    * 
    * This parameter is required.
    * 
@@ -1162,17 +1237,17 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
   imageCacheId?: string;
   /**
    * @remarks
-   * This field is always returned when caching is enabled in the final configuration for creation or update, including the reuse of existing registrations. This field is omitted when the final switch is disabled or during a Get operation. Old summaries are not returned.
+   * The cache preparation acceptance summary for this request.
    */
   imageCachePreparation?: CreateCustomAgentResponseBodyDataImageCachePreparation;
   /**
    * @remarks
-   * The waiting or execution error of the latest configuration version. This field is returned only when the version is waiting for a retry or fails to execute.
+   * The wait or execution error of the latest configuration version. This field is returned only when the version is waiting for a retry or fails to execute.
    */
   latestExecutionError?: CreateCustomAgentResponseBodyDataLatestExecutionError;
   /**
    * @remarks
-   * The latest configuration version number. Updates with the same configuration may retain the original version number. This field does not indicate that the configuration has taken effect.
+   * The current latest configuration version number. Updates to the same configuration may retain the original version number. This field does not indicate that the configuration has taken effect.
    * 
    * This parameter is required.
    * 
@@ -1182,10 +1257,10 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
   latestSpecVersion?: number;
   /**
    * @remarks
-   * The execution status corresponding to latestSpecVersion. Valid values:
-   * - pending: Pending execution.
+   * The execution status corresponding to the latestSpecVersion. Valid values:
+   * - pending: Waiting for execution.
    * - processing: Executing.
-   * - waiting_retry: Waiting for retry.
+   * - waiting_retry: Waiting for a retry.
    * - succeeded: Execution succeeded.
    * - failed: Execution failed.
    * - superseded: Superseded by a subsequent version.
@@ -1204,7 +1279,7 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
   logging?: CreateCustomAgentResponseBodyDataLogging;
   /**
    * @remarks
-   * The name of the custom agent.
+   * The custom agent name.
    * 
    * This parameter is required.
    * 
@@ -1242,7 +1317,7 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ARN of the RAM role used by the agent to access user cloud resources.
+   * The Alibaba Cloud Resource Name (ARN) of the RAM role used by the agent to access user cloud resources.
    * 
    * @example
    * acs:ram::1234567890123456:role/agentcore-runtime-role
@@ -1250,23 +1325,23 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
   roleArn?: string;
   /**
    * @remarks
-   * The latest committed runtime configuration, including compute specifications, session policy, and elastic policy.
+   * The runtime configuration of the latest commit, including compute specifications, session policy, and elastic policy.
    */
   runtime?: CreateCustomAgentResponseBodyDataRuntime;
   /**
    * @remarks
-   * The instance counts grouped by running instance phase. Keys include PENDING (creating or initializing), RUNNING (running), HIBERNATING (hibernating), HIBERNATED (hibernated), RESUMING (resuming), TERMINATING (terminating), and FAILED (failed). Only phases that actually occur are returned. Missing keys are treated as 0.
+   * The instance counts by sandbox phase. Keys include PENDING (creating or initializing), RUNNING (running), HIBERNATING (hibernating), HIBERNATED (hibernated), RESUMING (resuming), TERMINATING (terminating), and FAILED (failed). Only phases that actually occur are returned. Missing keys are treated as 0.
    */
   sandboxPhaseCounts?: { [key: string]: number };
   /**
    * @remarks
    * The overall status of the agent. Valid values:
-   * - Creating: Creating.
-   * - Running: Running.
-   * - Failed: Failed.
-   * - Updating: Updating.
-   * - Deleting: Deleting.
-   * - Deleted: Deleted.
+   * - Creating: The agent is being created.
+   * - Running: The agent is running.
+   * - Failed: The agent failed.
+   * - Updating: The agent is being updated.
+   * - Deleting: The agent is being deleted.
+   * - Deleted: The agent is deleted.
    * To check the execution progress of the latest configuration, query latestVersionStatus.
    * 
    * This parameter is required.
@@ -1277,7 +1352,7 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The time when the agent was last updated. The time follows the ISO 8601 standard and is displayed in UTC. Fractional seconds are supported.
+   * The time when the agent was last updated. The time is in ISO 8601 format. A trailing Z indicates the UTC time zone. Fractional seconds may be included.
    * 
    * @example
    * 2026-10-10T06:05:00Z
@@ -1285,7 +1360,7 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
   updatedAt?: string;
   /**
    * @remarks
-   * The image cache switch. This field is always returned and reflects the final accepted configuration. If this field is missing in historical data, false is returned. Do not infer the status based on the cache status.
+   * Specifies whether the image cache is enabled.
    * 
    * This parameter is required.
    * 
@@ -1308,6 +1383,7 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
       agentId: 'agentId',
       agenticFsMounts: 'agenticFsMounts',
       artifact: 'artifact',
+      codePackageInfo: 'codePackageInfo',
       createMode: 'createMode',
       createdAt: 'createdAt',
       deployType: 'deployType',
@@ -1342,6 +1418,7 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
       agentId: 'string',
       agenticFsMounts: { 'type': 'array', 'itemType': CreateCustomAgentResponseBodyDataAgenticFsMounts },
       artifact: CreateCustomAgentResponseBodyDataArtifact,
+      codePackageInfo: CreateCustomAgentResponseBodyDataCodePackageInfo,
       createMode: 'string',
       createdAt: 'string',
       deployType: 'string',
@@ -1378,6 +1455,9 @@ export class CreateCustomAgentResponseBodyData extends $dara.Model {
     if(this.artifact && typeof (this.artifact as any).validate === 'function') {
       (this.artifact as any).validate();
     }
+    if(this.codePackageInfo && typeof (this.codePackageInfo as any).validate === 'function') {
+      (this.codePackageInfo as any).validate();
+    }
     if(this.environment && typeof (this.environment as any).validate === 'function') {
       (this.environment as any).validate();
     }
@@ -1432,14 +1512,14 @@ export class CreateCustomAgentResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The latest submitted configuration and status of the custom agent. A successful response indicates that the request is accepted, but the configuration may not have taken effect yet.
+   * The latest submitted configuration and status of the custom agent. A successful response indicates that the request is accepted, but the configuration may not have taken effect.
    * 
    * This parameter is required.
    */
   data?: CreateCustomAgentResponseBodyData;
   /**
    * @remarks
-   * The HTTP status code returned. A value of 200 indicates that the request was successful.
+   * The HTTP status code of the request. A value of 200 indicates success.
    * 
    * This parameter is required.
    * 
@@ -1449,7 +1529,7 @@ export class CreateCustomAgentResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * The result message of the request. A value of success indicates that the request was successful.
+   * The result message of the request. The value is success if the request succeeds.
    * 
    * This parameter is required.
    * 
@@ -1459,7 +1539,7 @@ export class CreateCustomAgentResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The ID of the request. You can use this ID to locate and troubleshoot issues.
+   * The unique identifier of the request. You can use this ID to locate and troubleshoot issues.
    * 
    * This parameter is required.
    * 
@@ -1469,7 +1549,7 @@ export class CreateCustomAgentResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful. A value of true indicates that the request was successful. A successful creation, update, or deletion response does not mean that the backend operation is complete.
+   * Indicates whether the request is successful. A value of true indicates success. A successful creation, update, or deletion does not mean that the background operation is complete.
    * 
    * This parameter is required.
    */