@alicloud/agentcore20260804 2.2.1 → 2.3.1

package/dist/models/CreateCustomAgentRequest.d.ts

@@ -0,0 +1,765 @@
+import * as $dara from '@darabonba/typescript';
+export declare class CreateCustomAgentRequestBodyAgenticFsMounts extends $dara.Model {
+    /**
+     * @remarks
+     * The subdirectory under /mnt/agenticfs/ in the container. This parameter is required for each mount item. Mount targets must not be duplicated or overlap in a parent-child relationship.
+     *
+     * @example
+     * /mnt/agenticfs/data
+     */
+    mountPath?: string;
+    /**
+     * @remarks
+     * The existing non-empty relative directory under the access point. This parameter is required for each mount item. Root directories, absolute paths, and parent directory traversals are not allowed.
+     *
+     * @example
+     * workspace/data
+     */
+    path?: string;
+    /**
+     * @remarks
+     * Specifies whether the mount is read-only. A value of true indicates read-only, and a value of false indicates read and write. If this parameter is omitted, the default value is false.
+     *
+     * @example
+     * false
+     */
+    readOnly?: boolean;
+    /**
+     * @remarks
+     * The domain name of the access point. This parameter is required for each mount item. Use the DomainName value from the NAS ListAccessPoints response. Do not include the protocol, port, or path.
+     *
+     * @example
+     * ap-0123456789abcdef0.0123456789-vlm36.cn-hangzhou.nas.aliyuncs.com
+     */
+    server?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class CreateCustomAgentRequestBodyArtifactCode extends $dara.Model {
+    /**
+     * @remarks
+     * The startup entry point of the code package. Code package deployment is currently not supported. Omit this parameter.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * python app.py
+     */
+    entrypoint?: string;
+    /**
+     * @remarks
+     * The language runtime identifier of the code package. Code package deployment is currently not supported. Omit this parameter.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * python
+     */
+    languageRuntime?: string;
+    /**
+     * @remarks
+     * The source URI of the code package. Code package deployment is currently not supported. Omit this parameter.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * oss://my-agent-bucket/packages/agent.zip
+     */
+    sourceUri?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class CreateCustomAgentRequestBodyArtifactContainer extends $dara.Model {
+    /**
+     * @remarks
+     * The optional image startup command. If specified, it must be a non-empty string. If omitted, the default startup method of the image is used.
+     *
+     * @example
+     * python app.py
+     */
+    entrypoint?: string;
+    /**
+     * @remarks
+     * The ID of the ACR instance to which the image repository belongs. This parameter cannot be empty.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * cri-a1b2c3d4e5f6
+     */
+    instanceId?: string;
+    /**
+     * @remarks
+     * The namespace to which the ACR image repository belongs. This parameter cannot be empty.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * my-agent
+     */
+    namespace?: string;
+    /**
+     * @remarks
+     * The name of the image repository in the ACR namespace. This parameter cannot be empty.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * chat-agent
+     */
+    repo?: string;
+    /**
+     * @remarks
+     * The image tag used for deployment. This parameter cannot be empty. When updating the tag, you must also specify artifact.port and other required image fields.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * v1.0.0
+     */
+    tag?: string;
+    /**
+     * @remarks
+     * The source type of the image. Currently, only acr is supported, which indicates Alibaba Cloud Container Registry (ACR).
+     *
+     * This parameter is required.
+     *
+     * @example
+     * acr
+     */
+    type?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class CreateCustomAgentRequestBodyArtifact extends $dara.Model {
+    /**
+     * @remarks
+     * The code package deployment configuration. This feature is currently not supported. Omit this parameter and use artifact.container.
+     */
+    code?: CreateCustomAgentRequestBodyArtifactCode;
+    /**
+     * @remarks
+     * The ACR container image configuration. You must specify type, instanceId, namespace, repo, and tag. Do not configure code at the same time.
+     */
+    container?: CreateCustomAgentRequestBodyArtifactContainer;
+    /**
+     * @remarks
+     * The TCP port on which the agent service listens. Valid values: 1 to 65535.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * 8080
+     */
+    port?: number;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class CreateCustomAgentRequestBodyEnvironmentVariables extends $dara.Model {
+    /**
+     * @remarks
+     * The name of the environment variable. This parameter cannot be empty and must be unique within the current environment variable list.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * LOG_LEVEL
+     */
+    name?: string;
+    /**
+     * @remarks
+     * The value of the environment variable. It must be a string. Empty strings are allowed.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * info
+     */
+    value?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class CreateCustomAgentRequestBodyEnvironment extends $dara.Model {
+    /**
+     * @remarks
+     * The list of environment variables. Each item includes a name and a value. The entire list is replaced during an update.
+     */
+    variables?: CreateCustomAgentRequestBodyEnvironmentVariables[];
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class CreateCustomAgentRequestBodyHealthCheck extends $dara.Model {
+    /**
+     * @remarks
+     * This parameter does not take effect. Omit this parameter.
+     *
+     * @example
+     * 1
+     */
+    healthyThreshold?: number;
+    /**
+     * @remarks
+     * The interval between two health checks, in seconds. It must be a positive integer. If omitted, the default value is 10.
+     *
+     * @example
+     * 10
+     */
+    intervalSeconds?: number;
+    /**
+     * @remarks
+     * The HTTP health check path. It must start with a forward slash (/). If omitted, the default value is /healthz.
+     *
+     * @example
+     * /healthz
+     */
+    path?: string;
+    /**
+     * @remarks
+     * The port accessed for health checks. This parameter is required when configuring health checks. Valid values: 1 to 65535.
+     *
+     * @example
+     * 8080
+     */
+    port?: number;
+    /**
+     * @remarks
+     * The timeout period for a single health check, in seconds. It must be a positive integer and less than intervalSeconds. If omitted, the default value is 2.
+     *
+     * @example
+     * 2
+     */
+    timeoutSeconds?: number;
+    /**
+     * @remarks
+     * The number of consecutive health check failures required to mark the target as unhealthy. It must be a positive integer. If omitted, the default value is 3.
+     *
+     * @example
+     * 3
+     */
+    unhealthyThreshold?: number;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class CreateCustomAgentRequestBodyLoggingSls extends $dara.Model {
+    /**
+     * @remarks
+     * The name of the Simple Log Service Logstore that receives agent logs.
+     *
+     * @example
+     * agent-runtime
+     */
+    logstore?: string;
+    /**
+     * @remarks
+     * The name of the Simple Log Service project that receives agent logs.
+     *
+     * @example
+     * my-agent-logs
+     */
+    project?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class CreateCustomAgentRequestBodyLogging extends $dara.Model {
+    /**
+     * @remarks
+     * The Simple Log Service log delivery destination. When configuring this object, neither project nor logstore can be empty.
+     */
+    sls?: CreateCustomAgentRequestBodyLoggingSls;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class CreateCustomAgentRequestBodyNetworkAccessInternet extends $dara.Model {
+    /**
+     * @remarks
+     * Specifies whether to allow the agent to access the Internet. A Boolean value must be provided when configuring accessInternet. For this setting to take effect, the workspace must also allow Internet access.
+     */
+    enabled?: boolean;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class CreateCustomAgentRequestBodyNetworkAccessVpc extends $dara.Model {
+    /**
+     * @remarks
+     * Specifies whether to allow the agent to access the user VPC configured for the workspace. A Boolean value must be provided when configuring accessVpc. For this setting to take effect, the workspace must also allow VPC access.
+     */
+    enabled?: boolean;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class CreateCustomAgentRequestBodyNetwork extends $dara.Model {
+    /**
+     * @remarks
+     * The Internet access configuration. If this access item is omitted, Internet access is not restricted on the agent side. However, the workspace must still allow Internet access.
+     */
+    accessInternet?: CreateCustomAgentRequestBodyNetworkAccessInternet;
+    /**
+     * @remarks
+     * The user VPC access configuration. If this access item is omitted, VPC access is not restricted on the agent side. However, the workspace must still be configured to allow access to the user VPC.
+     */
+    accessVpc?: CreateCustomAgentRequestBodyNetworkAccessVpc;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class CreateCustomAgentRequestBodyOssMounts extends $dara.Model {
+    /**
+     * @remarks
+     * The name of the OSS bucket. This parameter is required for each mount item. The name must be 3 to 63 characters in length and can contain only lowercase letters, digits, and hyphens. It cannot start or end with a hyphen.
+     *
+     * @example
+     * my-agent-data
+     */
+    bucketName?: string;
+    /**
+     * @remarks
+     * The subdirectory under /mnt/oss/ in the container. This parameter is required for each mount item. Mount targets must not be duplicated or overlap in a parent-child relationship.
+     *
+     * @example
+     * /mnt/oss/train
+     */
+    mountPath?: string;
+    /**
+     * @remarks
+     * The non-empty object directory prefix in the bucket, such as datasets/train. Leading and trailing forward slashes (/) are removed. Root directories are not supported. Do not use parent directory traversals.
+     *
+     * @example
+     * datasets/train
+     */
+    path?: string;
+    /**
+     * @remarks
+     * Specifies whether the mount is read-only. A value of true indicates read-only, and a value of false indicates read and write. If this parameter is omitted, the default value is false.
+     */
+    readOnly?: boolean;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class CreateCustomAgentRequestBodyProtocolPaths extends $dara.Model {
+    /**
+     * @remarks
+     * The usage description of the current API path.
+     *
+     * @example
+     * AG-UI conversation API
+     */
+    description?: string;
+    /**
+     * @remarks
+     * The non-empty API path corresponding to the current protocol.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * /agui
+     */
+    name?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class CreateCustomAgentRequestBodyProtocol extends $dara.Model {
+    /**
+     * @remarks
+     * The request header configuration for the current protocol. The key is a non-empty request header name, and the value must be a string.
+     */
+    headers?: {
+        [key: string]: string;
+    };
+    /**
+     * @remarks
+     * The list of API paths corresponding to the current protocol.
+     */
+    paths?: CreateCustomAgentRequestBodyProtocolPaths[];
+    /**
+     * @remarks
+     * 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.
+     *
+     * @example
+     * agui
+     */
+    type?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class CreateCustomAgentRequestBodyRuntimeCompute 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.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * STANDARD
+     */
+    computeClass?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class CreateCustomAgentRequestBodyRuntimeHpa extends $dara.Model {
+    /**
+     * @remarks
+     * Specifies whether to enable elastic scaling. Valid values:
+     * - true: Enabled.
+     * - false: Disabled.
+     * Default value: false.
+     *
+     * This parameter is required.
+     */
+    enabled?: boolean;
+    /**
+     * @remarks
+     * The maximum number of concurrent sessions for a single runtime instance. Valid values: 1 to 100. Default value: 100.
+     *
+     * @example
+     * 100
+     */
+    maxConcurrentSessionsPerSandbox?: number;
+    /**
+     * @remarks
+     * The maximum number of runtime instances. Valid values: 1 to 100. The value cannot be less than minSandboxCount. Default value: 10.
+     *
+     * @example
+     * 10
+     */
+    maxSandboxCount?: number;
+    /**
+     * @remarks
+     * The minimum number of runtime instances. Valid values: 1 to 100. The value cannot be greater than maxSandboxCount. Default value: 1.
+     *
+     * @example
+     * 1
+     */
+    minSandboxCount?: number;
+    /**
+     * @remarks
+     * The session idle timeout in seconds. Valid values: 60 to 86400. Default value: 600.
+     *
+     * @example
+     * 600
+     */
+    sessionTtlSeconds?: number;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class CreateCustomAgentRequestBodyRuntimeSessionPolicy extends $dara.Model {
+    /**
+     * @remarks
+     * The name of the HTTP request header used by the session policy. This parameter is required when type is set to ISOLATED_HEADER_FIELD and must be a valid HTTP request header name. Omit this parameter for other policies.
+     *
+     * @example
+     * X-Session-Id
+     */
+    headerName?: string;
+    /**
+     * @remarks
+     * The session policy type. Valid values:
+     * - AFFINITY: Session affinity.
+     * - ISOLATED_HEADER_FIELD: Associates sessions by using the request header specified by headerName.
+     * - ISOLATED_COOKIE: Not recommended.
+     * - DISABLED: A compatibility option. The response returns AFFINITY.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * AFFINITY
+     */
+    type?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class CreateCustomAgentRequestBodyRuntime extends $dara.Model {
+    /**
+     * @remarks
+     * The compute resource configuration for the agent runtime instance.
+     *
+     * This parameter is required.
+     */
+    compute?: CreateCustomAgentRequestBodyRuntimeCompute;
+    /**
+     * @remarks
+     * The optional elastic policy. When runtime is provided, if hpa or its fields are omitted, the default values are used: enabled is false, the minimum number of instances is 1, the maximum number of instances is 10, the maximum number of concurrent sessions per instance is 100, and the session idle timeout is 600 seconds. To retain the original policy during an update, provide the complete hpa configuration.
+     */
+    hpa?: CreateCustomAgentRequestBodyRuntimeHpa;
+    /**
+     * @remarks
+     * The session policy configuration, which is used to set the session association method for requests.
+     *
+     * This parameter is required.
+     */
+    sessionPolicy?: CreateCustomAgentRequestBodyRuntimeSessionPolicy;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class CreateCustomAgentRequestBody extends $dara.Model {
+    /**
+     * @remarks
+     * The list of additional AgenticFS mounts. The total number of AgenticFS and OSS mounts cannot exceed 10. If you omit this parameter or pass an empty array [] during creation, no additional mounts are configured. If you omit this parameter during an update, the original value is retained. If you pass an empty array [], the list is cleared. You cannot pass null.
+     */
+    agenticFsMounts?: CreateCustomAgentRequestBodyAgenticFsMounts[];
+    /**
+     * @remarks
+     * The deployment artifact configuration. Currently, only ACR container images are supported. Specify container and the service listening port in port, and omit code.
+     *
+     * This parameter is required.
+     */
+    artifact?: CreateCustomAgentRequestBodyArtifact;
+    /**
+     * @remarks
+     * The description of the agent purpose. The maximum length is 1,024 characters after leading and trailing whitespace is removed.
+     *
+     * @example
+     * Custom agent that provides conversation services
+     */
+    description?: string;
+    /**
+     * @remarks
+     * The environment variable configuration passed to the agent runtime process.
+     */
+    environment?: CreateCustomAgentRequestBodyEnvironment;
+    /**
+     * @remarks
+     * The optional HTTP health check configuration. If this object is provided, you must specify port. Unspecified items use default values. If omitted during creation, no health check is configured. If this top-level field is omitted during an update, the original configuration is retained. If null is passed, the health check is removed.
+     */
+    healthCheck?: CreateCustomAgentRequestBodyHealthCheck;
+    /**
+     * @remarks
+     * The agent log delivery configuration. You can specify the Simple Log Service project and Logstore. After a successful creation or update, verify that logs are delivered properly.
+     */
+    logging?: CreateCustomAgentRequestBodyLogging;
+    /**
+     * @remarks
+     * The name of the custom agent. The length must be 1 to 128 characters after leading and trailing whitespace is removed. The name must be unique within the same workspace.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * my-custom-agent
+     */
+    name?: string;
+    /**
+     * @remarks
+     * The network access configuration of the agent. If this object is provided, omitted access items are treated as allowed. The actual accessible range is still limited by the workspace network configuration. To retain the original restrictions during an update, specify both accessInternet and accessVpc.
+     */
+    network?: CreateCustomAgentRequestBodyNetwork;
+    /**
+     * @remarks
+     * The list of OSS mounts. The total number of OSS and AgenticFS mounts cannot exceed 10. You must specify bucketName, path, and mountPath for each item. Mount targets must not be duplicated or overlap. The entire list is replaced during an update. Pass an empty array [] to clear the list.
+     */
+    ossMounts?: CreateCustomAgentRequestBodyOssMounts[];
+    /**
+     * @remarks
+     * The list of invocation protocols supported by the agent. Each item includes the protocol type and optional paths and request headers. The entire list is replaced during an update.
+     */
+    protocol?: CreateCustomAgentRequestBodyProtocol[];
+    /**
+     * @remarks
+     * The ARN of the RAM role used when the agent accesses user cloud resources. The role must have permissions to access the cloud resources.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * acs:ram::1234567890123456:role/agentcore-runtime-role
+     */
+    roleArn?: string;
+    /**
+     * @remarks
+     * The runtime configuration, including compute specifications, session policies, and an optional elastic policy. Both compute and sessionPolicy must be specified.
+     *
+     * This parameter is required.
+     */
+    runtime?: CreateCustomAgentRequestBodyRuntime;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class CreateCustomAgentRequest extends $dara.Model {
+    /**
+     * @remarks
+     * The JSON configuration of the custom agent. You must specify name, artifact, roleArn, and runtime.
+     */
+    body?: CreateCustomAgentRequestBody;
+    /**
+     * @remarks
+     * Idempotency is not currently guaranteed. Do not rely on this parameter to prevent duplicate requests.
+     *
+     * @example
+     * custom-agent-request-20261010-001
+     */
+    clientToken?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}