@alicloud/rdsai20250507 3.7.1 → 3.8.1

package/dist/client.d.ts

@@ -96,6 +96,69 @@ export default class Client extends OpenApi {
      * @returns CreateAppInstanceResponse
      */
     createAppInstance(request: $_model.CreateAppInstanceRequest): Promise<$_model.CreateAppInstanceResponse>;
+    /**
+     * 创建上下文数据库 API Key
+     *
+     * @remarks
+     * 创建 API Key（返回明文 apiKey）。
+     *
+     * @param request - CreateContextDatabaseApiKeyRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns CreateContextDatabaseApiKeyResponse
+     */
+    createContextDatabaseApiKeyWithOptions(request: $_model.CreateContextDatabaseApiKeyRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateContextDatabaseApiKeyResponse>;
+    /**
+     * 创建上下文数据库 API Key
+     *
+     * @remarks
+     * 创建 API Key（返回明文 apiKey）。
+     *
+     * @param request - CreateContextDatabaseApiKeyRequest
+     * @returns CreateContextDatabaseApiKeyResponse
+     */
+    createContextDatabaseApiKey(request: $_model.CreateContextDatabaseApiKeyRequest): Promise<$_model.CreateContextDatabaseApiKeyResponse>;
+    /**
+     * 创建上下文数据库成员
+     *
+     * @remarks
+     * 创建成员；当 GenerateInitialKey=true 时同时签发首把 API Key，并在响应中返回明文 ApiKey（敏感字段，仅此一次返回，请妥善保存）。创建成功后可通过 List / Get 查询成员及其名下 API Key 的元数据。
+     *
+     * @param request - CreateContextDatabaseMemberRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns CreateContextDatabaseMemberResponse
+     */
+    createContextDatabaseMemberWithOptions(request: $_model.CreateContextDatabaseMemberRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateContextDatabaseMemberResponse>;
+    /**
+     * 创建上下文数据库成员
+     *
+     * @remarks
+     * 创建成员；当 GenerateInitialKey=true 时同时签发首把 API Key，并在响应中返回明文 ApiKey（敏感字段，仅此一次返回，请妥善保存）。创建成功后可通过 List / Get 查询成员及其名下 API Key 的元数据。
+     *
+     * @param request - CreateContextDatabaseMemberRequest
+     * @returns CreateContextDatabaseMemberResponse
+     */
+    createContextDatabaseMember(request: $_model.CreateContextDatabaseMemberRequest): Promise<$_model.CreateContextDatabaseMemberResponse>;
+    /**
+     * 创建上下文数据库工作区
+     *
+     * @remarks
+     * 创建 workspace + 首位成员 + 首把 API Key 的一次性引导，返回明文 apiKey。
+     *
+     * @param request - CreateContextDatabaseWorkspaceRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns CreateContextDatabaseWorkspaceResponse
+     */
+    createContextDatabaseWorkspaceWithOptions(request: $_model.CreateContextDatabaseWorkspaceRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateContextDatabaseWorkspaceResponse>;
+    /**
+     * 创建上下文数据库工作区
+     *
+     * @remarks
+     * 创建 workspace + 首位成员 + 首把 API Key 的一次性引导，返回明文 apiKey。
+     *
+     * @param request - CreateContextDatabaseWorkspaceRequest
+     * @returns CreateContextDatabaseWorkspaceResponse
+     */
+    createContextDatabaseWorkspace(request: $_model.CreateContextDatabaseWorkspaceRequest): Promise<$_model.CreateContextDatabaseWorkspaceResponse>;
     /**
      * Creates a user-specific agent.
      *
@@ -182,8 +245,8 @@ export default class Client extends OpenApi {
      * @remarks
      * ### Applicable engine
      * RDS PostgreSQL
-     * ### Related feature documentation
-     * >Warning: This API operation incurs fees. Read the related feature documentation before you perform this operation.
+     * ### Related documentation
+     * >Warning: This API operation incurs fees. Read the related documentation carefully before you perform this operation.
      * [RDS Supabase](https://help.aliyun.com/document_detail/2938735.html)
      *
      * @param request - CreateScheduledTaskRequest
@@ -197,8 +260,8 @@ export default class Client extends OpenApi {
      * @remarks
      * ### Applicable engine
      * RDS PostgreSQL
-     * ### Related feature documentation
-     * >Warning: This API operation incurs fees. Read the related feature documentation before you perform this operation.
+     * ### Related documentation
+     * >Warning: This API operation incurs fees. Read the related documentation carefully before you perform this operation.
      * [RDS Supabase](https://help.aliyun.com/document_detail/2938735.html)
      *
      * @param request - CreateScheduledTaskRequest
@@ -225,7 +288,7 @@ export default class Client extends OpenApi {
      *
      * @remarks
      * ### Applicable engine
-     * [RDS AI Assistant Enterprise Edition](https://help.aliyun.com/zh/rds/apsaradb-rds-for-mysql/rds-copilot-ultra)
+     * [RDS AI Assistant Ultimate Edition](https://www.alibabacloud.com/help/en/rds/apsaradb-rds-for-mysql/rds-copilot-ultra)
      *
      * @param request - DeleteApiKeyRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -237,7 +300,7 @@ export default class Client extends OpenApi {
      *
      * @remarks
      * ### Applicable engine
-     * [RDS AI Assistant Enterprise Edition](https://help.aliyun.com/zh/rds/apsaradb-rds-for-mysql/rds-copilot-ultra)
+     * [RDS AI Assistant Ultimate Edition](https://www.alibabacloud.com/help/en/rds/apsaradb-rds-for-mysql/rds-copilot-ultra)
      *
      * @param request - DeleteApiKeyRequest
      * @returns DeleteApiKeyResponse
@@ -274,6 +337,48 @@ export default class Client extends OpenApi {
      * @returns DeleteAppInstanceResponse
      */
     deleteAppInstance(request: $_model.DeleteAppInstanceRequest): Promise<$_model.DeleteAppInstanceResponse>;
+    /**
+     * 删除上下文数据库成员
+     *
+     * @remarks
+     * 删除成员（硬删除，不可恢复）。
+     *
+     * @param request - DeleteContextDatabaseMemberRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns DeleteContextDatabaseMemberResponse
+     */
+    deleteContextDatabaseMemberWithOptions(request: $_model.DeleteContextDatabaseMemberRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteContextDatabaseMemberResponse>;
+    /**
+     * 删除上下文数据库成员
+     *
+     * @remarks
+     * 删除成员（硬删除，不可恢复）。
+     *
+     * @param request - DeleteContextDatabaseMemberRequest
+     * @returns DeleteContextDatabaseMemberResponse
+     */
+    deleteContextDatabaseMember(request: $_model.DeleteContextDatabaseMemberRequest): Promise<$_model.DeleteContextDatabaseMemberResponse>;
+    /**
+     * 删除上下文数据库工作区
+     *
+     * @remarks
+     * 删除业务空间（Workspace），硬删除、不可恢复。删除成功后本地元数据同步软删除，已删除的业务空间不再计入配额。
+     *
+     * @param request - DeleteContextDatabaseWorkspaceRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns DeleteContextDatabaseWorkspaceResponse
+     */
+    deleteContextDatabaseWorkspaceWithOptions(request: $_model.DeleteContextDatabaseWorkspaceRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteContextDatabaseWorkspaceResponse>;
+    /**
+     * 删除上下文数据库工作区
+     *
+     * @remarks
+     * 删除业务空间（Workspace），硬删除、不可恢复。删除成功后本地元数据同步软删除，已删除的业务空间不再计入配额。
+     *
+     * @param request - DeleteContextDatabaseWorkspaceRequest
+     * @returns DeleteContextDatabaseWorkspaceResponse
+     */
+    deleteContextDatabaseWorkspace(request: $_model.DeleteContextDatabaseWorkspaceRequest): Promise<$_model.DeleteContextDatabaseWorkspaceResponse>;
     /**
      * Deletes the dedicated agent created by a user.
      *
@@ -876,7 +981,7 @@ export default class Client extends OpenApi {
      */
     getInspectionReport(request: $_model.GetInspectionReportRequest): Promise<$_model.GetInspectionReportResponse>;
     /**
-     * Retrieves a list of messages in a specific conversation.
+     * Queries the details of specific conversation messages.
      *
      * @param request - GetMessagesRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -884,7 +989,7 @@ export default class Client extends OpenApi {
      */
     getMessagesWithOptions(request: $_model.GetMessagesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetMessagesResponse>;
     /**
-     * Retrieves a list of messages in a specific conversation.
+     * Queries the details of specific conversation messages.
      *
      * @param request - GetMessagesRequest
      * @returns GetMessagesResponse
@@ -912,7 +1017,7 @@ export default class Client extends OpenApi {
      */
     getModelOperatorOrder(request: $_model.GetModelOperatorOrderRequest): Promise<$_model.GetModelOperatorOrderResponse>;
     /**
-     * Queries the IDs of all instances that are included by a specified scheduled inspection configuration.
+     * Queries the list of all instance IDs included in a specified scheduled inspection configuration.
      *
      * @param request - GetScheduledInstancesRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -920,14 +1025,14 @@ export default class Client extends OpenApi {
      */
     getScheduledInstancesWithOptions(request: $_model.GetScheduledInstancesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetScheduledInstancesResponse>;
     /**
-     * Queries the IDs of all instances that are included by a specified scheduled inspection configuration.
+     * Queries the list of all instance IDs included in a specified scheduled inspection configuration.
      *
      * @param request - GetScheduledInstancesRequest
      * @returns GetScheduledInstancesResponse
      */
     getScheduledInstances(request: $_model.GetScheduledInstancesRequest): Promise<$_model.GetScheduledInstancesResponse>;
     /**
-     * Queries all inspection reports under a specified scheduled task, with support for time range filtering and pagination.
+     * Queries all inspection reports under a specified scheduled task, with support for filtering by time range and pagination.
      *
      * @param request - GetScheduledReportsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -935,7 +1040,7 @@ export default class Client extends OpenApi {
      */
     getScheduledReportsWithOptions(request: $_model.GetScheduledReportsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetScheduledReportsResponse>;
     /**
-     * Queries all inspection reports under a specified scheduled task, with support for time range filtering and pagination.
+     * Queries all inspection reports under a specified scheduled task, with support for filtering by time range and pagination.
      *
      * @param request - GetScheduledReportsRequest
      * @returns GetScheduledReportsResponse
@@ -994,6 +1099,69 @@ export default class Client extends OpenApi {
      * @returns ListApiKeysResponse
      */
     listApiKeys(request: $_model.ListApiKeysRequest): Promise<$_model.ListApiKeysResponse>;
+    /**
+     * 列出成员名下 API Key
+     *
+     * @remarks
+     * 列出指定成员名下的 API Key（不返回明文）。
+     *
+     * @param request - ListContextDatabaseApiKeysRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns ListContextDatabaseApiKeysResponse
+     */
+    listContextDatabaseApiKeysWithOptions(request: $_model.ListContextDatabaseApiKeysRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListContextDatabaseApiKeysResponse>;
+    /**
+     * 列出成员名下 API Key
+     *
+     * @remarks
+     * 列出指定成员名下的 API Key（不返回明文）。
+     *
+     * @param request - ListContextDatabaseApiKeysRequest
+     * @returns ListContextDatabaseApiKeysResponse
+     */
+    listContextDatabaseApiKeys(request: $_model.ListContextDatabaseApiKeysRequest): Promise<$_model.ListContextDatabaseApiKeysResponse>;
+    /**
+     * 列出工作区成员
+     *
+     * @remarks
+     * 列出指定业务空间下的全部成员，每个成员附带其名下 API Key 列表（不返回明文）。
+     *
+     * @param request - ListContextDatabaseMembersRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns ListContextDatabaseMembersResponse
+     */
+    listContextDatabaseMembersWithOptions(request: $_model.ListContextDatabaseMembersRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListContextDatabaseMembersResponse>;
+    /**
+     * 列出工作区成员
+     *
+     * @remarks
+     * 列出指定业务空间下的全部成员，每个成员附带其名下 API Key 列表（不返回明文）。
+     *
+     * @param request - ListContextDatabaseMembersRequest
+     * @returns ListContextDatabaseMembersResponse
+     */
+    listContextDatabaseMembers(request: $_model.ListContextDatabaseMembersRequest): Promise<$_model.ListContextDatabaseMembersResponse>;
+    /**
+     * 根据workspaceId和状态过滤调用方账号下的工作区列表。
+     *
+     * @remarks
+     * 列出上下文数据库工作空间
+     *
+     * @param request - ListContextDatabaseWorkspacesRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns ListContextDatabaseWorkspacesResponse
+     */
+    listContextDatabaseWorkspacesWithOptions(request: $_model.ListContextDatabaseWorkspacesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListContextDatabaseWorkspacesResponse>;
+    /**
+     * 根据workspaceId和状态过滤调用方账号下的工作区列表。
+     *
+     * @remarks
+     * 列出上下文数据库工作空间
+     *
+     * @param request - ListContextDatabaseWorkspacesRequest
+     * @returns ListContextDatabaseWorkspacesResponse
+     */
+    listContextDatabaseWorkspaces(request: $_model.ListContextDatabaseWorkspacesRequest): Promise<$_model.ListContextDatabaseWorkspacesResponse>;
     /**
      * Lists your custom agents.
      *
@@ -1349,11 +1517,11 @@ export default class Client extends OpenApi {
      */
     modifyWhitelistIps(request: $_model.ModifyWhitelistIpsRequest): Promise<$_model.ModifyWhitelistIpsResponse>;
     /**
-     * Renames an API key.
+     * Renames a custom API key.
      *
      * @remarks
-     * ### Applicable engines
-     * [RDS AI Assistant (Ultimate Edition)](https://help.aliyun.com/zh/rds/apsaradb-rds-for-mysql/rds-copilot-ultra)
+     * ### Applicable engine
+     * [RDS AI Assistant Ultimate Edition](https://www.alibabacloud.com/help/en/rds/apsaradb-rds-for-mysql/rds-copilot-ultra)
      *
      * @param request - RenameApiKeyRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1361,11 +1529,11 @@ export default class Client extends OpenApi {
      */
     renameApiKeyWithOptions(request: $_model.RenameApiKeyRequest, runtime: $dara.RuntimeOptions): Promise<$_model.RenameApiKeyResponse>;
     /**
-     * Renames an API key.
+     * Renames a custom API key.
      *
      * @remarks
-     * ### Applicable engines
-     * [RDS AI Assistant (Ultimate Edition)](https://help.aliyun.com/zh/rds/apsaradb-rds-for-mysql/rds-copilot-ultra)
+     * ### Applicable engine
+     * [RDS AI Assistant Ultimate Edition](https://www.alibabacloud.com/help/en/rds/apsaradb-rds-for-mysql/rds-copilot-ultra)
      *
      * @param request - RenameApiKeyRequest
      * @returns RenameApiKeyResponse
@@ -1477,6 +1645,27 @@ export default class Client extends OpenApi {
      * @returns RestartInstanceResponse
      */
     restartInstance(request: $_model.RestartInstanceRequest): Promise<$_model.RestartInstanceResponse>;
+    /**
+     * 吊销上下文数据库 API Key
+     *
+     * @remarks
+     * 吊销 API Key。
+     *
+     * @param request - RevokeContextDatabaseApiKeyRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns RevokeContextDatabaseApiKeyResponse
+     */
+    revokeContextDatabaseApiKeyWithOptions(request: $_model.RevokeContextDatabaseApiKeyRequest, runtime: $dara.RuntimeOptions): Promise<$_model.RevokeContextDatabaseApiKeyResponse>;
+    /**
+     * 吊销上下文数据库 API Key
+     *
+     * @remarks
+     * 吊销 API Key。
+     *
+     * @param request - RevokeContextDatabaseApiKeyRequest
+     * @returns RevokeContextDatabaseApiKeyResponse
+     */
+    revokeContextDatabaseApiKey(request: $_model.RevokeContextDatabaseApiKeyRequest): Promise<$_model.RevokeContextDatabaseApiKeyResponse>;
     /**
      * Starts an RDS AI application instance that is in the Stopped state.
      *
@@ -1554,6 +1743,69 @@ export default class Client extends OpenApi {
      * @returns UpdateApiKeyQuotaResponse
      */
     updateApiKeyQuota(request: $_model.UpdateApiKeyQuotaRequest): Promise<$_model.UpdateApiKeyQuotaResponse>;
+    /**
+     * 更新上下文数据库 API Key 元数据
+     *
+     * @remarks
+     * 更新 API Key 的展示元数据。Name 与 Description 至少传其一；明文 Key 不重新签发。
+     *
+     * @param request - UpdateContextDatabaseApiKeyRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns UpdateContextDatabaseApiKeyResponse
+     */
+    updateContextDatabaseApiKeyWithOptions(request: $_model.UpdateContextDatabaseApiKeyRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateContextDatabaseApiKeyResponse>;
+    /**
+     * 更新上下文数据库 API Key 元数据
+     *
+     * @remarks
+     * 更新 API Key 的展示元数据。Name 与 Description 至少传其一；明文 Key 不重新签发。
+     *
+     * @param request - UpdateContextDatabaseApiKeyRequest
+     * @returns UpdateContextDatabaseApiKeyResponse
+     */
+    updateContextDatabaseApiKey(request: $_model.UpdateContextDatabaseApiKeyRequest): Promise<$_model.UpdateContextDatabaseApiKeyResponse>;
+    /**
+     * 更新上下文数据库成员
+     *
+     * @remarks
+     * 更新成员的角色 / 状态。
+     *
+     * @param request - UpdateContextDatabaseMemberRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns UpdateContextDatabaseMemberResponse
+     */
+    updateContextDatabaseMemberWithOptions(request: $_model.UpdateContextDatabaseMemberRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateContextDatabaseMemberResponse>;
+    /**
+     * 更新上下文数据库成员
+     *
+     * @remarks
+     * 更新成员的角色 / 状态。
+     *
+     * @param request - UpdateContextDatabaseMemberRequest
+     * @returns UpdateContextDatabaseMemberResponse
+     */
+    updateContextDatabaseMember(request: $_model.UpdateContextDatabaseMemberRequest): Promise<$_model.UpdateContextDatabaseMemberResponse>;
+    /**
+     * 修改上下文数据库工作区
+     *
+     * @remarks
+     * 修改 workspace 名称。
+     *
+     * @param request - UpdateContextDatabaseWorkspaceRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns UpdateContextDatabaseWorkspaceResponse
+     */
+    updateContextDatabaseWorkspaceWithOptions(request: $_model.UpdateContextDatabaseWorkspaceRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateContextDatabaseWorkspaceResponse>;
+    /**
+     * 修改上下文数据库工作区
+     *
+     * @remarks
+     * 修改 workspace 名称。
+     *
+     * @param request - UpdateContextDatabaseWorkspaceRequest
+     * @returns UpdateContextDatabaseWorkspaceResponse
+     */
+    updateContextDatabaseWorkspace(request: $_model.UpdateContextDatabaseWorkspaceRequest): Promise<$_model.UpdateContextDatabaseWorkspaceResponse>;
     /**
      * Updates a custom agent.
      *