@alicloud/agentcore20260804 1.2.0 → 1.2.2

package/dist/client.d.ts

@@ -9,7 +9,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, endpoint: string): string;
     /**
-     * 批量删除模型
+     * Deletes models in a specified workspace in batches. If any model is in use, the entire batch request fails.
      *
      * @param tmpReq - BatchDeleteModelsRequest
      * @param headers - map
@@ -20,7 +20,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.BatchDeleteModelsResponse>;
     /**
-     * 批量删除模型
+     * Deletes models in a specified workspace in batches. If any model is in use, the entire batch request fails.
      *
      * @param request - BatchDeleteModelsRequest
      * @returns BatchDeleteModelsResponse
@@ -129,7 +129,7 @@ export default class Client extends OpenApi {
      */
     createAgentSpecVersion(workspaceId: string, agentSpecName: string, request: $_model.CreateAgentSpecVersionRequest): Promise<$_model.CreateAgentSpecVersionResponse>;
     /**
-     * 创建凭证
+     * Creates a credential in a specified workspace for agent authentication when accessing external services. Currently, only the apiKey type is supported. The credential content is passed in as a JSON string through credentialMetadata and can only be queried in masked form after being written.
      *
      * @param tmpReq - CreateCredentialRequest
      * @param headers - map
@@ -140,7 +140,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.CreateCredentialResponse>;
     /**
-     * 创建凭证
+     * Creates a credential in a specified workspace for agent authentication when accessing external services. Currently, only the apiKey type is supported. The credential content is passed in as a JSON string through credentialMetadata and can only be queried in masked form after being written.
      *
      * @param request - CreateCredentialRequest
      * @returns CreateCredentialResponse
@@ -275,7 +275,7 @@ export default class Client extends OpenApi {
      */
     createModel(workspaceId: string, request: $_model.CreateModelRequest): Promise<$_model.CreateModelResponse>;
     /**
-     * 创建模型连接
+     * Creates a model connection in a specified workspace and configures the upstream model service address, invoke protocol, and access credentials.
      *
      * @param tmpReq - CreateModelConnectionRequest
      * @param headers - map
@@ -286,7 +286,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.CreateModelConnectionResponse>;
     /**
-     * 创建模型连接
+     * Creates a model connection in a specified workspace and configures the upstream model service address, invoke protocol, and access credentials.
      *
      * @param request - CreateModelConnectionRequest
      * @returns CreateModelConnectionResponse
@@ -319,7 +319,7 @@ export default class Client extends OpenApi {
      */
     createSkillDraft(workspaceId: string, request: $_model.CreateSkillDraftRequest): Promise<$_model.CreateSkillDraftResponse>;
     /**
-     * 创建团队
+     * Creates a team in a specified workspace and sets user members and agent members at the same time. The user members must include exactly one member with the ADMIN role. Agent members can only have the LEADER or WORKER role.
      *
      * @param tmpReq - CreateTeamRequest
      * @param headers - map
@@ -330,14 +330,14 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.CreateTeamResponse>;
     /**
-     * 创建团队
+     * Creates a team in a specified workspace and sets user members and agent members at the same time. The user members must include exactly one member with the ADMIN role. Agent members can only have the LEADER or WORKER role.
      *
      * @param request - CreateTeamRequest
      * @returns CreateTeamResponse
      */
     createTeam(workspaceId: string, request: $_model.CreateTeamRequest): Promise<$_model.CreateTeamResponse>;
     /**
-     * 创建用户
+     * Creates a user in a specified workspace. The username must be unique within the workspace and can contain only lowercase letters, digits, and hyphens. Reserved names such as manager, admin, or names starting with worker- cannot be used. If password is not specified, the server generates an initial password and returns it in the initialPassword field of the response.
      *
      * @param tmpReq - CreateUserRequest
      * @param headers - map
@@ -348,7 +348,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.CreateUserResponse>;
     /**
-     * 创建用户
+     * Creates a user in a specified workspace. The username must be unique within the workspace and can contain only lowercase letters, digits, and hyphens. Reserved names such as manager, admin, or names starting with worker- cannot be used. If password is not specified, the server generates an initial password and returns it in the initialPassword field of the response.
      *
      * @param request - CreateUserRequest
      * @returns CreateUserResponse
@@ -379,7 +379,7 @@ export default class Client extends OpenApi {
      */
     createWorkspace(request: $_model.CreateWorkspaceRequest): Promise<$_model.CreateWorkspaceResponse>;
     /**
-     * 调试模型
+     * Calls a specified model through a published model connection to verify whether the model call chain is available.
      *
      * @param tmpReq - DebugModelRequest
      * @param headers - map
@@ -390,7 +390,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.DebugModelResponse>;
     /**
-     * 调试模型
+     * Calls a specified model through a published model connection to verify whether the model call chain is available.
      *
      * @param request - DebugModelRequest
      * @returns DebugModelResponse
@@ -473,7 +473,7 @@ export default class Client extends OpenApi {
      */
     deleteAgentSpecVersion(workspaceId: string, agentSpecName: string, request: $_model.DeleteAgentSpecVersionRequest): Promise<$_model.DeleteAgentSpecVersionResponse>;
     /**
-     * 删除凭证
+     * Deletes a credential from the specified workspace and removes the ciphertext hosted in the credential service. After deletion, agents that are bound to this credential can no longer retrieve the credential content.
      *
      * @param request - DeleteCredentialRequest
      * @param headers - map
@@ -484,7 +484,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteCredentialResponse>;
     /**
-     * 删除凭证
+     * Deletes a credential from the specified workspace and removes the ciphertext hosted in the credential service. After deletion, agents that are bound to this credential can no longer retrieve the credential content.
      *
      * @param request - DeleteCredentialRequest
      * @returns DeleteCredentialResponse
@@ -577,7 +577,7 @@ export default class Client extends OpenApi {
      */
     deleteMcp(mcpServerId: string, workspaceId: string, request: $_model.DeleteMcpRequest): Promise<$_model.DeleteMcpResponse>;
     /**
-     * 删除模型
+     * Deletes a model from a specified workspace. Models that are currently in use cannot be deleted.
      *
      * @param request - DeleteModelRequest
      * @param headers - map
@@ -588,14 +588,14 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteModelResponse>;
     /**
-     * 删除模型
+     * Deletes a model from a specified workspace. Models that are currently in use cannot be deleted.
      *
      * @param request - DeleteModelRequest
      * @returns DeleteModelResponse
      */
     deleteModel(workspaceId: string, modelId: string, request: $_model.DeleteModelRequest): Promise<$_model.DeleteModelResponse>;
     /**
-     * 删除模型连接
+     * Submits an asynchronous deletion task for a specified model connection. The connection cannot be deleted if it has associated models or runtime references.
      *
      * @param request - DeleteModelConnectionRequest
      * @param headers - map
@@ -606,7 +606,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteModelConnectionResponse>;
     /**
-     * 删除模型连接
+     * Submits an asynchronous deletion task for a specified model connection. The connection cannot be deleted if it has associated models or runtime references.
      *
      * @param request - DeleteModelConnectionRequest
      * @returns DeleteModelConnectionResponse
@@ -665,7 +665,7 @@ export default class Client extends OpenApi {
      */
     deleteSkillDraft(workspaceId: string, skillName: string, request: $_model.DeleteSkillDraftRequest): Promise<$_model.DeleteSkillDraftResponse>;
     /**
-     * 删除团队
+     * Deletes a team in the specified workspace. Deleting a team does not delete the users or agents in the team. It only dissociates the member relationships.
      *
      * @param request - DeleteTeamRequest
      * @param headers - map
@@ -676,14 +676,14 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteTeamResponse>;
     /**
-     * 删除团队
+     * Deletes a team in the specified workspace. Deleting a team does not delete the users or agents in the team. It only dissociates the member relationships.
      *
      * @param request - DeleteTeamRequest
      * @returns DeleteTeamResponse
      */
     deleteTeam(workspaceId: string, teamId: string, request: $_model.DeleteTeamRequest): Promise<$_model.DeleteTeamResponse>;
     /**
-     * 删除用户
+     * Deletes a user from a specified workspace. A user cannot be deleted while the user is still a member of any team. Remove the user from all teams before deleting the user.
      *
      * @param request - DeleteUserRequest
      * @param headers - map
@@ -694,7 +694,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteUserResponse>;
     /**
-     * 删除用户
+     * Deletes a user from a specified workspace. A user cannot be deleted while the user is still a member of any team. Remove the user from all teams before deleting the user.
      *
      * @param request - DeleteUserRequest
      * @returns DeleteUserResponse
@@ -931,7 +931,7 @@ export default class Client extends OpenApi {
      */
     getAgentSpecVersion(workspaceId: string, agentSpecName: string, agentSpecVersion: string, request: $_model.GetAgentSpecVersionRequest): Promise<$_model.GetAgentSpecVersionResponse>;
     /**
-     * 查询凭证
+     * Queries the details of a specified credential and returns the list of agents that are bound to the credential. The credential content is returned in masked form.
      *
      * @param request - GetCredentialRequest
      * @param headers - map
@@ -942,7 +942,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.GetCredentialResponse>;
     /**
-     * 查询凭证
+     * Queries the details of a specified credential and returns the list of agents that are bound to the credential. The credential content is returned in masked form.
      *
      * @param request - GetCredentialRequest
      * @returns GetCredentialResponse
@@ -1077,7 +1077,7 @@ export default class Client extends OpenApi {
      */
     getModel(workspaceId: string, modelId: string, request: $_model.GetModelRequest): Promise<$_model.GetModelResponse>;
     /**
-     * 查询模型连接
+     * Queries the detailed configuration, credential configuration status, publish status, and region of a specified model connection.
      *
      * @param request - GetModelConnectionRequest
      * @param headers - map
@@ -1088,7 +1088,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.GetModelConnectionResponse>;
     /**
-     * 查询模型连接
+     * Queries the detailed configuration, credential configuration status, publish status, and region of a specified model connection.
      *
      * @param request - GetModelConnectionRequest
      * @returns GetModelConnectionResponse
@@ -1221,7 +1221,7 @@ export default class Client extends OpenApi {
      */
     getSkillVersionDetail(workspaceId: string, skillName: string, skillVersion: string, request: $_model.GetSkillVersionDetailRequest): Promise<$_model.GetSkillVersionDetailResponse>;
     /**
-     * 查询团队
+     * Queries the details of a specified team. The response includes the complete properties and team roles of each user member and agent member in the team.
      *
      * @param request - GetTeamRequest
      * @param headers - map
@@ -1232,14 +1232,14 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.GetTeamResponse>;
     /**
-     * 查询团队
+     * Queries the details of a specified team. The response includes the complete properties and team roles of each user member and agent member in the team.
      *
      * @param request - GetTeamRequest
      * @returns GetTeamResponse
      */
     getTeam(workspaceId: string, teamId: string, request: $_model.GetTeamRequest): Promise<$_model.GetTeamResponse>;
     /**
-     * 查询用户
+     * Queries the details of a specified user in a workspace. Returns an error if the user does not exist.
      *
      * @param request - GetUserRequest
      * @param headers - map
@@ -1250,7 +1250,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.GetUserResponse>;
     /**
-     * 查询用户
+     * Queries the details of a specified user in a workspace. Returns an error if the user does not exist.
      *
      * @param request - GetUserRequest
      * @returns GetUserResponse
@@ -1397,7 +1397,7 @@ export default class Client extends OpenApi {
      */
     listAgentTeams(workspaceId: string, request: $_model.ListAgentTeamsRequest): Promise<$_model.ListAgentTeamsResponse>;
     /**
-     * 查询凭证列表
+     * Queries credentials in a specified workspace by using paging. You can use credentialType to filter by type, nameLike to filter by credential name using 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.
      *
      * @param request - ListCredentialsRequest
      * @param headers - map
@@ -1408,7 +1408,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ListCredentialsResponse>;
     /**
-     * 查询凭证列表
+     * Queries credentials in a specified workspace by using paging. You can use credentialType to filter by type, nameLike to filter by credential name using 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.
      *
      * @param request - ListCredentialsRequest
      * @returns ListCredentialsResponse
@@ -1507,11 +1507,11 @@ export default class Client extends OpenApi {
      */
     listMcpTools(workspaceId: string, mcpServerId: string, request: $_model.ListMcpToolsRequest): Promise<$_model.ListMcpToolsResponse>;
     /**
-     * Queries MCP services and their configurations and statuses in a specified workspace by using paging.
+     * Queries MCP services and their configurations and statuses in a specified workspace by page.
      *
      * @remarks
      * ## Operation description
-     * Queries MCP services and their configurations and statuses in a specified workspace by using paging.
+     * Queries MCP services and their configurations and statuses in a specified workspace by page.
      *
      * @param request - ListMcpsRequest
      * @param headers - map
@@ -1522,18 +1522,21 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ListMcpsResponse>;
     /**
-     * Queries MCP services and their configurations and statuses in a specified workspace by using paging.
+     * Queries MCP services and their configurations and statuses in a specified workspace by page.
      *
      * @remarks
      * ## Operation description
-     * Queries MCP services and their configurations and statuses in a specified workspace by using paging.
+     * Queries MCP services and their configurations and statuses in a specified workspace by page.
      *
      * @param request - ListMcpsRequest
      * @returns ListMcpsResponse
      */
     listMcps(workspaceId: string, request: $_model.ListMcpsRequest): Promise<$_model.ListMcpsResponse>;
     /**
-     * 查询模型连接列表
+     * Queries model connections in a specified workspace with paging. Supports filtering by name, provider type, and invoke protocol.
+     *
+     * @remarks
+     * Queries model connections in a specified AgentCore workspace. Supports filtering by name through `Name` and selecting exact match or fuzzy match through `SearchType`. Also supports filtering by model provider type and invoke protocol, and supports paging.
      *
      * @param request - ListModelConnectionsRequest
      * @param headers - map
@@ -1544,7 +1547,10 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ListModelConnectionsResponse>;
     /**
-     * 查询模型连接列表
+     * Queries model connections in a specified workspace with paging. Supports filtering by name, provider type, and invoke protocol.
+     *
+     * @remarks
+     * Queries model connections in a specified AgentCore workspace. Supports filtering by name through `Name` and selecting exact match or fuzzy match through `SearchType`. Also supports filtering by model provider type and invoke protocol, and supports paging.
      *
      * @param request - ListModelConnectionsRequest
      * @returns ListModelConnectionsResponse
@@ -1655,7 +1661,7 @@ export default class Client extends OpenApi {
      */
     listSkills(workspaceId: string, request: $_model.ListSkillsRequest): Promise<$_model.ListSkillsResponse>;
     /**
-     * 查询团队列表
+     * Queries teams in a specified workspace by paging. Use nameLike to filter by team name 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. Member information in the list includes only the member identity, name, and team role.
      *
      * @param request - ListTeamsRequest
      * @param headers - map
@@ -1666,7 +1672,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ListTeamsResponse>;
     /**
-     * 查询团队列表
+     * Queries teams in a specified workspace by paging. Use nameLike to filter by team name 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. Member information in the list includes only the member identity, name, and team role.
      *
      * @param request - ListTeamsRequest
      * @returns ListTeamsResponse
@@ -1845,7 +1851,7 @@ export default class Client extends OpenApi {
      */
     redraftSkillVersion(workspaceId: string, skillName: string, skillVersion: string, request: $_model.RedraftSkillVersionRequest): Promise<$_model.RedraftSkillVersionResponse>;
     /**
-     * 重置用户密码
+     * Resets the logon password of a specified user. Specify the user by agentCoreUserId or username. At least one of the two parameters must be specified. Only users who use workspace local password authentication can be reset. If password is not specified, the server generates a random password and returns it in the response.
      *
      * @param tmpReq - ResetUserPasswordRequest
      * @param headers - map
@@ -1856,7 +1862,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ResetUserPasswordResponse>;
     /**
-     * 重置用户密码
+     * Resets the logon password of a specified user. Specify the user by agentCoreUserId or username. At least one of the two parameters must be specified. Only users who use workspace local password authentication can be reset. If password is not specified, the server generates a random password and returns it in the response.
      *
      * @param request - ResetUserPasswordRequest
      * @returns ResetUserPasswordResponse
@@ -1989,7 +1995,7 @@ export default class Client extends OpenApi {
      */
     updateAgentSpec(workspaceId: string, agentSpecName: string, request: $_model.UpdateAgentSpecRequest): Promise<$_model.UpdateAgentSpecResponse>;
     /**
-     * 更新凭证
+     * Updates the content or description of a specified credential. At least one of credentialMetadata and description must be specified. Unspecified properties remain unchanged. The credential name and credential type cannot be modified after creation.
      *
      * @param tmpReq - UpdateCredentialRequest
      * @param headers - map
@@ -2000,7 +2006,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateCredentialResponse>;
     /**
-     * 更新凭证
+     * Updates the content or description of a specified credential. At least one of credentialMetadata and description must be specified. Unspecified properties remain unchanged. The credential name and credential type cannot be modified after creation.
      *
      * @param request - UpdateCredentialRequest
      * @returns UpdateCredentialResponse
@@ -2093,7 +2099,12 @@ export default class Client extends OpenApi {
      */
     updateMcp(workspaceId: string, mcpServerId: string, request: $_model.UpdateMcpRequest): Promise<$_model.UpdateMcpResponse>;
     /**
-     * Updates the description of a specified model. Other model configurations cannot be modified through this operation.
+     * Updates the description, context token limit, maximum output token count, or capability configuration of a specified model.
+     *
+     * @remarks
+     * This operation updates description, contextSize, maxTokens, and capabilities. At least one non-null parameter must be provided. Parameters that are not provided or set to null retain their original values. The capabilities object is replaced as a whole. Capability fields not included in the object are treated as false.
+     * Modifying only description does not refresh the model configuration of associated agents. When contextSize, maxTokens, or capabilities actually change, the system asynchronously refreshes managed agents that reference the model within the same workspace, as well as external agents whose model source is PLATFORM. External agents whose model source is RUNTIME are not affected. Submitting the same configuration repeatedly does not trigger a new model configuration refresh.
+     * A successful response indicates that the model configuration has been saved. It does not indicate that associated agents have completed the configuration refresh or that the runtime has loaded the new configuration. Call GetModel to query the saved model configuration.
      *
      * @param tmpReq - UpdateModelRequest
      * @param headers - map
@@ -2104,7 +2115,12 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateModelResponse>;
     /**
-     * Updates the description of a specified model. Other model configurations cannot be modified through this operation.
+     * Updates the description, context token limit, maximum output token count, or capability configuration of a specified model.
+     *
+     * @remarks
+     * This operation updates description, contextSize, maxTokens, and capabilities. At least one non-null parameter must be provided. Parameters that are not provided or set to null retain their original values. The capabilities object is replaced as a whole. Capability fields not included in the object are treated as false.
+     * Modifying only description does not refresh the model configuration of associated agents. When contextSize, maxTokens, or capabilities actually change, the system asynchronously refreshes managed agents that reference the model within the same workspace, as well as external agents whose model source is PLATFORM. External agents whose model source is RUNTIME are not affected. Submitting the same configuration repeatedly does not trigger a new model configuration refresh.
+     * A successful response indicates that the model configuration has been saved. It does not indicate that associated agents have completed the configuration refresh or that the runtime has loaded the new configuration. Call GetModel to query the saved model configuration.
      *
      * @param request - UpdateModelRequest
      * @returns UpdateModelResponse
@@ -2207,7 +2223,7 @@ export default class Client extends OpenApi {
      */
     updateSkillScope(workspaceId: string, skillName: string, request: $_model.UpdateSkillScopeRequest): Promise<$_model.UpdateSkillScopeResponse>;
     /**
-     * 更新团队
+     * Updates the description and members of a specified team. When users or agents are passed in, the corresponding member list is replaced using full overwrite semantics. Member lists that are not passed in remain unchanged. The team name cannot be modified after creation.
      *
      * @param tmpReq - UpdateTeamRequest
      * @param headers - map
@@ -2218,14 +2234,14 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateTeamResponse>;
     /**
-     * 更新团队
+     * Updates the description and members of a specified team. When users or agents are passed in, the corresponding member list is replaced using full overwrite semantics. Member lists that are not passed in remain unchanged. The team name cannot be modified after creation.
      *
      * @param request - UpdateTeamRequest
      * @returns UpdateTeamResponse
      */
     updateTeam(workspaceId: string, teamId: string, request: $_model.UpdateTeamRequest): Promise<$_model.UpdateTeamResponse>;
     /**
-     * 更新用户
+     * Updates the display name, email address, or note of a specified user. At least one of displayName, email, and note must be specified. Unspecified properties remain unchanged. The username cannot be modified after creation.
      *
      * @param tmpReq - UpdateUserRequest
      * @param headers - map
@@ -2236,7 +2252,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateUserResponse>;
     /**
-     * 更新用户
+     * Updates the display name, email address, or note of a specified user. At least one of displayName, email, and note must be specified. Unspecified properties remain unchanged. The username cannot be modified after creation.
      *
      * @param request - UpdateUserRequest
      * @returns UpdateUserResponse