@alicloud/dms20250414 1.15.0 → 1.17.0

package/dist/client.d.ts

@@ -140,6 +140,21 @@ export default class Client extends OpenApi {
      * @returns CreateCustomAgentResponse
      */
     createCustomAgent(request: $_model.CreateCustomAgentRequest): Promise<$_model.CreateCustomAgentResponse>;
+    /**
+     * Creates an accuracy test instance.
+     *
+     * @param request - CreateDataAgentAccuracyTestRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns CreateDataAgentAccuracyTestResponse
+     */
+    createDataAgentAccuracyTestWithOptions(request: $_model.CreateDataAgentAccuracyTestRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateDataAgentAccuracyTestResponse>;
+    /**
+     * Creates an accuracy test instance.
+     *
+     * @param request - CreateDataAgentAccuracyTestRequest
+     * @returns CreateDataAgentAccuracyTestResponse
+     */
+    createDataAgentAccuracyTest(request: $_model.CreateDataAgentAccuracyTestRequest): Promise<$_model.CreateDataAgentAccuracyTestResponse>;
     /**
      * Creates a DataAgent knowledge base. The knowledge base creator has read and write permissions. Other workspace members have permission to use it.
      *
@@ -171,7 +186,7 @@ export default class Client extends OpenApi {
      */
     createDataAgentSession(request: $_model.CreateDataAgentSessionRequest): Promise<$_model.CreateDataAgentSessionResponse>;
     /**
-     * Creates a DataAgent collaborative workspace.
+     * Creates a DataAgent workspace.
      *
      * @param request - CreateDataAgentWorkspaceRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -179,7 +194,7 @@ export default class Client extends OpenApi {
      */
     createDataAgentWorkspaceWithOptions(request: $_model.CreateDataAgentWorkspaceRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateDataAgentWorkspaceResponse>;
     /**
-     * Creates a DataAgent collaborative workspace.
+     * Creates a DataAgent workspace.
      *
      * @param request - CreateDataAgentWorkspaceRequest
      * @returns CreateDataAgentWorkspaceResponse
@@ -275,6 +290,42 @@ export default class Client extends OpenApi {
      * @returns DeleteCustomAgentResponse
      */
     deleteCustomAgent(request: $_model.DeleteCustomAgentRequest): Promise<$_model.DeleteCustomAgentResponse>;
+    /**
+     * Releases a DataAgent seat.
+     *
+     * @param request - DeleteDataAgentRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns DeleteDataAgentResponse
+     */
+    deleteDataAgentWithOptions(request: $_model.DeleteDataAgentRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteDataAgentResponse>;
+    /**
+     * Releases a DataAgent seat.
+     *
+     * @param request - DeleteDataAgentRequest
+     * @returns DeleteDataAgentResponse
+     */
+    deleteDataAgent(request: $_model.DeleteDataAgentRequest): Promise<$_model.DeleteDataAgentResponse>;
+    /**
+     * Deletes an accuracy test configuration item.
+     *
+     * @remarks
+     * Deletes an accuracy test item.
+     *
+     * @param request - DeleteDataAgentAccuracyTestRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns DeleteDataAgentAccuracyTestResponse
+     */
+    deleteDataAgentAccuracyTestWithOptions(request: $_model.DeleteDataAgentAccuracyTestRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteDataAgentAccuracyTestResponse>;
+    /**
+     * Deletes an accuracy test configuration item.
+     *
+     * @remarks
+     * Deletes an accuracy test item.
+     *
+     * @param request - DeleteDataAgentAccuracyTestRequest
+     * @returns DeleteDataAgentAccuracyTestResponse
+     */
+    deleteDataAgentAccuracyTest(request: $_model.DeleteDataAgentAccuracyTestRequest): Promise<$_model.DeleteDataAgentAccuracyTestResponse>;
     /**
      * Deletes a DataAgent knowledge base.
      *
@@ -446,6 +497,21 @@ export default class Client extends OpenApi {
      * @returns DescribeCustomAgentResponse
      */
     describeCustomAgent(request: $_model.DescribeCustomAgentRequest): Promise<$_model.DescribeCustomAgentResponse>;
+    /**
+     * Queries DataAgent metrics.
+     *
+     * @param request - DescribeDataAgentMetricsRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns DescribeDataAgentMetricsResponse
+     */
+    describeDataAgentMetricsWithOptions(request: $_model.DescribeDataAgentMetricsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeDataAgentMetricsResponse>;
+    /**
+     * Queries DataAgent metrics.
+     *
+     * @param request - DescribeDataAgentMetricsRequest
+     * @returns DescribeDataAgentMetricsResponse
+     */
+    describeDataAgentMetrics(request: $_model.DescribeDataAgentMetricsRequest): Promise<$_model.DescribeDataAgentMetricsResponse>;
     /**
      * Retrieves the description of a DataAgent session.
      *
@@ -477,7 +543,7 @@ export default class Client extends OpenApi {
      */
     describeDocument(request: $_model.DescribeDocumentRequest): Promise<$_model.DescribeDocumentResponse>;
     /**
-     * DescribeFileUploadSignature
+     * Retrieves the signature information for file uploads.
      *
      * @param request - DescribeFileUploadSignatureRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -485,7 +551,7 @@ export default class Client extends OpenApi {
      */
     describeFileUploadSignatureWithOptions(request: $_model.DescribeFileUploadSignatureRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeFileUploadSignatureResponse>;
     /**
-     * DescribeFileUploadSignature
+     * Retrieves the signature information for file uploads.
      *
      * @param request - DescribeFileUploadSignatureRequest
      * @returns DescribeFileUploadSignatureResponse
@@ -522,7 +588,7 @@ export default class Client extends OpenApi {
      */
     describeKnowledgeBaseUploadSignature(request: $_model.DescribeKnowledgeBaseUploadSignatureRequest): Promise<$_model.DescribeKnowledgeBaseUploadSignatureResponse>;
     /**
-     * FileUploadCallback
+     * Calls back after a file is uploaded.
      *
      * @param request - FileUploadCallbackRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -530,12 +596,27 @@ export default class Client extends OpenApi {
      */
     fileUploadCallbackWithOptions(request: $_model.FileUploadCallbackRequest, runtime: $dara.RuntimeOptions): Promise<$_model.FileUploadCallbackResponse>;
     /**
-     * FileUploadCallback
+     * Calls back after a file is uploaded.
      *
      * @param request - FileUploadCallbackRequest
      * @returns FileUploadCallbackResponse
      */
     fileUploadCallback(request: $_model.FileUploadCallbackRequest): Promise<$_model.FileUploadCallbackResponse>;
+    /**
+     * Queries agent information by install token.
+     *
+     * @param request - GetAgenticAgentByInstallTokenRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns GetAgenticAgentByInstallTokenResponse
+     */
+    getAgenticAgentByInstallTokenWithOptions(request: $_model.GetAgenticAgentByInstallTokenRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetAgenticAgentByInstallTokenResponse>;
+    /**
+     * Queries agent information by install token.
+     *
+     * @param request - GetAgenticAgentByInstallTokenRequest
+     * @returns GetAgenticAgentByInstallTokenResponse
+     */
+    getAgenticAgentByInstallToken(request: $_model.GetAgenticAgentByInstallTokenRequest): Promise<$_model.GetAgenticAgentByInstallTokenResponse>;
     /**
      * Queries the configuration and status of an Airflow instance.
      *
@@ -853,6 +934,69 @@ export default class Client extends OpenApi {
      * @returns ListCustomAgentResponse
      */
     listCustomAgent(request: $_model.ListCustomAgentRequest): Promise<$_model.ListCustomAgentResponse>;
+    /**
+     * Lists accuracy test configuration items that meet the specified conditions.
+     *
+     * @remarks
+     * Lists accuracy test configuration items that meet the specified conditions.
+     *
+     * @param request - ListDataAgentAccuracyTestInstancesRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns ListDataAgentAccuracyTestInstancesResponse
+     */
+    listDataAgentAccuracyTestInstancesWithOptions(request: $_model.ListDataAgentAccuracyTestInstancesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListDataAgentAccuracyTestInstancesResponse>;
+    /**
+     * Lists accuracy test configuration items that meet the specified conditions.
+     *
+     * @remarks
+     * Lists accuracy test configuration items that meet the specified conditions.
+     *
+     * @param request - ListDataAgentAccuracyTestInstancesRequest
+     * @returns ListDataAgentAccuracyTestInstancesResponse
+     */
+    listDataAgentAccuracyTestInstances(request: $_model.ListDataAgentAccuracyTestInstancesRequest): Promise<$_model.ListDataAgentAccuracyTestInstancesResponse>;
+    /**
+     * Retrieves the execution results of a self-test task.
+     *
+     * @remarks
+     * Retrieves the execution results of a self-test task.
+     *
+     * @param request - ListDataAgentAccuracyTestResultsRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns ListDataAgentAccuracyTestResultsResponse
+     */
+    listDataAgentAccuracyTestResultsWithOptions(request: $_model.ListDataAgentAccuracyTestResultsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListDataAgentAccuracyTestResultsResponse>;
+    /**
+     * Retrieves the execution results of a self-test task.
+     *
+     * @remarks
+     * Retrieves the execution results of a self-test task.
+     *
+     * @param request - ListDataAgentAccuracyTestResultsRequest
+     * @returns ListDataAgentAccuracyTestResultsResponse
+     */
+    listDataAgentAccuracyTestResults(request: $_model.ListDataAgentAccuracyTestResultsRequest): Promise<$_model.ListDataAgentAccuracyTestResultsResponse>;
+    /**
+     * Queries the running status of accuracy test nodes by using paging.
+     *
+     * @remarks
+     * Queries the running status of self-test nodes by using paging. If AccuracyTestInsId or AccuracyTestTaskId is empty, all test nodes are queried.
+     *
+     * @param request - ListDataAgentAccuracyTestTasksRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns ListDataAgentAccuracyTestTasksResponse
+     */
+    listDataAgentAccuracyTestTasksWithOptions(request: $_model.ListDataAgentAccuracyTestTasksRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListDataAgentAccuracyTestTasksResponse>;
+    /**
+     * Queries the running status of accuracy test nodes by using paging.
+     *
+     * @remarks
+     * Queries the running status of self-test nodes by using paging. If AccuracyTestInsId or AccuracyTestTaskId is empty, all test nodes are queried.
+     *
+     * @param request - ListDataAgentAccuracyTestTasksRequest
+     * @returns ListDataAgentAccuracyTestTasksResponse
+     */
+    listDataAgentAccuracyTestTasks(request: $_model.ListDataAgentAccuracyTestTasksRequest): Promise<$_model.ListDataAgentAccuracyTestTasksResponse>;
     /**
      * Retrieves the list of historical session descriptions for a Data Agent.
      *
@@ -899,7 +1043,7 @@ export default class Client extends OpenApi {
      */
     listDataAgentWorkspaceMember(request: $_model.ListDataAgentWorkspaceMemberRequest): Promise<$_model.ListDataAgentWorkspaceMemberResponse>;
     /**
-     * Lists user-uploaded files in a data center, excluding databases.
+     * Retrieves the list of files uploaded by users in the data center. Only file types are supported. Database types are not supported.
      *
      * @param request - ListDataCenterDatabaseRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -907,7 +1051,7 @@ export default class Client extends OpenApi {
      */
     listDataCenterDatabaseWithOptions(request: $_model.ListDataCenterDatabaseRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListDataCenterDatabaseResponse>;
     /**
-     * Lists user-uploaded files in a data center, excluding databases.
+     * Retrieves the list of files uploaded by users in the data center. Only file types are supported. Database types are not supported.
      *
      * @param request - ListDataCenterDatabaseRequest
      * @returns ListDataCenterDatabaseResponse
@@ -1244,7 +1388,7 @@ export default class Client extends OpenApi {
      * Saves workspace code. If the file does not exist, a new file is automatically created.
      *
      * @remarks
-     * 发布工作空间的代码
+     * Publishes workspace code.
      *
      * @param request - SaveWorkspaceCodeRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1255,23 +1399,23 @@ export default class Client extends OpenApi {
      * Saves workspace code. If the file does not exist, a new file is automatically created.
      *
      * @remarks
-     * 发布工作空间的代码
+     * Publishes workspace code.
      *
      * @param request - SaveWorkspaceCodeRequest
      * @returns SaveWorkspaceCodeResponse
      */
     saveWorkspaceCode(request: $_model.SaveWorkspaceCodeRequest): Promise<$_model.SaveWorkspaceCodeResponse>;
     /**
-     * Send a user message to a specified session or cancel the session.
+     * Sends a user message to a specified session or cancels a session.
      *
      * @remarks
      * ## Request description
      * - `agent_id` and `session_id` are required fields.
-     * - `message_type` defaults to `primary`. When you need to append information or cancel a session, set it to `additional` or `cancel`.
-     * - The `reply_to` field indicates which Agent message this message is responding to. The default value is `0`.
+     * - `message_type` defaults to `primary`. Set it to `additional` or `cancel` when you need to append information or cancel a session.
+     * - The `reply_to` field indicates which agent message this message is responding to. The default value is `0`.
      * - When `message_type` is `additional`, the `question` field is required.
-     * - `quoted_message` can be used to quote the content of the user\\"s previous message.
-     * - Fields such as `data_source`, `dms_user`, `db_metadata`, and `session_config` are all optional, but provide more detailed context information.
+     * - `quoted_message` can be used to quote the content of a previous user message.
+     * - Fields such as `data_source`, `dms_user`, `db_metadata`, and `session_config` are optional but provide more detailed context information.
      *
      * @param tmpReq - SendChatMessageRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1279,16 +1423,16 @@ export default class Client extends OpenApi {
      */
     sendChatMessageWithOptions(tmpReq: $_model.SendChatMessageRequest, runtime: $dara.RuntimeOptions): Promise<$_model.SendChatMessageResponse>;
     /**
-     * Send a user message to a specified session or cancel the session.
+     * Sends a user message to a specified session or cancels a session.
      *
      * @remarks
      * ## Request description
      * - `agent_id` and `session_id` are required fields.
-     * - `message_type` defaults to `primary`. When you need to append information or cancel a session, set it to `additional` or `cancel`.
-     * - The `reply_to` field indicates which Agent message this message is responding to. The default value is `0`.
+     * - `message_type` defaults to `primary`. Set it to `additional` or `cancel` when you need to append information or cancel a session.
+     * - The `reply_to` field indicates which agent message this message is responding to. The default value is `0`.
      * - When `message_type` is `additional`, the `question` field is required.
-     * - `quoted_message` can be used to quote the content of the user\\"s previous message.
-     * - Fields such as `data_source`, `dms_user`, `db_metadata`, and `session_config` are all optional, but provide more detailed context information.
+     * - `quoted_message` can be used to quote the content of a previous user message.
+     * - Fields such as `data_source`, `dms_user`, `db_metadata`, and `session_config` are optional but provide more detailed context information.
      *
      * @param request - SendChatMessageRequest
      * @returns SendChatMessageResponse
@@ -1336,6 +1480,48 @@ export default class Client extends OpenApi {
      * @returns SetWorkspaceQuotaResponse
      */
     setWorkspaceQuota(request: $_model.SetWorkspaceQuotaRequest): Promise<$_model.SetWorkspaceQuotaResponse>;
+    /**
+     * Initiates an accuracy self-test task.
+     *
+     * @remarks
+     * Initiates an accuracy self-test task.
+     *
+     * @param request - StartDataAgentAccuracyTestTaskRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns StartDataAgentAccuracyTestTaskResponse
+     */
+    startDataAgentAccuracyTestTaskWithOptions(request: $_model.StartDataAgentAccuracyTestTaskRequest, runtime: $dara.RuntimeOptions): Promise<$_model.StartDataAgentAccuracyTestTaskResponse>;
+    /**
+     * Initiates an accuracy self-test task.
+     *
+     * @remarks
+     * Initiates an accuracy self-test task.
+     *
+     * @param request - StartDataAgentAccuracyTestTaskRequest
+     * @returns StartDataAgentAccuracyTestTaskResponse
+     */
+    startDataAgentAccuracyTestTask(request: $_model.StartDataAgentAccuracyTestTaskRequest): Promise<$_model.StartDataAgentAccuracyTestTaskResponse>;
+    /**
+     * Stops an accuracy self-test task.
+     *
+     * @remarks
+     * Stops an accuracy self-test task.
+     *
+     * @param request - StopDataAgentAccuracyTestTaskRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns StopDataAgentAccuracyTestTaskResponse
+     */
+    stopDataAgentAccuracyTestTaskWithOptions(request: $_model.StopDataAgentAccuracyTestTaskRequest, runtime: $dara.RuntimeOptions): Promise<$_model.StopDataAgentAccuracyTestTaskResponse>;
+    /**
+     * Stops an accuracy self-test task.
+     *
+     * @remarks
+     * Stops an accuracy self-test task.
+     *
+     * @param request - StopDataAgentAccuracyTestTaskRequest
+     * @returns StopDataAgentAccuracyTestTaskResponse
+     */
+    stopDataAgentAccuracyTestTask(request: $_model.StopDataAgentAccuracyTestTaskRequest): Promise<$_model.StopDataAgentAccuracyTestTaskResponse>;
     /**
      * Updates the properties of an Airflow instance.
      *
@@ -1351,6 +1537,27 @@ export default class Client extends OpenApi {
      * @returns UpdateAirflowResponse
      */
     updateAirflow(request: $_model.UpdateAirflowRequest): Promise<$_model.UpdateAirflowResponse>;
+    /**
+     * Updates the content of an accuracy test item.
+     *
+     * @remarks
+     * Updates the content of an accuracy test item.
+     *
+     * @param request - UpdateDataAgentAccuracyTestRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns UpdateDataAgentAccuracyTestResponse
+     */
+    updateDataAgentAccuracyTestWithOptions(request: $_model.UpdateDataAgentAccuracyTestRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateDataAgentAccuracyTestResponse>;
+    /**
+     * Updates the content of an accuracy test item.
+     *
+     * @remarks
+     * Updates the content of an accuracy test item.
+     *
+     * @param request - UpdateDataAgentAccuracyTestRequest
+     * @returns UpdateDataAgentAccuracyTestResponse
+     */
+    updateDataAgentAccuracyTest(request: $_model.UpdateDataAgentAccuracyTestRequest): Promise<$_model.UpdateDataAgentAccuracyTestResponse>;
     /**
      * Updates workspace information.
      *