@alicloud/agentcore20260804 2.2.0 → 2.3.0

package/dist/client.d.ts

@@ -176,6 +176,36 @@ export default class Client extends OpenApi {
      * @returns CreateCredentialResponse
      */
     createCredential(workspaceId: string, request: $_model.CreateCredentialRequest): Promise<$_model.CreateCredentialResponse>;
+    /**
+     * Creates a custom agent in a specified workspace and submits the container image deployment configuration. The creation process is asynchronous. You can call the GetCustomAgent operation to query the deployment result.
+     *
+     * @remarks
+     * Before you call this operation, prepare a writable workspace, a RAM role ARN, an ACR container image, and the runtime configuration. You must specify name, artifact, roleArn, and runtime. The runtime parameter must include both compute and sessionPolicy.
+     * Currently, only ACR container image deployment is supported. Use artifact.container and specify the service listening port in artifact.port. Omit artifact.code. The image must have the required access permissions and be accessible over the network allowed by the workspace.
+     * The creation process is asynchronous. A successful response indicates that the request is accepted. Use the returned agentId to call GetCustomAgent and check latestVersionStatus, latestExecutionError, and status for the corresponding latestSpecVersion to confirm the deployment result. After the deployment is ready, you can call CreateServiceEndpoint to configure the access endpoint.
+     * The clientToken parameter does not provide idempotency guarantees. Do not rely on this parameter to prevent duplicate requests. The healthyThreshold parameter for health checks does not take effect. Omit this parameter.
+     *
+     * @param tmpReq - CreateCustomAgentRequest
+     * @param headers - map
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns CreateCustomAgentResponse
+     */
+    createCustomAgentWithOptions(workspaceId: string, tmpReq: $_model.CreateCustomAgentRequest, headers: {
+        [key: string]: string;
+    }, runtime: $dara.RuntimeOptions): Promise<$_model.CreateCustomAgentResponse>;
+    /**
+     * Creates a custom agent in a specified workspace and submits the container image deployment configuration. The creation process is asynchronous. You can call the GetCustomAgent operation to query the deployment result.
+     *
+     * @remarks
+     * Before you call this operation, prepare a writable workspace, a RAM role ARN, an ACR container image, and the runtime configuration. You must specify name, artifact, roleArn, and runtime. The runtime parameter must include both compute and sessionPolicy.
+     * Currently, only ACR container image deployment is supported. Use artifact.container and specify the service listening port in artifact.port. Omit artifact.code. The image must have the required access permissions and be accessible over the network allowed by the workspace.
+     * The creation process is asynchronous. A successful response indicates that the request is accepted. Use the returned agentId to call GetCustomAgent and check latestVersionStatus, latestExecutionError, and status for the corresponding latestSpecVersion to confirm the deployment result. After the deployment is ready, you can call CreateServiceEndpoint to configure the access endpoint.
+     * The clientToken parameter does not provide idempotency guarantees. Do not rely on this parameter to prevent duplicate requests. The healthyThreshold parameter for health checks does not take effect. Omit this parameter.
+     *
+     * @param request - CreateCustomAgentRequest
+     * @returns CreateCustomAgentResponse
+     */
+    createCustomAgent(workspaceId: string, request: $_model.CreateCustomAgentRequest): Promise<$_model.CreateCustomAgentResponse>;
     /**
      * Creates an external agent in a specified workspace.
      *
@@ -526,6 +556,34 @@ export default class Client extends OpenApi {
      * @returns DeleteCredentialResponse
      */
     deleteCredential(workspaceId: string, credentialId: string, request: $_model.DeleteCredentialRequest): Promise<$_model.DeleteCredentialResponse>;
+    /**
+     * Deletes a custom agent in a specified workspace. A successful request indicates that the deletion is accepted, and the runtime resources are subsequently cleaned up in the background.
+     *
+     * @remarks
+     * Before you call this operation, make sure that the workspace is writable. If the agent is still associated with a team, you must dissociate the team first.
+     * Deletion is an asynchronous process. After the request is accepted, the associated invocation endpoints become unavailable, and the runtime resources are subsequently cleaned up. The status in the response is typically Deleting. If the agent is already being deleted, a subsequent request returns the current summary.
+     * You can call GetCustomAgent to check the deletion progress. After the deletion is complete, a detail query returns a resource not found error.
+     *
+     * @param request - DeleteCustomAgentRequest
+     * @param headers - map
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns DeleteCustomAgentResponse
+     */
+    deleteCustomAgentWithOptions(workspaceId: string, agentId: string, request: $_model.DeleteCustomAgentRequest, headers: {
+        [key: string]: string;
+    }, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteCustomAgentResponse>;
+    /**
+     * Deletes a custom agent in a specified workspace. A successful request indicates that the deletion is accepted, and the runtime resources are subsequently cleaned up in the background.
+     *
+     * @remarks
+     * Before you call this operation, make sure that the workspace is writable. If the agent is still associated with a team, you must dissociate the team first.
+     * Deletion is an asynchronous process. After the request is accepted, the associated invocation endpoints become unavailable, and the runtime resources are subsequently cleaned up. The status in the response is typically Deleting. If the agent is already being deleted, a subsequent request returns the current summary.
+     * You can call GetCustomAgent to check the deletion progress. After the deletion is complete, a detail query returns a resource not found error.
+     *
+     * @param request - DeleteCustomAgentRequest
+     * @returns DeleteCustomAgentResponse
+     */
+    deleteCustomAgent(workspaceId: string, agentId: string, request: $_model.DeleteCustomAgentRequest): Promise<$_model.DeleteCustomAgentResponse>;
     /**
      * Deletes a specified external agent.
      *
@@ -678,7 +736,7 @@ export default class Client extends OpenApi {
      * Deletes the draft version currently being edited for a specified Skill.
      *
      * @remarks
-     * ## Request description
+     * ## Operation description
      * Deletes the draft version currently being edited for a specified Skill.
      *
      * @param request - DeleteSkillDraftRequest
@@ -693,7 +751,7 @@ export default class Client extends OpenApi {
      * Deletes the draft version currently being edited for a specified Skill.
      *
      * @remarks
-     * ## Request description
+     * ## Operation description
      * Deletes the draft version currently being edited for a specified Skill.
      *
      * @param request - DeleteSkillDraftRequest
@@ -814,7 +872,7 @@ export default class Client extends OpenApi {
      * Retrieves a pre-signed OSS download URL for a specified Skill version, which is used to download the corresponding Skill ZIP package.
      *
      * @remarks
-     * ## Request description
+     * ## Operation description
      * Retrieves a pre-signed OSS download URL for a specified Skill version, which is used to download the corresponding Skill ZIP package.
      *
      * @param request - DownloadSkillVersionViaOssRequest
@@ -829,7 +887,7 @@ export default class Client extends OpenApi {
      * Retrieves a pre-signed OSS download URL for a specified Skill version, which is used to download the corresponding Skill ZIP package.
      *
      * @remarks
-     * ## Request description
+     * ## Operation description
      * Retrieves a pre-signed OSS download URL for a specified Skill version, which is used to download the corresponding Skill ZIP package.
      *
      * @param request - DownloadSkillVersionViaOssRequest
@@ -1038,6 +1096,34 @@ export default class Client extends OpenApi {
      * @returns GetCredentialResponse
      */
     getCredential(workspaceId: string, credentialId: string, request: $_model.GetCredentialRequest): Promise<$_model.GetCredentialResponse>;
+    /**
+     * 查询自定义智能体
+     *
+     * @remarks
+     * 创建或更新后，可轮询本接口查询最新配置版本的执行结果。latestVersionStatus 与 latestSpecVersion 对应；latestExecutionError 表示该版本的等待或失败原因，retryable 为 true 时可稍后再次查询。
+     * 返回的配置为最新提交的配置，可能尚未生效。请结合 latestVersionStatus、智能体整体状态 status 和运行实例统计 sandboxPhaseCounts 确认部署及运行情况。
+     * 查询不存在、已完成删除或不属于指定工作空间的自定义智能体时，返回资源不存在错误。
+     *
+     * @param request - GetCustomAgentRequest
+     * @param headers - map
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns GetCustomAgentResponse
+     */
+    getCustomAgentWithOptions(workspaceId: string, agentId: string, request: $_model.GetCustomAgentRequest, headers: {
+        [key: string]: string;
+    }, runtime: $dara.RuntimeOptions): Promise<$_model.GetCustomAgentResponse>;
+    /**
+     * 查询自定义智能体
+     *
+     * @remarks
+     * 创建或更新后，可轮询本接口查询最新配置版本的执行结果。latestVersionStatus 与 latestSpecVersion 对应；latestExecutionError 表示该版本的等待或失败原因，retryable 为 true 时可稍后再次查询。
+     * 返回的配置为最新提交的配置，可能尚未生效。请结合 latestVersionStatus、智能体整体状态 status 和运行实例统计 sandboxPhaseCounts 确认部署及运行情况。
+     * 查询不存在、已完成删除或不属于指定工作空间的自定义智能体时，返回资源不存在错误。
+     *
+     * @param request - GetCustomAgentRequest
+     * @returns GetCustomAgentResponse
+     */
+    getCustomAgent(workspaceId: string, agentId: string, request: $_model.GetCustomAgentRequest): Promise<$_model.GetCustomAgentResponse>;
     /**
      * Queries the details of a specified external agent.
      *
@@ -1654,6 +1740,34 @@ export default class Client extends OpenApi {
      * @returns ListCredentialsResponse
      */
     listCredentials(workspaceId: string, request: $_model.ListCredentialsRequest): Promise<$_model.ListCredentialsResponse>;
+    /**
+     * Performs a paged query to retrieve the summary of custom agents in a specified workspace. For paging, the complete configuration, and the execute results of the latest version, call GetCustomAgent.
+     *
+     * @remarks
+     * The default value of maxResults is 20, and the maximum value is 100. If this parameter is omitted or set to 0, the default value is used.
+     * Omit nextToken in the first request. In subsequent requests, pass the nextToken value returned in the previous response as is, and keep the same workspace. The nextToken is an opaque token. Do not parse or construct it yourself. An empty token in the response indicates that there are no more pages.
+     * This operation returns the summaries of the current page and does not return the complete deployment configuration or the execution errors of the latest version. To obtain this information, call GetCustomAgent by using the agentId in items.
+     *
+     * @param request - ListCustomAgentsRequest
+     * @param headers - map
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns ListCustomAgentsResponse
+     */
+    listCustomAgentsWithOptions(workspaceId: string, request: $_model.ListCustomAgentsRequest, headers: {
+        [key: string]: string;
+    }, runtime: $dara.RuntimeOptions): Promise<$_model.ListCustomAgentsResponse>;
+    /**
+     * Performs a paged query to retrieve the summary of custom agents in a specified workspace. For paging, the complete configuration, and the execute results of the latest version, call GetCustomAgent.
+     *
+     * @remarks
+     * The default value of maxResults is 20, and the maximum value is 100. If this parameter is omitted or set to 0, the default value is used.
+     * Omit nextToken in the first request. In subsequent requests, pass the nextToken value returned in the previous response as is, and keep the same workspace. The nextToken is an opaque token. Do not parse or construct it yourself. An empty token in the response indicates that there are no more pages.
+     * This operation returns the summaries of the current page and does not return the complete deployment configuration or the execution errors of the latest version. To obtain this information, call GetCustomAgent by using the agentId in items.
+     *
+     * @param request - ListCustomAgentsRequest
+     * @returns ListCustomAgentsResponse
+     */
+    listCustomAgents(workspaceId: string, request: $_model.ListCustomAgentsRequest): Promise<$_model.ListCustomAgentsResponse>;
     /**
      * Queries the list of external agents in a specified workspace.
      *
@@ -1965,11 +2079,11 @@ export default class Client extends OpenApi {
      */
     listSkillReferences(workspaceId: string, skillName: string, request: $_model.ListSkillReferencesRequest): Promise<$_model.ListSkillReferencesResponse>;
     /**
-     * Performs a paged query of Skills in a specified workspace, and returns basic Skill information, version status, and paging details.
+     * Performs a paged query of Skills in a specified workspace and returns basic Skill information, version status, and paging information.
      *
      * @remarks
      * ## Operation description
-     * Performs a paged query of Skills in a specified workspace, and returns basic Skill information, version status, and paging details.
+     * Performs a paged query of Skills in a specified workspace and returns basic Skill information, version status, and paging information.
      *
      * @param request - ListSkillsRequest
      * @param headers - map
@@ -1980,11 +2094,11 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ListSkillsResponse>;
     /**
-     * Performs a paged query of Skills in a specified workspace, and returns basic Skill information, version status, and paging details.
+     * Performs a paged query of Skills in a specified workspace and returns basic Skill information, version status, and paging information.
      *
      * @remarks
      * ## Operation description
-     * Performs a paged query of Skills in a specified workspace, and returns basic Skill information, version status, and paging details.
+     * Performs a paged query of Skills in a specified workspace and returns basic Skill information, version status, and paging information.
      *
      * @param request - ListSkillsRequest
      * @returns ListSkillsResponse
@@ -2009,7 +2123,7 @@ export default class Client extends OpenApi {
      */
     listTeams(workspaceId: string, request: $_model.ListTeamsRequest): Promise<$_model.ListTeamsResponse>;
     /**
-     * Queries users in a specified workspace with paging. Use nameLike to filter by username with fuzzy match, maxResults to specify the maximum number of records per page, and nextToken to retrieve the next page. If maxResults is not specified, the server returns 10 records by default.
+     * Performs a paged query of users in a specified workspace. You can filter users by fuzzy match on the username by using nameLike, specify the maximum number of records per page for paging by using maxResults, and obtain the next page by using nextToken. If maxResults is not specified, the server returns 10 records by default.
      *
      * @param request - ListUsersRequest
      * @param headers - map
@@ -2020,7 +2134,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ListUsersResponse>;
     /**
-     * Queries users in a specified workspace with paging. Use nameLike to filter by username with fuzzy match, maxResults to specify the maximum number of records per page, and nextToken to retrieve the next page. If maxResults is not specified, the server returns 10 records by default.
+     * Performs a paged query of users in a specified workspace. You can filter users by fuzzy match on the username by using nameLike, specify the maximum number of records per page for paging by using maxResults, and obtain the next page by using nextToken. If maxResults is not specified, the server returns 10 records by default.
      *
      * @param request - ListUsersRequest
      * @returns ListUsersResponse
@@ -2155,11 +2269,11 @@ export default class Client extends OpenApi {
      */
     publishSkillVersion(workspaceId: string, skillName: string, skillVersion: string, request: $_model.PublishSkillVersionRequest): Promise<$_model.PublishSkillVersionResponse>;
     /**
-     * Converts a specified Skill version back into an editable draft for further modifications.
+     * Converts a specified Skill version back to an editable draft so that you can continue to modify it.
      *
      * @remarks
-     * ## Operation description
-     * Converts a specified Skill version back into an editable draft for further modifications.
+     * ## Request description
+     * Converts a specified Skill version back to an editable draft so that you can continue to modify it.
      *
      * @param tmpReq - RedraftSkillVersionRequest
      * @param headers - map
@@ -2170,11 +2284,11 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.RedraftSkillVersionResponse>;
     /**
-     * Converts a specified Skill version back into an editable draft for further modifications.
+     * Converts a specified Skill version back to an editable draft so that you can continue to modify it.
      *
      * @remarks
-     * ## Operation description
-     * Converts a specified Skill version back into an editable draft for further modifications.
+     * ## Request description
+     * Converts a specified Skill version back to an editable draft so that you can continue to modify it.
      *
      * @param request - RedraftSkillVersionRequest
      * @returns RedraftSkillVersionResponse
@@ -2372,6 +2486,38 @@ export default class Client extends OpenApi {
      * @returns UpdateCredentialResponse
      */
     updateCredential(workspaceId: string, credentialId: string, request: $_model.UpdateCredentialRequest): Promise<$_model.UpdateCredentialResponse>;
+    /**
+     * Updates the configuration of a specified custom agent in a workspace and executes the update asynchronously. Omitted top-level fields retain their original configurations. You can call the GetCustomAgent operation to query the update result.
+     *
+     * @remarks
+     * Provide at least one top-level field to update. Omitted top-level fields retain their original configurations. When providing a configuration object, specify its required subfields and include any optional configurations that you want to retain. Arrays are replaced in their entirety. Pass an empty array [] to clear a list. The agenticFsMounts field does not accept null. Pass null for the description field to clear the description, and pass null for the healthCheck field to remove the health check.
+     * When updating an image, you must specify artifact.port and the type, instanceId, namespace, repo, and tag fields of artifact.container. To retain a custom startup command, also provide the entrypoint field. Currently, only Alibaba Cloud Container Registry (ACR) container image deployment is supported. Omit the artifact.code field.
+     * When providing the runtime field, both compute and sessionPolicy must be present. If you omit hpa or any of its fields, unspecified elastic configurations use default values. To retain the original elastic configurations, provide them together. When providing the network field, omitted access items are treated as allowed, but actual access is still subject to workspace network restrictions. To retain the original restrictions, provide both accessInternet and accessVpc. When providing healthCheck, you must specify the port field, and other unspecified items use default values. When providing logging.sls, you must specify both project and logstore.
+     * The update is an asynchronous process. A successful response indicates that the request is accepted. Call the GetCustomAgent operation to query latestSpecVersion, latestVersionStatus, and latestExecutionError, and check the status field to confirm the update result.
+     * The clientToken field currently does not provide idempotency guarantees. Do not rely on this parameter to prevent duplicate requests. The healthyThreshold field for health checks currently does not take effect. Omit this field.
+     *
+     * @param tmpReq - UpdateCustomAgentRequest
+     * @param headers - map
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns UpdateCustomAgentResponse
+     */
+    updateCustomAgentWithOptions(workspaceId: string, agentId: string, tmpReq: $_model.UpdateCustomAgentRequest, headers: {
+        [key: string]: string;
+    }, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateCustomAgentResponse>;
+    /**
+     * Updates the configuration of a specified custom agent in a workspace and executes the update asynchronously. Omitted top-level fields retain their original configurations. You can call the GetCustomAgent operation to query the update result.
+     *
+     * @remarks
+     * Provide at least one top-level field to update. Omitted top-level fields retain their original configurations. When providing a configuration object, specify its required subfields and include any optional configurations that you want to retain. Arrays are replaced in their entirety. Pass an empty array [] to clear a list. The agenticFsMounts field does not accept null. Pass null for the description field to clear the description, and pass null for the healthCheck field to remove the health check.
+     * When updating an image, you must specify artifact.port and the type, instanceId, namespace, repo, and tag fields of artifact.container. To retain a custom startup command, also provide the entrypoint field. Currently, only Alibaba Cloud Container Registry (ACR) container image deployment is supported. Omit the artifact.code field.
+     * When providing the runtime field, both compute and sessionPolicy must be present. If you omit hpa or any of its fields, unspecified elastic configurations use default values. To retain the original elastic configurations, provide them together. When providing the network field, omitted access items are treated as allowed, but actual access is still subject to workspace network restrictions. To retain the original restrictions, provide both accessInternet and accessVpc. When providing healthCheck, you must specify the port field, and other unspecified items use default values. When providing logging.sls, you must specify both project and logstore.
+     * The update is an asynchronous process. A successful response indicates that the request is accepted. Call the GetCustomAgent operation to query latestSpecVersion, latestVersionStatus, and latestExecutionError, and check the status field to confirm the update result.
+     * The clientToken field currently does not provide idempotency guarantees. Do not rely on this parameter to prevent duplicate requests. The healthyThreshold field for health checks currently does not take effect. Omit this field.
+     *
+     * @param request - UpdateCustomAgentRequest
+     * @returns UpdateCustomAgentResponse
+     */
+    updateCustomAgent(workspaceId: string, agentId: string, request: $_model.UpdateCustomAgentRequest): Promise<$_model.UpdateCustomAgentResponse>;
     /**
      * Updates the configuration of a specified external agent.
      *