@alicloud/dataworks-public20240518 9.11.1 → 10.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client.d.ts +777 -431
- package/dist/client.js +1397 -443
- package/dist/client.js.map +1 -1
- package/dist/models/ApplyResourceAccessPermissionRequest.d.ts +26 -24
- package/dist/models/ApplyResourceAccessPermissionRequest.js.map +1 -1
- package/dist/models/ApplyResourceAccessPermissionResponseBody.d.ts +2 -2
- package/dist/models/ApplyResourceAccessPermissionShrinkRequest.d.ts +4 -4
- package/dist/models/ArchiveAgentSessionRequest.d.ts +66 -0
- package/dist/models/ArchiveAgentSessionRequest.js +86 -0
- package/dist/models/ArchiveAgentSessionRequest.js.map +1 -0
- package/dist/models/ArchiveAgentSessionResponse.d.ts +19 -0
- package/dist/models/ArchiveAgentSessionResponse.js +69 -0
- package/dist/models/ArchiveAgentSessionResponse.js.map +1 -0
- package/dist/models/ArchiveAgentSessionResponseBody.d.ts +141 -0
- package/dist/models/ArchiveAgentSessionResponseBody.js +142 -0
- package/dist/models/ArchiveAgentSessionResponseBody.js.map +1 -0
- package/dist/models/ArchiveAgentSessionShrinkRequest.d.ts +36 -0
- package/dist/models/ArchiveAgentSessionShrinkRequest.js +62 -0
- package/dist/models/ArchiveAgentSessionShrinkRequest.js.map +1 -0
- package/dist/models/BatchUpdateTasksRequest.d.ts +29 -29
- package/dist/models/BatchUpdateTasksResponseBody.d.ts +5 -2
- package/dist/models/BatchUpdateTasksResponseBody.js.map +1 -1
- package/dist/models/BatchUpdateTasksShrinkRequest.d.ts +1 -1
- package/dist/models/BuildImageRequest.d.ts +3 -3
- package/dist/models/BuildImageResponseBody.d.ts +3 -3
- package/dist/models/CancelImageTestRequest.d.ts +1 -1
- package/dist/models/CancelImageTestResponseBody.d.ts +4 -4
- package/dist/models/Column.d.ts +22 -13
- package/dist/models/Column.js.map +1 -1
- package/dist/models/CreateAgentRequest.d.ts +45 -16
- package/dist/models/CreateAgentRequest.js +11 -0
- package/dist/models/CreateAgentRequest.js.map +1 -1
- package/dist/models/CreateAgentResponseBody.d.ts +9 -13
- package/dist/models/CreateAgentResponseBody.js +2 -2
- package/dist/models/CreateAgentResponseBody.js.map +1 -1
- package/dist/models/CreateAgentSessionRequest.d.ts +21 -13
- package/dist/models/CreateAgentSessionRequest.js +2 -0
- package/dist/models/CreateAgentSessionRequest.js.map +1 -1
- package/dist/models/CreateAgentSessionResponseBody.d.ts +6 -6
- package/dist/models/CreateAgentSessionShrinkRequest.d.ts +1 -1
- package/dist/models/CreateAgentShrinkRequest.d.ts +5 -8
- package/dist/models/CreateAgentShrinkRequest.js.map +1 -1
- package/dist/models/CreateCodeReviewRequest.d.ts +51 -0
- package/dist/models/CreateCodeReviewRequest.js +64 -0
- package/dist/models/CreateCodeReviewRequest.js.map +1 -0
- package/dist/models/CreateCodeReviewResponse.d.ts +19 -0
- package/dist/models/CreateCodeReviewResponse.js +69 -0
- package/dist/models/CreateCodeReviewResponse.js.map +1 -0
- package/dist/models/CreateCodeReviewResponseBody.d.ts +29 -0
- package/dist/models/CreateCodeReviewResponseBody.js +60 -0
- package/dist/models/CreateCodeReviewResponseBody.js.map +1 -0
- package/dist/models/CreateCrawlerRequest.d.ts +10 -7
- package/dist/models/CreateCrawlerRequest.js.map +1 -1
- package/dist/models/CreateCrawlerResponseBody.d.ts +2 -2
- package/dist/models/CreateCrawlerShrinkRequest.d.ts +6 -3
- package/dist/models/CreateCrawlerShrinkRequest.js.map +1 -1
- package/dist/models/CreateCrossProjectPipelineRunRequest.d.ts +4 -10
- package/dist/models/CreateCrossProjectPipelineRunRequest.js.map +1 -1
- package/dist/models/CreateCrossProjectPipelineRunResponseBody.d.ts +3 -3
- package/dist/models/CreateCrossProjectPipelineRunShrinkRequest.d.ts +4 -10
- package/dist/models/CreateCrossProjectPipelineRunShrinkRequest.js.map +1 -1
- package/dist/models/CreateDataQualityScanRequest.d.ts +32 -48
- package/dist/models/CreateDataQualityScanRequest.js.map +1 -1
- package/dist/models/CreateDataQualityScanResponseBody.d.ts +2 -2
- package/dist/models/CreateDataQualityScanShrinkRequest.d.ts +9 -9
- package/dist/models/CreateDatasetRequest.d.ts +23 -20
- package/dist/models/CreateDatasetRequest.js.map +1 -1
- package/dist/models/CreateDatasetShrinkRequest.d.ts +13 -13
- package/dist/models/CreateDatasetVersionRequest.d.ts +9 -6
- package/dist/models/CreateDatasetVersionRequest.js.map +1 -1
- package/dist/models/CreateDatasetVersionResponseBody.d.ts +1 -1
- package/dist/models/CreateDatasetVersionShrinkRequest.d.ts +9 -6
- package/dist/models/CreateDatasetVersionShrinkRequest.js.map +1 -1
- package/dist/models/CreateMcpServerRequest.d.ts +5 -5
- package/dist/models/CreateMcpServerResponseBody.d.ts +4 -2
- package/dist/models/CreateMcpServerResponseBody.js.map +1 -1
- package/dist/models/CreateMcpServerShrinkRequest.d.ts +3 -3
- package/dist/models/CreateProcessDefinitionRequest.d.ts +38 -35
- package/dist/models/CreateProcessDefinitionRequest.js.map +1 -1
- package/dist/models/CreateProcessDefinitionResponseBody.d.ts +2 -2
- package/dist/models/CreateProcessDefinitionShrinkRequest.d.ts +6 -6
- package/dist/models/CreateResourceGroupRequest.d.ts +8 -8
- package/dist/models/CreateResourceGroupResponseBody.d.ts +2 -2
- package/dist/models/CreateResourceGroupShrinkRequest.d.ts +8 -8
- package/dist/models/CreateSemanticJobRequest.d.ts +6 -6
- package/dist/models/CreateSemanticJobResponseBody.d.ts +18 -15
- package/dist/models/CreateSemanticJobResponseBody.js.map +1 -1
- package/dist/models/CreateSemanticJobShrinkRequest.d.ts +6 -6
- package/dist/models/CreateSkillRequest.d.ts +16 -9
- package/dist/models/CreateSkillRequest.js.map +1 -1
- package/dist/models/CreateSkillResponseBody.d.ts +13 -6
- package/dist/models/CreateSkillResponseBody.js.map +1 -1
- package/dist/models/CreateSkillShrinkRequest.d.ts +14 -7
- package/dist/models/CreateSkillShrinkRequest.js.map +1 -1
- package/dist/models/CreateWorkflowInstancesRequest.d.ts +43 -40
- package/dist/models/CreateWorkflowInstancesRequest.js.map +1 -1
- package/dist/models/CreateWorkflowInstancesShrinkRequest.d.ts +11 -11
- package/dist/models/DataQualityEvaluationTask.d.ts +38 -40
- package/dist/models/DataQualityEvaluationTask.js.map +1 -1
- package/dist/models/DataQualityEvaluationTaskInstance.d.ts +43 -45
- package/dist/models/DataQualityEvaluationTaskInstance.js.map +1 -1
- package/dist/models/DatasetVersion.d.ts +15 -16
- package/dist/models/DatasetVersion.js.map +1 -1
- package/dist/models/DeleteAgentSessionRequest.d.ts +58 -0
- package/dist/models/DeleteAgentSessionRequest.js +84 -0
- package/dist/models/DeleteAgentSessionRequest.js.map +1 -0
- package/dist/models/DeleteAgentSessionResponse.d.ts +19 -0
- package/dist/models/DeleteAgentSessionResponse.js +69 -0
- package/dist/models/DeleteAgentSessionResponse.js.map +1 -0
- package/dist/models/DeleteAgentSessionResponseBody.d.ts +119 -0
- package/dist/models/DeleteAgentSessionResponseBody.js +118 -0
- package/dist/models/DeleteAgentSessionResponseBody.js.map +1 -0
- package/dist/models/DeleteAgentSessionShrinkRequest.d.ts +36 -0
- package/dist/models/DeleteAgentSessionShrinkRequest.js +62 -0
- package/dist/models/DeleteAgentSessionShrinkRequest.js.map +1 -0
- package/dist/models/DeleteTaskRequest.d.ts +1 -1
- package/dist/models/DeleteTaskResponseBody.d.ts +1 -1
- package/dist/models/GetAgentRequest.d.ts +2 -2
- package/dist/models/GetAgentResponseBody.d.ts +24 -28
- package/dist/models/GetAgentResponseBody.js +2 -2
- package/dist/models/GetAgentResponseBody.js.map +1 -1
- package/dist/models/GetAgentSessionEventsRequest.d.ts +31 -0
- package/dist/models/GetAgentSessionEventsRequest.js +60 -0
- package/dist/models/GetAgentSessionEventsRequest.js.map +1 -0
- package/dist/models/GetAgentSessionEventsResponse.d.ts +21 -0
- package/dist/models/GetAgentSessionEventsResponse.js +73 -0
- package/dist/models/GetAgentSessionEventsResponse.js.map +1 -0
- package/dist/models/GetAgentSessionEventsResponseBody.d.ts +45 -0
- package/dist/models/GetAgentSessionEventsResponseBody.js +64 -0
- package/dist/models/GetAgentSessionEventsResponseBody.js.map +1 -0
- package/dist/models/GetApplicationContentsRequest.d.ts +1 -1
- package/dist/models/GetApplicationContentsResponseBody.d.ts +50 -50
- package/dist/models/GetCodeReviewRequest.d.ts +33 -0
- package/dist/models/GetCodeReviewRequest.js +60 -0
- package/dist/models/GetCodeReviewRequest.js.map +1 -0
- package/dist/models/GetCodeReviewResponse.d.ts +19 -0
- package/dist/models/GetCodeReviewResponse.js +69 -0
- package/dist/models/GetCodeReviewResponse.js.map +1 -0
- package/dist/models/GetCodeReviewResponseBody.d.ts +155 -0
- package/dist/models/GetCodeReviewResponseBody.js +113 -0
- package/dist/models/GetCodeReviewResponseBody.js.map +1 -0
- package/dist/models/GetCrawlerRequest.d.ts +1 -1
- package/dist/models/GetCrawlerResponseBody.d.ts +38 -19
- package/dist/models/GetCrawlerResponseBody.js.map +1 -1
- package/dist/models/GetDataQualityScanRunRequest.d.ts +1 -1
- package/dist/models/GetDataQualityScanRunResponseBody.d.ts +56 -68
- package/dist/models/GetDataQualityScanRunResponseBody.js.map +1 -1
- package/dist/models/GetImageTestResultRequest.d.ts +1 -1
- package/dist/models/GetImageTestResultResponseBody.d.ts +6 -6
- package/dist/models/GetKnowledgeBaseRequest.d.ts +23 -0
- package/dist/models/GetKnowledgeBaseRequest.js +58 -0
- package/dist/models/GetKnowledgeBaseRequest.js.map +1 -0
- package/dist/models/GetKnowledgeBaseResponse.d.ts +19 -0
- package/dist/models/GetKnowledgeBaseResponse.js +69 -0
- package/dist/models/GetKnowledgeBaseResponse.js.map +1 -0
- package/dist/models/GetKnowledgeBaseResponseBody.d.ts +131 -0
- package/dist/models/GetKnowledgeBaseResponseBody.js +104 -0
- package/dist/models/GetKnowledgeBaseResponseBody.js.map +1 -0
- package/dist/models/GetKnowledgePointRequest.d.ts +59 -0
- package/dist/models/GetKnowledgePointRequest.js +66 -0
- package/dist/models/GetKnowledgePointRequest.js.map +1 -0
- package/dist/models/GetKnowledgePointResponse.d.ts +19 -0
- package/dist/models/GetKnowledgePointResponse.js +69 -0
- package/dist/models/GetKnowledgePointResponse.js.map +1 -0
- package/dist/models/GetKnowledgePointResponseBody.d.ts +514 -0
- package/dist/models/GetKnowledgePointResponseBody.js +381 -0
- package/dist/models/GetKnowledgePointResponseBody.js.map +1 -0
- package/dist/models/GetPipelineRunResponseBody.d.ts +3 -0
- package/dist/models/GetPipelineRunResponseBody.js.map +1 -1
- package/dist/models/GetProcessDefinitionRequest.d.ts +1 -1
- package/dist/models/GetProcessDefinitionResponseBody.d.ts +57 -97
- package/dist/models/GetProcessDefinitionResponseBody.js.map +1 -1
- package/dist/models/GetProcessInstanceResponseBody.d.ts +6 -6
- package/dist/models/GetWorkflowInstanceResponseBody.d.ts +2 -2
- package/dist/models/GetWorkflowRequest.d.ts +3 -1
- package/dist/models/GetWorkflowRequest.js.map +1 -1
- package/dist/models/GetWorkflowResponseBody.d.ts +51 -47
- package/dist/models/GetWorkflowResponseBody.js.map +1 -1
- package/dist/models/IdentifyCredential.d.ts +15 -23
- package/dist/models/IdentifyCredential.js.map +1 -1
- package/dist/models/LineageTask.d.ts +4 -1
- package/dist/models/LineageTask.js.map +1 -1
- package/dist/models/ListAgentSessionsRequest.d.ts +8 -10
- package/dist/models/ListAgentSessionsRequest.js.map +1 -1
- package/dist/models/ListAgentSessionsResponseBody.d.ts +8 -8
- package/dist/models/ListAgentSessionsShrinkRequest.d.ts +2 -2
- package/dist/models/ListCodeReviewsRequest.d.ts +63 -0
- package/dist/models/ListCodeReviewsRequest.js +68 -0
- package/dist/models/ListCodeReviewsRequest.js.map +1 -0
- package/dist/models/ListCodeReviewsResponse.d.ts +19 -0
- package/dist/models/ListCodeReviewsResponse.js +69 -0
- package/dist/models/ListCodeReviewsResponse.js.map +1 -0
- package/dist/models/ListCodeReviewsResponseBody.d.ts +196 -0
- package/dist/models/ListCodeReviewsResponseBody.js +141 -0
- package/dist/models/ListCodeReviewsResponseBody.js.map +1 -0
- package/dist/models/ListCrossProjectDeploymentCandidatesRequest.d.ts +3 -3
- package/dist/models/ListCrossProjectDeploymentCandidatesResponseBody.d.ts +8 -8
- package/dist/models/ListCrossProjectPipelineRunItemsRequest.d.ts +2 -2
- package/dist/models/ListCrossProjectPipelineRunItemsResponseBody.d.ts +10 -10
- package/dist/models/ListCustomAgentsRequest.d.ts +2 -2
- package/dist/models/ListCustomAgentsResponseBody.d.ts +10 -14
- package/dist/models/ListCustomAgentsResponseBody.js +2 -2
- package/dist/models/ListCustomAgentsResponseBody.js.map +1 -1
- package/dist/models/ListCustomAgentsShrinkRequest.d.ts +2 -2
- package/dist/models/ListDataAssetTagsRequest.d.ts +1 -1
- package/dist/models/ListDataAssetTagsResponseBody.d.ts +5 -5
- package/dist/models/ListDataQualityEvaluationTasksRequest.d.ts +3 -3
- package/dist/models/ListDataQualityEvaluationTasksResponseBody.d.ts +26 -21
- package/dist/models/ListDataQualityEvaluationTasksResponseBody.js.map +1 -1
- package/dist/models/ListDataQualityResultsRequest.d.ts +4 -4
- package/dist/models/ListDataQualityResultsResponseBody.d.ts +81 -81
- package/dist/models/ListDownstreamTasksRequest.d.ts +1 -1
- package/dist/models/ListDownstreamTasksResponseBody.d.ts +51 -51
- package/dist/models/ListKnowledgeBasesRequest.d.ts +29 -0
- package/dist/models/ListKnowledgeBasesRequest.js +60 -0
- package/dist/models/ListKnowledgeBasesRequest.js.map +1 -0
- package/dist/models/ListKnowledgeBasesResponse.d.ts +19 -0
- package/dist/models/ListKnowledgeBasesResponse.js +69 -0
- package/dist/models/ListKnowledgeBasesResponse.js.map +1 -0
- package/dist/models/ListKnowledgeBasesResponseBody.d.ts +169 -0
- package/dist/models/ListKnowledgeBasesResponseBody.js +130 -0
- package/dist/models/ListKnowledgeBasesResponseBody.js.map +1 -0
- package/dist/models/ListKnowledgePointsRequest.d.ts +51 -0
- package/dist/models/ListKnowledgePointsRequest.js +64 -0
- package/dist/models/ListKnowledgePointsRequest.js.map +1 -0
- package/dist/models/ListKnowledgePointsResponse.d.ts +19 -0
- package/dist/models/ListKnowledgePointsResponse.js +69 -0
- package/dist/models/ListKnowledgePointsResponse.js.map +1 -0
- package/dist/models/ListKnowledgePointsResponseBody.d.ts +135 -0
- package/dist/models/ListKnowledgePointsResponseBody.js +122 -0
- package/dist/models/ListKnowledgePointsResponseBody.js.map +1 -0
- package/dist/models/ListMyApplicationsRequest.d.ts +26 -26
- package/dist/models/ListMyApplicationsRequest.js.map +1 -1
- package/dist/models/ListMyApplicationsResponseBody.d.ts +46 -43
- package/dist/models/ListMyApplicationsResponseBody.js.map +1 -1
- package/dist/models/ListMyApplicationsShrinkRequest.d.ts +17 -20
- package/dist/models/ListMyApplicationsShrinkRequest.js.map +1 -1
- package/dist/models/ListMyRelatedApprovalsRequest.d.ts +47 -44
- package/dist/models/ListMyRelatedApprovalsRequest.js.map +1 -1
- package/dist/models/ListMyRelatedApprovalsResponseBody.d.ts +56 -53
- package/dist/models/ListMyRelatedApprovalsResponseBody.js.map +1 -1
- package/dist/models/ListMyRelatedApprovalsShrinkRequest.d.ts +27 -27
- package/dist/models/ListParameterVersionsResponseBody.d.ts +1 -1
- package/dist/models/ListPartitionsRequest.d.ts +5 -5
- package/dist/models/ListPartitionsResponseBody.d.ts +2 -2
- package/dist/models/ListPendingApprovalsRequest.d.ts +28 -28
- package/dist/models/ListPendingApprovalsRequest.js.map +1 -1
- package/dist/models/ListPendingApprovalsResponseBody.d.ts +58 -51
- package/dist/models/ListPendingApprovalsResponseBody.js.map +1 -1
- package/dist/models/ListPendingApprovalsShrinkRequest.d.ts +15 -18
- package/dist/models/ListPendingApprovalsShrinkRequest.js.map +1 -1
- package/dist/models/ListPipelineRunsRequest.d.ts +12 -17
- package/dist/models/ListPipelineRunsRequest.js.map +1 -1
- package/dist/models/ListPipelineRunsResponseBody.d.ts +41 -50
- package/dist/models/ListPipelineRunsResponseBody.js.map +1 -1
- package/dist/models/ListResourcesRequest.d.ts +5 -5
- package/dist/models/ListResourcesResponseBody.d.ts +16 -17
- package/dist/models/ListResourcesResponseBody.js.map +1 -1
- package/dist/models/ListSemanticJobsRequest.d.ts +2 -2
- package/dist/models/ListSemanticJobsResponseBody.d.ts +20 -17
- package/dist/models/ListSemanticJobsResponseBody.js.map +1 -1
- package/dist/models/ListServerIdeInstancesRequest.d.ts +4 -4
- package/dist/models/ListServerIdeInstancesResponseBody.d.ts +19 -19
- package/dist/models/ListSkillsRequest.d.ts +4 -4
- package/dist/models/ListSkillsResponseBody.d.ts +4 -4
- package/dist/models/ListSkillsShrinkRequest.d.ts +4 -4
- package/dist/models/ListTaskInstanceOperationLogsRequest.d.ts +1 -1
- package/dist/models/ListTaskInstanceOperationLogsResponseBody.d.ts +3 -3
- package/dist/models/ListTaskInstancesRequest.d.ts +36 -36
- package/dist/models/ListTaskInstancesResponseBody.d.ts +53 -37
- package/dist/models/ListTaskInstancesResponseBody.js.map +1 -1
- package/dist/models/ListTaskInstancesShrinkRequest.d.ts +36 -36
- package/dist/models/ListTasksRequest.d.ts +11 -52
- package/dist/models/ListTasksRequest.js.map +1 -1
- package/dist/models/ListTasksResponseBody.d.ts +36 -58
- package/dist/models/ListTasksResponseBody.js.map +1 -1
- package/dist/models/ListTasksShrinkRequest.d.ts +11 -52
- package/dist/models/ListTasksShrinkRequest.js.map +1 -1
- package/dist/models/ListWorkflowsRequest.d.ts +6 -4
- package/dist/models/ListWorkflowsRequest.js.map +1 -1
- package/dist/models/ListWorkflowsResponseBody.d.ts +8 -6
- package/dist/models/ListWorkflowsResponseBody.js.map +1 -1
- package/dist/models/ListWorkflowsShrinkRequest.d.ts +6 -4
- package/dist/models/ListWorkflowsShrinkRequest.js.map +1 -1
- package/dist/models/LoadAgentSessionRequest.d.ts +5 -5
- package/dist/models/LoadAgentSessionResponseBody.d.ts +6 -6
- package/dist/models/LoadAgentSessionShrinkRequest.d.ts +2 -2
- package/dist/models/MetaEntity.d.ts +16 -11
- package/dist/models/MetaEntity.js.map +1 -1
- package/dist/models/PreviewTaskParametersRequest.d.ts +80 -0
- package/dist/models/PreviewTaskParametersRequest.js +70 -0
- package/dist/models/PreviewTaskParametersRequest.js.map +1 -0
- package/dist/models/PreviewTaskParametersResponse.d.ts +19 -0
- package/dist/models/PreviewTaskParametersResponse.js +69 -0
- package/dist/models/PreviewTaskParametersResponse.js.map +1 -0
- package/dist/models/PreviewTaskParametersResponseBody.d.ts +80 -0
- package/dist/models/PreviewTaskParametersResponseBody.js +90 -0
- package/dist/models/PreviewTaskParametersResponseBody.js.map +1 -0
- package/dist/models/PromptAgentSessionRequest.d.ts +8 -8
- package/dist/models/PromptAgentSessionResponseBody.d.ts +12 -12
- package/dist/models/PromptAgentSessionShrinkRequest.d.ts +2 -2
- package/dist/models/PublishImageRequest.d.ts +1 -1
- package/dist/models/PublishImageResponseBody.d.ts +6 -6
- package/dist/models/RemoveTaskInstanceDependenciesRequest.d.ts +3 -3
- package/dist/models/RemoveTaskInstanceDependenciesResponseBody.d.ts +2 -2
- package/dist/models/RemoveTaskInstanceDependenciesShrinkRequest.d.ts +3 -3
- package/dist/models/RerunTaskInstancesRequest.d.ts +3 -3
- package/dist/models/RerunTaskInstancesResponseBody.d.ts +4 -1
- package/dist/models/RerunTaskInstancesResponseBody.js.map +1 -1
- package/dist/models/RerunTaskInstancesShrinkRequest.d.ts +3 -3
- package/dist/models/ResumeTaskInstancesRequest.d.ts +2 -2
- package/dist/models/ResumeTaskInstancesResponseBody.d.ts +6 -3
- package/dist/models/ResumeTaskInstancesResponseBody.js.map +1 -1
- package/dist/models/ResumeTaskInstancesShrinkRequest.d.ts +2 -2
- package/dist/models/RetrieveKnowledgePointsRequest.d.ts +83 -0
- package/dist/models/RetrieveKnowledgePointsRequest.js +93 -0
- package/dist/models/RetrieveKnowledgePointsRequest.js.map +1 -0
- package/dist/models/RetrieveKnowledgePointsResponse.d.ts +19 -0
- package/dist/models/RetrieveKnowledgePointsResponse.js +69 -0
- package/dist/models/RetrieveKnowledgePointsResponse.js.map +1 -0
- package/dist/models/RetrieveKnowledgePointsResponseBody.d.ts +371 -0
- package/dist/models/RetrieveKnowledgePointsResponseBody.js +306 -0
- package/dist/models/RetrieveKnowledgePointsResponseBody.js.map +1 -0
- package/dist/models/RetrieveKnowledgePointsShrinkRequest.d.ts +41 -0
- package/dist/models/RetrieveKnowledgePointsShrinkRequest.js +64 -0
- package/dist/models/RetrieveKnowledgePointsShrinkRequest.js.map +1 -0
- package/dist/models/SetSuccessTaskInstancesRequest.d.ts +2 -2
- package/dist/models/SetSuccessTaskInstancesResponseBody.d.ts +6 -3
- package/dist/models/SetSuccessTaskInstancesResponseBody.js.map +1 -1
- package/dist/models/SetSuccessTaskInstancesShrinkRequest.d.ts +2 -2
- package/dist/models/StartWorkflowInstancesRequest.d.ts +1 -1
- package/dist/models/StartWorkflowInstancesResponseBody.d.ts +5 -2
- package/dist/models/StartWorkflowInstancesResponseBody.js.map +1 -1
- package/dist/models/StartWorkflowInstancesShrinkRequest.d.ts +1 -1
- package/dist/models/StopTaskInstancesResponseBody.d.ts +5 -2
- package/dist/models/StopTaskInstancesResponseBody.js.map +1 -1
- package/dist/models/StopWorkflowInstancesRequest.d.ts +1 -1
- package/dist/models/StopWorkflowInstancesResponseBody.d.ts +5 -2
- package/dist/models/StopWorkflowInstancesResponseBody.js.map +1 -1
- package/dist/models/StopWorkflowInstancesShrinkRequest.d.ts +1 -1
- package/dist/models/SuspendTaskInstancesResponseBody.d.ts +4 -1
- package/dist/models/SuspendTaskInstancesResponseBody.js.map +1 -1
- package/dist/models/Table.d.ts +45 -36
- package/dist/models/Table.js.map +1 -1
- package/dist/models/TagDataAssetsRequest.d.ts +5 -5
- package/dist/models/TagDataAssetsShrinkRequest.d.ts +5 -5
- package/dist/models/UpdateAgentRequest.d.ts +320 -0
- package/dist/models/UpdateAgentRequest.js +233 -0
- package/dist/models/UpdateAgentRequest.js.map +1 -0
- package/dist/models/UpdateAgentResponse.d.ts +19 -0
- package/dist/models/UpdateAgentResponse.js +69 -0
- package/dist/models/UpdateAgentResponse.js.map +1 -0
- package/dist/models/UpdateAgentResponseBody.d.ts +208 -0
- package/dist/models/UpdateAgentResponseBody.js +158 -0
- package/dist/models/UpdateAgentResponseBody.js.map +1 -0
- package/dist/models/UpdateAgentShrinkRequest.d.ts +126 -0
- package/dist/models/UpdateAgentShrinkRequest.js +84 -0
- package/dist/models/UpdateAgentShrinkRequest.js.map +1 -0
- package/dist/models/UpdateCodeReviewRequest.d.ts +43 -0
- package/dist/models/UpdateCodeReviewRequest.js +62 -0
- package/dist/models/UpdateCodeReviewRequest.js.map +1 -0
- package/dist/models/UpdateCodeReviewResponse.d.ts +19 -0
- package/dist/models/UpdateCodeReviewResponse.js +69 -0
- package/dist/models/UpdateCodeReviewResponse.js.map +1 -0
- package/dist/models/UpdateCodeReviewResponseBody.d.ts +26 -0
- package/dist/models/UpdateCodeReviewResponseBody.js +60 -0
- package/dist/models/UpdateCodeReviewResponseBody.js.map +1 -0
- package/dist/models/UpdateCrawlerRequest.d.ts +3 -0
- package/dist/models/UpdateCrawlerRequest.js.map +1 -1
- package/dist/models/UpdateCrawlerShrinkRequest.d.ts +3 -0
- package/dist/models/UpdateCrawlerShrinkRequest.js.map +1 -1
- package/dist/models/UpdateDataAssetTagRequest.d.ts +4 -4
- package/dist/models/UpdateDataAssetTagResponseBody.d.ts +1 -1
- package/dist/models/UpdateDataAssetTagShrinkRequest.d.ts +4 -4
- package/dist/models/UpdateParameterRequest.d.ts +1 -1
- package/dist/models/UpdateParameterShrinkRequest.d.ts +1 -1
- package/dist/models/UpdateProcessDefinitionRequest.d.ts +39 -55
- package/dist/models/UpdateProcessDefinitionRequest.js.map +1 -1
- package/dist/models/UpdateProcessDefinitionResponseBody.d.ts +1 -1
- package/dist/models/UpdateProcessDefinitionShrinkRequest.d.ts +8 -8
- package/dist/models/UpdateTaskInstancesRequest.d.ts +4 -4
- package/dist/models/UpdateTaskInstancesResponseBody.d.ts +5 -2
- package/dist/models/UpdateTaskInstancesResponseBody.js.map +1 -1
- package/dist/models/UpdateTaskInstancesShrinkRequest.d.ts +1 -1
- package/dist/models/UpdateWorkflowRequest.d.ts +75 -79
- package/dist/models/UpdateWorkflowRequest.js.map +1 -1
- package/dist/models/UpdateWorkflowResponseBody.d.ts +2 -2
- package/dist/models/UpdateWorkflowShrinkRequest.d.ts +8 -12
- package/dist/models/UpdateWorkflowShrinkRequest.js.map +1 -1
- package/dist/models/UploadAgentSessionFileRequest.d.ts +85 -0
- package/dist/models/UploadAgentSessionFileRequest.js +94 -0
- package/dist/models/UploadAgentSessionFileRequest.js.map +1 -0
- package/dist/models/UploadAgentSessionFileResponse.d.ts +19 -0
- package/dist/models/UploadAgentSessionFileResponse.js +69 -0
- package/dist/models/UploadAgentSessionFileResponse.js.map +1 -0
- package/dist/models/UploadAgentSessionFileResponseBody.d.ts +147 -0
- package/dist/models/UploadAgentSessionFileResponseBody.js +179 -0
- package/dist/models/UploadAgentSessionFileResponseBody.js.map +1 -0
- package/dist/models/UploadAgentSessionFileShrinkRequest.d.ts +28 -0
- package/dist/models/UploadAgentSessionFileShrinkRequest.js +62 -0
- package/dist/models/UploadAgentSessionFileShrinkRequest.js.map +1 -0
- package/dist/models/model.d.ts +100 -0
- package/dist/models/model.js +250 -48
- package/dist/models/model.js.map +1 -1
- package/package.json +2 -1
- package/src/client.ts +1550 -504
- package/src/models/ApplyResourceAccessPermissionRequest.ts +26 -24
- package/src/models/ApplyResourceAccessPermissionResponseBody.ts +2 -2
- package/src/models/ApplyResourceAccessPermissionShrinkRequest.ts +4 -4
- package/src/models/ArchiveAgentSessionRequest.ts +98 -0
- package/src/models/ArchiveAgentSessionResponse.ts +40 -0
- package/src/models/ArchiveAgentSessionResponseBody.ts +211 -0
- package/src/models/ArchiveAgentSessionShrinkRequest.ts +53 -0
- package/src/models/BatchUpdateTasksRequest.ts +29 -29
- package/src/models/BatchUpdateTasksResponseBody.ts +5 -2
- package/src/models/BatchUpdateTasksShrinkRequest.ts +1 -1
- package/src/models/BuildImageRequest.ts +3 -3
- package/src/models/BuildImageResponseBody.ts +3 -3
- package/src/models/CancelImageTestRequest.ts +1 -1
- package/src/models/CancelImageTestResponseBody.ts +4 -4
- package/src/models/Column.ts +22 -13
- package/src/models/CreateAgentRequest.ts +56 -16
- package/src/models/CreateAgentResponseBody.ts +11 -15
- package/src/models/CreateAgentSessionRequest.ts +23 -13
- package/src/models/CreateAgentSessionResponseBody.ts +6 -6
- package/src/models/CreateAgentSessionShrinkRequest.ts +1 -1
- package/src/models/CreateAgentShrinkRequest.ts +5 -8
- package/src/models/CreateCodeReviewRequest.ts +70 -0
- package/src/models/CreateCodeReviewResponse.ts +40 -0
- package/src/models/CreateCodeReviewResponseBody.ts +44 -0
- package/src/models/CreateCrawlerRequest.ts +10 -7
- package/src/models/CreateCrawlerResponseBody.ts +2 -2
- package/src/models/CreateCrawlerShrinkRequest.ts +6 -3
- package/src/models/CreateCrossProjectPipelineRunRequest.ts +4 -10
- package/src/models/CreateCrossProjectPipelineRunResponseBody.ts +3 -3
- package/src/models/CreateCrossProjectPipelineRunShrinkRequest.ts +4 -10
- package/src/models/CreateDataQualityScanRequest.ts +32 -48
- package/src/models/CreateDataQualityScanResponseBody.ts +2 -2
- package/src/models/CreateDataQualityScanShrinkRequest.ts +9 -9
- package/src/models/CreateDatasetRequest.ts +23 -20
- package/src/models/CreateDatasetShrinkRequest.ts +13 -13
- package/src/models/CreateDatasetVersionRequest.ts +9 -6
- package/src/models/CreateDatasetVersionResponseBody.ts +1 -1
- package/src/models/CreateDatasetVersionShrinkRequest.ts +9 -6
- package/src/models/CreateMcpServerRequest.ts +5 -5
- package/src/models/CreateMcpServerResponseBody.ts +4 -2
- package/src/models/CreateMcpServerShrinkRequest.ts +3 -3
- package/src/models/CreateProcessDefinitionRequest.ts +41 -38
- package/src/models/CreateProcessDefinitionResponseBody.ts +2 -2
- package/src/models/CreateProcessDefinitionShrinkRequest.ts +6 -6
- package/src/models/CreateResourceGroupRequest.ts +8 -8
- package/src/models/CreateResourceGroupResponseBody.ts +2 -2
- package/src/models/CreateResourceGroupShrinkRequest.ts +8 -8
- package/src/models/CreateSemanticJobRequest.ts +6 -6
- package/src/models/CreateSemanticJobResponseBody.ts +18 -15
- package/src/models/CreateSemanticJobShrinkRequest.ts +6 -6
- package/src/models/CreateSkillRequest.ts +16 -9
- package/src/models/CreateSkillResponseBody.ts +13 -6
- package/src/models/CreateSkillShrinkRequest.ts +14 -7
- package/src/models/CreateWorkflowInstancesRequest.ts +43 -40
- package/src/models/CreateWorkflowInstancesShrinkRequest.ts +11 -11
- package/src/models/DataQualityEvaluationTask.ts +38 -40
- package/src/models/DataQualityEvaluationTaskInstance.ts +43 -45
- package/src/models/DatasetVersion.ts +15 -16
- package/src/models/DeleteAgentSessionRequest.ts +88 -0
- package/src/models/DeleteAgentSessionResponse.ts +40 -0
- package/src/models/DeleteAgentSessionResponseBody.ts +174 -0
- package/src/models/DeleteAgentSessionShrinkRequest.ts +53 -0
- package/src/models/DeleteTaskRequest.ts +1 -1
- package/src/models/DeleteTaskResponseBody.ts +1 -1
- package/src/models/GetAgentRequest.ts +2 -2
- package/src/models/GetAgentResponseBody.ts +26 -30
- package/src/models/GetAgentSessionEventsRequest.ts +46 -0
- package/src/models/GetAgentSessionEventsResponse.ts +46 -0
- package/src/models/GetAgentSessionEventsResponseBody.ts +64 -0
- package/src/models/GetApplicationContentsRequest.ts +1 -1
- package/src/models/GetApplicationContentsResponseBody.ts +50 -50
- package/src/models/GetCodeReviewRequest.ts +48 -0
- package/src/models/GetCodeReviewResponse.ts +40 -0
- package/src/models/GetCodeReviewResponseBody.ts +214 -0
- package/src/models/GetCrawlerRequest.ts +1 -1
- package/src/models/GetCrawlerResponseBody.ts +38 -19
- package/src/models/GetDataQualityScanRunRequest.ts +1 -1
- package/src/models/GetDataQualityScanRunResponseBody.ts +56 -68
- package/src/models/GetImageTestResultRequest.ts +1 -1
- package/src/models/GetImageTestResultResponseBody.ts +6 -6
- package/src/models/GetKnowledgeBaseRequest.ts +36 -0
- package/src/models/GetKnowledgeBaseResponse.ts +40 -0
- package/src/models/GetKnowledgeBaseResponseBody.ts +181 -0
- package/src/models/GetKnowledgePointRequest.ts +80 -0
- package/src/models/GetKnowledgePointResponse.ts +40 -0
- package/src/models/GetKnowledgePointResponseBody.ts +751 -0
- package/src/models/GetPipelineRunResponseBody.ts +3 -0
- package/src/models/GetProcessDefinitionRequest.ts +1 -1
- package/src/models/GetProcessDefinitionResponseBody.ts +57 -97
- package/src/models/GetProcessInstanceResponseBody.ts +6 -6
- package/src/models/GetWorkflowInstanceResponseBody.ts +2 -2
- package/src/models/GetWorkflowRequest.ts +3 -1
- package/src/models/GetWorkflowResponseBody.ts +51 -47
- package/src/models/IdentifyCredential.ts +15 -23
- package/src/models/LineageTask.ts +4 -1
- package/src/models/ListAgentSessionsRequest.ts +8 -10
- package/src/models/ListAgentSessionsResponseBody.ts +8 -8
- package/src/models/ListAgentSessionsShrinkRequest.ts +2 -2
- package/src/models/ListCodeReviewsRequest.ts +86 -0
- package/src/models/ListCodeReviewsResponse.ts +40 -0
- package/src/models/ListCodeReviewsResponseBody.ts +274 -0
- package/src/models/ListCrossProjectDeploymentCandidatesRequest.ts +3 -3
- package/src/models/ListCrossProjectDeploymentCandidatesResponseBody.ts +8 -8
- package/src/models/ListCrossProjectPipelineRunItemsRequest.ts +2 -2
- package/src/models/ListCrossProjectPipelineRunItemsResponseBody.ts +10 -10
- package/src/models/ListCustomAgentsRequest.ts +2 -2
- package/src/models/ListCustomAgentsResponseBody.ts +12 -16
- package/src/models/ListCustomAgentsShrinkRequest.ts +2 -2
- package/src/models/ListDataAssetTagsRequest.ts +1 -1
- package/src/models/ListDataAssetTagsResponseBody.ts +5 -5
- package/src/models/ListDataQualityEvaluationTasksRequest.ts +3 -3
- package/src/models/ListDataQualityEvaluationTasksResponseBody.ts +26 -21
- package/src/models/ListDataQualityResultsRequest.ts +4 -4
- package/src/models/ListDataQualityResultsResponseBody.ts +81 -81
- package/src/models/ListDownstreamTasksRequest.ts +1 -1
- package/src/models/ListDownstreamTasksResponseBody.ts +51 -51
- package/src/models/ListKnowledgeBasesRequest.ts +44 -0
- package/src/models/ListKnowledgeBasesResponse.ts +40 -0
- package/src/models/ListKnowledgeBasesResponseBody.ts +236 -0
- package/src/models/ListKnowledgePointsRequest.ts +70 -0
- package/src/models/ListKnowledgePointsResponse.ts +40 -0
- package/src/models/ListKnowledgePointsResponseBody.ts +194 -0
- package/src/models/ListMyApplicationsRequest.ts +26 -26
- package/src/models/ListMyApplicationsResponseBody.ts +46 -43
- package/src/models/ListMyApplicationsShrinkRequest.ts +17 -20
- package/src/models/ListMyRelatedApprovalsRequest.ts +46 -43
- package/src/models/ListMyRelatedApprovalsResponseBody.ts +56 -53
- package/src/models/ListMyRelatedApprovalsShrinkRequest.ts +27 -27
- package/src/models/ListParameterVersionsResponseBody.ts +1 -1
- package/src/models/ListPartitionsRequest.ts +5 -5
- package/src/models/ListPartitionsResponseBody.ts +2 -2
- package/src/models/ListPendingApprovalsRequest.ts +29 -29
- package/src/models/ListPendingApprovalsResponseBody.ts +58 -51
- package/src/models/ListPendingApprovalsShrinkRequest.ts +16 -19
- package/src/models/ListPipelineRunsRequest.ts +12 -17
- package/src/models/ListPipelineRunsResponseBody.ts +41 -50
- package/src/models/ListResourcesRequest.ts +5 -5
- package/src/models/ListResourcesResponseBody.ts +16 -17
- package/src/models/ListSemanticJobsRequest.ts +2 -2
- package/src/models/ListSemanticJobsResponseBody.ts +20 -17
- package/src/models/ListServerIdeInstancesRequest.ts +4 -4
- package/src/models/ListServerIdeInstancesResponseBody.ts +19 -19
- package/src/models/ListSkillsRequest.ts +4 -4
- package/src/models/ListSkillsResponseBody.ts +4 -4
- package/src/models/ListSkillsShrinkRequest.ts +4 -4
- package/src/models/ListTaskInstanceOperationLogsRequest.ts +1 -1
- package/src/models/ListTaskInstanceOperationLogsResponseBody.ts +3 -3
- package/src/models/ListTaskInstancesRequest.ts +36 -36
- package/src/models/ListTaskInstancesResponseBody.ts +53 -37
- package/src/models/ListTaskInstancesShrinkRequest.ts +36 -36
- package/src/models/ListTasksRequest.ts +11 -52
- package/src/models/ListTasksResponseBody.ts +36 -58
- package/src/models/ListTasksShrinkRequest.ts +11 -52
- package/src/models/ListWorkflowsRequest.ts +6 -4
- package/src/models/ListWorkflowsResponseBody.ts +8 -6
- package/src/models/ListWorkflowsShrinkRequest.ts +6 -4
- package/src/models/LoadAgentSessionRequest.ts +5 -5
- package/src/models/LoadAgentSessionResponseBody.ts +6 -6
- package/src/models/LoadAgentSessionShrinkRequest.ts +2 -2
- package/src/models/MetaEntity.ts +16 -11
- package/src/models/PreviewTaskParametersRequest.ts +105 -0
- package/src/models/PreviewTaskParametersResponse.ts +40 -0
- package/src/models/PreviewTaskParametersResponseBody.ts +116 -0
- package/src/models/PromptAgentSessionRequest.ts +8 -8
- package/src/models/PromptAgentSessionResponseBody.ts +12 -12
- package/src/models/PromptAgentSessionShrinkRequest.ts +2 -2
- package/src/models/PublishImageRequest.ts +1 -1
- package/src/models/PublishImageResponseBody.ts +6 -6
- package/src/models/RemoveTaskInstanceDependenciesRequest.ts +3 -3
- package/src/models/RemoveTaskInstanceDependenciesResponseBody.ts +2 -2
- package/src/models/RemoveTaskInstanceDependenciesShrinkRequest.ts +3 -3
- package/src/models/RerunTaskInstancesRequest.ts +3 -3
- package/src/models/RerunTaskInstancesResponseBody.ts +4 -1
- package/src/models/RerunTaskInstancesShrinkRequest.ts +3 -3
- package/src/models/ResumeTaskInstancesRequest.ts +2 -2
- package/src/models/ResumeTaskInstancesResponseBody.ts +6 -3
- package/src/models/ResumeTaskInstancesShrinkRequest.ts +2 -2
- package/src/models/RetrieveKnowledgePointsRequest.ts +122 -0
- package/src/models/RetrieveKnowledgePointsResponse.ts +40 -0
- package/src/models/RetrieveKnowledgePointsResponseBody.ts +551 -0
- package/src/models/RetrieveKnowledgePointsShrinkRequest.ts +60 -0
- package/src/models/SetSuccessTaskInstancesRequest.ts +2 -2
- package/src/models/SetSuccessTaskInstancesResponseBody.ts +6 -3
- package/src/models/SetSuccessTaskInstancesShrinkRequest.ts +2 -2
- package/src/models/StartWorkflowInstancesRequest.ts +1 -1
- package/src/models/StartWorkflowInstancesResponseBody.ts +5 -2
- package/src/models/StartWorkflowInstancesShrinkRequest.ts +1 -1
- package/src/models/StopTaskInstancesResponseBody.ts +5 -2
- package/src/models/StopWorkflowInstancesRequest.ts +1 -1
- package/src/models/StopWorkflowInstancesResponseBody.ts +5 -2
- package/src/models/StopWorkflowInstancesShrinkRequest.ts +1 -1
- package/src/models/SuspendTaskInstancesResponseBody.ts +4 -1
- package/src/models/Table.ts +45 -36
- package/src/models/TagDataAssetsRequest.ts +5 -5
- package/src/models/TagDataAssetsShrinkRequest.ts +5 -5
- package/src/models/UpdateAgentRequest.ts +459 -0
- package/src/models/UpdateAgentResponse.ts +40 -0
- package/src/models/UpdateAgentResponseBody.ts +294 -0
- package/src/models/UpdateAgentShrinkRequest.ts +165 -0
- package/src/models/UpdateCodeReviewRequest.ts +60 -0
- package/src/models/UpdateCodeReviewResponse.ts +40 -0
- package/src/models/UpdateCodeReviewResponseBody.ts +41 -0
- package/src/models/UpdateCrawlerRequest.ts +3 -0
- package/src/models/UpdateCrawlerShrinkRequest.ts +3 -0
- package/src/models/UpdateDataAssetTagRequest.ts +4 -4
- package/src/models/UpdateDataAssetTagResponseBody.ts +1 -1
- package/src/models/UpdateDataAssetTagShrinkRequest.ts +4 -4
- package/src/models/UpdateParameterRequest.ts +1 -1
- package/src/models/UpdateParameterShrinkRequest.ts +1 -1
- package/src/models/UpdateProcessDefinitionRequest.ts +42 -58
- package/src/models/UpdateProcessDefinitionResponseBody.ts +1 -1
- package/src/models/UpdateProcessDefinitionShrinkRequest.ts +8 -8
- package/src/models/UpdateTaskInstancesRequest.ts +4 -4
- package/src/models/UpdateTaskInstancesResponseBody.ts +5 -2
- package/src/models/UpdateTaskInstancesShrinkRequest.ts +1 -1
- package/src/models/UpdateWorkflowRequest.ts +75 -79
- package/src/models/UpdateWorkflowResponseBody.ts +2 -2
- package/src/models/UpdateWorkflowShrinkRequest.ts +8 -12
- package/src/models/UploadAgentSessionFileRequest.ts +125 -0
- package/src/models/UploadAgentSessionFileResponse.ts +40 -0
- package/src/models/UploadAgentSessionFileResponseBody.ts +243 -0
- package/src/models/UploadAgentSessionFileShrinkRequest.ts +45 -0
- package/src/models/model.ts +100 -0
package/dist/client.d.ts
CHANGED
|
@@ -71,19 +71,19 @@ export default class Client extends OpenApi {
|
|
|
71
71
|
*/
|
|
72
72
|
addEntityIntoMetaCollection(request: $_model.AddEntityIntoMetaCollectionRequest): Promise<$_model.AddEntityIntoMetaCollectionResponse>;
|
|
73
73
|
/**
|
|
74
|
-
*
|
|
74
|
+
* Submits an application for access permissions to specific resources.
|
|
75
75
|
*
|
|
76
76
|
* @remarks
|
|
77
|
-
* ##
|
|
78
|
-
* - **Reason**: The reason for the
|
|
79
|
-
* - **ApplyContents**:
|
|
80
|
-
* - **Resource**: The resource description. You must specify the ResourceSchema.name and version on which
|
|
77
|
+
* ## Request description
|
|
78
|
+
* - **Reason**: The reason for the application. This parameter is required.
|
|
79
|
+
* - **ApplyContents**: The list of resource permission applications. Each item includes the resource description (Resource), grantee description (Grantee), access types (AccessTypes), and expiration time (ExpirationTime). The maximum number of items per request is 400.
|
|
80
|
+
* - **Resource**: The resource description. You must specify the ResourceSchema.name and version on which resource parsing depends, as well as the resource metadata (MetaData).
|
|
81
81
|
* - **Grantee**: The grantee description. You must specify the principal type (PrincipalType) and principal ID (PrincipalId).
|
|
82
|
-
* - **AccessTypes**: The list of
|
|
83
|
-
* - **ExpirationTime**: The
|
|
84
|
-
* - **AuthMethod**:
|
|
82
|
+
* - **AccessTypes**: The list of permission types. Multiple permission combinations are supported.
|
|
83
|
+
* - **ExpirationTime**: The expiration time of the permissions, provided as a millisecond timestamp.
|
|
84
|
+
* - **AuthMethod**: The authorization method. This parameter is optional. By default, the built-in default authorization method is used.
|
|
85
85
|
* - **ClientToken**: The client token used to prevent duplicate requests. This parameter is optional.
|
|
86
|
-
* Make sure that all required fields are correctly
|
|
86
|
+
* Make sure that all required fields are correctly filled in and meet the corresponding constraints. For example, the DefVersion and MetaData in Resource must match the selected DefSchema.
|
|
87
87
|
*
|
|
88
88
|
* @param tmpReq - ApplyResourceAccessPermissionRequest
|
|
89
89
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -91,19 +91,19 @@ export default class Client extends OpenApi {
|
|
|
91
91
|
*/
|
|
92
92
|
applyResourceAccessPermissionWithOptions(tmpReq: $_model.ApplyResourceAccessPermissionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ApplyResourceAccessPermissionResponse>;
|
|
93
93
|
/**
|
|
94
|
-
*
|
|
94
|
+
* Submits an application for access permissions to specific resources.
|
|
95
95
|
*
|
|
96
96
|
* @remarks
|
|
97
|
-
* ##
|
|
98
|
-
* - **Reason**: The reason for the
|
|
99
|
-
* - **ApplyContents**:
|
|
100
|
-
* - **Resource**: The resource description. You must specify the ResourceSchema.name and version on which
|
|
97
|
+
* ## Request description
|
|
98
|
+
* - **Reason**: The reason for the application. This parameter is required.
|
|
99
|
+
* - **ApplyContents**: The list of resource permission applications. Each item includes the resource description (Resource), grantee description (Grantee), access types (AccessTypes), and expiration time (ExpirationTime). The maximum number of items per request is 400.
|
|
100
|
+
* - **Resource**: The resource description. You must specify the ResourceSchema.name and version on which resource parsing depends, as well as the resource metadata (MetaData).
|
|
101
101
|
* - **Grantee**: The grantee description. You must specify the principal type (PrincipalType) and principal ID (PrincipalId).
|
|
102
|
-
* - **AccessTypes**: The list of
|
|
103
|
-
* - **ExpirationTime**: The
|
|
104
|
-
* - **AuthMethod**:
|
|
102
|
+
* - **AccessTypes**: The list of permission types. Multiple permission combinations are supported.
|
|
103
|
+
* - **ExpirationTime**: The expiration time of the permissions, provided as a millisecond timestamp.
|
|
104
|
+
* - **AuthMethod**: The authorization method. This parameter is optional. By default, the built-in default authorization method is used.
|
|
105
105
|
* - **ClientToken**: The client token used to prevent duplicate requests. This parameter is optional.
|
|
106
|
-
* Make sure that all required fields are correctly
|
|
106
|
+
* Make sure that all required fields are correctly filled in and meet the corresponding constraints. For example, the DefVersion and MetaData in Resource must match the selected DefSchema.
|
|
107
107
|
*
|
|
108
108
|
* @param request - ApplyResourceAccessPermissionRequest
|
|
109
109
|
* @returns ApplyResourceAccessPermissionResponse
|
|
@@ -136,6 +136,31 @@ export default class Client extends OpenApi {
|
|
|
136
136
|
* @returns ApproveProcessInstanceResponse
|
|
137
137
|
*/
|
|
138
138
|
approveProcessInstance(request: $_model.ApproveProcessInstanceRequest): Promise<$_model.ApproveProcessInstanceResponse>;
|
|
139
|
+
/**
|
|
140
|
+
* Sets the archive status of a specified agent session to archived or unarchived. This API operation is available only when the canary release feature is enabled. Before calling this operation, ensure that the canary release feature is enabled for the current account and the destination region.
|
|
141
|
+
*
|
|
142
|
+
* @remarks
|
|
143
|
+
* This API operation is available only when the canary release feature is enabled. Before calling this operation, ensure that the canary release feature is enabled for the current account and the destination region.
|
|
144
|
+
* Archiving only modifies the archive flag of the session and does not stop or delete the session. If Archived is set to true, the session is archived. If Archived is set to false, the session is unarchived. If this parameter is omitted, the default value true is used. You can use the Archived parameter of ListAgentSessions to query archived and unarchived sessions separately.
|
|
145
|
+
* The caller must have access permissions on the current session and the corresponding OpenAPI action permissions. An HTTP 200 status code does not indicate that the business operation is successful. You must check JsonRpcResponse.Error. The successful result is located in JsonRpcResponse.Result.
|
|
146
|
+
*
|
|
147
|
+
* @param tmpReq - ArchiveAgentSessionRequest
|
|
148
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
149
|
+
* @returns ArchiveAgentSessionResponse
|
|
150
|
+
*/
|
|
151
|
+
archiveAgentSessionWithOptions(tmpReq: $_model.ArchiveAgentSessionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ArchiveAgentSessionResponse>;
|
|
152
|
+
/**
|
|
153
|
+
* Sets the archive status of a specified agent session to archived or unarchived. This API operation is available only when the canary release feature is enabled. Before calling this operation, ensure that the canary release feature is enabled for the current account and the destination region.
|
|
154
|
+
*
|
|
155
|
+
* @remarks
|
|
156
|
+
* This API operation is available only when the canary release feature is enabled. Before calling this operation, ensure that the canary release feature is enabled for the current account and the destination region.
|
|
157
|
+
* Archiving only modifies the archive flag of the session and does not stop or delete the session. If Archived is set to true, the session is archived. If Archived is set to false, the session is unarchived. If this parameter is omitted, the default value true is used. You can use the Archived parameter of ListAgentSessions to query archived and unarchived sessions separately.
|
|
158
|
+
* The caller must have access permissions on the current session and the corresponding OpenAPI action permissions. An HTTP 200 status code does not indicate that the business operation is successful. You must check JsonRpcResponse.Error. The successful result is located in JsonRpcResponse.Result.
|
|
159
|
+
*
|
|
160
|
+
* @param request - ArchiveAgentSessionRequest
|
|
161
|
+
* @returns ArchiveAgentSessionResponse
|
|
162
|
+
*/
|
|
163
|
+
archiveAgentSession(request: $_model.ArchiveAgentSessionRequest): Promise<$_model.ArchiveAgentSessionResponse>;
|
|
139
164
|
/**
|
|
140
165
|
* Associates an image with a workspace.
|
|
141
166
|
*
|
|
@@ -252,10 +277,10 @@ export default class Client extends OpenApi {
|
|
|
252
277
|
*/
|
|
253
278
|
batchDeleteMetaEntities(request: $_model.BatchDeleteMetaEntitiesRequest): Promise<$_model.BatchDeleteMetaEntitiesResponse>;
|
|
254
279
|
/**
|
|
255
|
-
*
|
|
280
|
+
* Applies incremental updates to multiple tasks in a batch.
|
|
256
281
|
*
|
|
257
282
|
* @remarks
|
|
258
|
-
*
|
|
283
|
+
* DataWorks Basic Edition or later is required.
|
|
259
284
|
*
|
|
260
285
|
* @param tmpReq - BatchUpdateTasksRequest
|
|
261
286
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -263,10 +288,10 @@ export default class Client extends OpenApi {
|
|
|
263
288
|
*/
|
|
264
289
|
batchUpdateTasksWithOptions(tmpReq: $_model.BatchUpdateTasksRequest, runtime: $dara.RuntimeOptions): Promise<$_model.BatchUpdateTasksResponse>;
|
|
265
290
|
/**
|
|
266
|
-
*
|
|
291
|
+
* Applies incremental updates to multiple tasks in a batch.
|
|
267
292
|
*
|
|
268
293
|
* @remarks
|
|
269
|
-
*
|
|
294
|
+
* DataWorks Basic Edition or later is required.
|
|
270
295
|
*
|
|
271
296
|
* @param request - BatchUpdateTasksRequest
|
|
272
297
|
* @returns BatchUpdateTasksResponse
|
|
@@ -276,7 +301,7 @@ export default class Client extends OpenApi {
|
|
|
276
301
|
* Builds an image.
|
|
277
302
|
*
|
|
278
303
|
* @remarks
|
|
279
|
-
* 1.
|
|
304
|
+
* 1. DataWorks Basic Edition or higher is required.
|
|
280
305
|
* 2. **Ensure that the service-linked role AliyunServiceRoleForDataWorks is created before you call this API operation.**
|
|
281
306
|
*
|
|
282
307
|
* @param request - BuildImageRequest
|
|
@@ -288,7 +313,7 @@ export default class Client extends OpenApi {
|
|
|
288
313
|
* Builds an image.
|
|
289
314
|
*
|
|
290
315
|
* @remarks
|
|
291
|
-
* 1.
|
|
316
|
+
* 1. DataWorks Basic Edition or higher is required.
|
|
292
317
|
* 2. **Ensure that the service-linked role AliyunServiceRoleForDataWorks is created before you call this API operation.**
|
|
293
318
|
*
|
|
294
319
|
* @param request - BuildImageRequest
|
|
@@ -324,7 +349,7 @@ export default class Client extends OpenApi {
|
|
|
324
349
|
* Cancels an image test.
|
|
325
350
|
*
|
|
326
351
|
* @remarks
|
|
327
|
-
* 1.
|
|
352
|
+
* 1. DataWorks Basic Edition or a higher edition is required.
|
|
328
353
|
* 2. **Make sure that the service-linked role AliyunServiceRoleForDataWorks is created before you call this operation.**
|
|
329
354
|
*
|
|
330
355
|
* @param request - CancelImageTestRequest
|
|
@@ -336,7 +361,7 @@ export default class Client extends OpenApi {
|
|
|
336
361
|
* Cancels an image test.
|
|
337
362
|
*
|
|
338
363
|
* @remarks
|
|
339
|
-
* 1.
|
|
364
|
+
* 1. DataWorks Basic Edition or a higher edition is required.
|
|
340
365
|
* 2. **Make sure that the service-linked role AliyunServiceRoleForDataWorks is created before you call this operation.**
|
|
341
366
|
*
|
|
342
367
|
* @param request - CancelImageTestRequest
|
|
@@ -372,12 +397,12 @@ export default class Client extends OpenApi {
|
|
|
372
397
|
* Creates an agent.
|
|
373
398
|
*
|
|
374
399
|
* @remarks
|
|
375
|
-
* ## Request
|
|
400
|
+
* ## Request description
|
|
376
401
|
* - **Agent name**: Must be unique within the current account.
|
|
377
|
-
* - **Model configuration**: Optional
|
|
378
|
-
* - **Visibility level**: Defines who can access the agent. Supports
|
|
379
|
-
* - **Visibility scope**: When `PROJECT` or `USER` is selected as the visibility level, you must
|
|
380
|
-
* - **Other parameters**:
|
|
402
|
+
* - **Model configuration**: Optional. Specifies the model used by the agent and its related settings.
|
|
403
|
+
* - **Visibility level**: Defines who can access the agent. Supports account-wide, project-specific, or user-specific visibility.
|
|
404
|
+
* - **Visibility scope**: When `PROJECT` or `USER` is selected as the visibility level, you must specify the specific project IDs or user IDs.
|
|
405
|
+
* - **Other parameters**: Parameters such as the display name and description are optional. Specify them as needed.
|
|
381
406
|
*
|
|
382
407
|
* @param tmpReq - CreateAgentRequest
|
|
383
408
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -388,29 +413,30 @@ export default class Client extends OpenApi {
|
|
|
388
413
|
* Creates an agent.
|
|
389
414
|
*
|
|
390
415
|
* @remarks
|
|
391
|
-
* ## Request
|
|
416
|
+
* ## Request description
|
|
392
417
|
* - **Agent name**: Must be unique within the current account.
|
|
393
|
-
* - **Model configuration**: Optional
|
|
394
|
-
* - **Visibility level**: Defines who can access the agent. Supports
|
|
395
|
-
* - **Visibility scope**: When `PROJECT` or `USER` is selected as the visibility level, you must
|
|
396
|
-
* - **Other parameters**:
|
|
418
|
+
* - **Model configuration**: Optional. Specifies the model used by the agent and its related settings.
|
|
419
|
+
* - **Visibility level**: Defines who can access the agent. Supports account-wide, project-specific, or user-specific visibility.
|
|
420
|
+
* - **Visibility scope**: When `PROJECT` or `USER` is selected as the visibility level, you must specify the specific project IDs or user IDs.
|
|
421
|
+
* - **Other parameters**: Parameters such as the display name and description are optional. Specify them as needed.
|
|
397
422
|
*
|
|
398
423
|
* @param request - CreateAgentRequest
|
|
399
424
|
* @returns CreateAgentResponse
|
|
400
425
|
*/
|
|
401
426
|
createAgent(request: $_model.CreateAgentRequest): Promise<$_model.CreateAgentResponse>;
|
|
402
427
|
/**
|
|
403
|
-
* Creates
|
|
428
|
+
* Creates a new agent session and returns the session ID.
|
|
404
429
|
*
|
|
405
430
|
* @remarks
|
|
406
431
|
* ## Request description
|
|
407
|
-
* - This operation creates
|
|
408
|
-
* -
|
|
432
|
+
* - This operation creates a new agent session.
|
|
433
|
+
* - Specify the name of the bound agent by using `Params.Meta.Agent.AgentName`. This parameter is required.
|
|
409
434
|
* - dataworks_data_agent: DataWorks built-in agent - Data Agent. It provides AI capabilities for the entire data development lifecycle, including data integration, development, O&M, governance, and analysis.
|
|
410
435
|
* - dataworks_chatbi_agent: DataWorks built-in agent - ChatBI. Based on natural language processing and intelligent analysis technologies, it automates the entire analysis process from requirement parsing, data extraction, and automatic code generation to visual report output through conversational interaction.
|
|
411
436
|
* - dataworks_ai_assistant_agent: DataWorks built-in agent - AI Assistant. An enterprise-grade AI assistant for DataWorks built on open-source frameworks such as OpenClaw and Hermes Agent.
|
|
412
|
-
* - You can
|
|
413
|
-
* - You can pass session tags by using `
|
|
437
|
+
* - You can specify the session source by using `Params.Meta.Config.SessionSource` to facilitate subsequent retrieval by source.
|
|
438
|
+
* - You can pass session tags by using `Params.Meta.Config.SessionTags[].SessionTagCode`.
|
|
439
|
+
* - Set optional initial session configurations by using `Params.Meta.InitialConfigOptions`. Use `Model`, `Mode`, and `ReasoningEffort` for the model, authorization mode, and reasoning configuration, respectively. After the session is created, save the session ID from the response to send prompts or subscribe to session events later.
|
|
414
440
|
*
|
|
415
441
|
* @param tmpReq - CreateAgentSessionRequest
|
|
416
442
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -418,17 +444,18 @@ export default class Client extends OpenApi {
|
|
|
418
444
|
*/
|
|
419
445
|
createAgentSessionWithOptions(tmpReq: $_model.CreateAgentSessionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateAgentSessionResponse>;
|
|
420
446
|
/**
|
|
421
|
-
* Creates
|
|
447
|
+
* Creates a new agent session and returns the session ID.
|
|
422
448
|
*
|
|
423
449
|
* @remarks
|
|
424
450
|
* ## Request description
|
|
425
|
-
* - This operation creates
|
|
426
|
-
* -
|
|
451
|
+
* - This operation creates a new agent session.
|
|
452
|
+
* - Specify the name of the bound agent by using `Params.Meta.Agent.AgentName`. This parameter is required.
|
|
427
453
|
* - dataworks_data_agent: DataWorks built-in agent - Data Agent. It provides AI capabilities for the entire data development lifecycle, including data integration, development, O&M, governance, and analysis.
|
|
428
454
|
* - dataworks_chatbi_agent: DataWorks built-in agent - ChatBI. Based on natural language processing and intelligent analysis technologies, it automates the entire analysis process from requirement parsing, data extraction, and automatic code generation to visual report output through conversational interaction.
|
|
429
455
|
* - dataworks_ai_assistant_agent: DataWorks built-in agent - AI Assistant. An enterprise-grade AI assistant for DataWorks built on open-source frameworks such as OpenClaw and Hermes Agent.
|
|
430
|
-
* - You can
|
|
431
|
-
* - You can pass session tags by using `
|
|
456
|
+
* - You can specify the session source by using `Params.Meta.Config.SessionSource` to facilitate subsequent retrieval by source.
|
|
457
|
+
* - You can pass session tags by using `Params.Meta.Config.SessionTags[].SessionTagCode`.
|
|
458
|
+
* - Set optional initial session configurations by using `Params.Meta.InitialConfigOptions`. Use `Model`, `Mode`, and `ReasoningEffort` for the model, authorization mode, and reasoning configuration, respectively. After the session is created, save the session ID from the response to send prompts or subscribe to session events later.
|
|
432
459
|
*
|
|
433
460
|
* @param request - CreateAgentSessionRequest
|
|
434
461
|
* @returns CreateAgentSessionResponse
|
|
@@ -485,6 +512,21 @@ export default class Client extends OpenApi {
|
|
|
485
512
|
* @returns CreateCalendarResponse
|
|
486
513
|
*/
|
|
487
514
|
createCalendar(request: $_model.CreateCalendarRequest): Promise<$_model.CreateCalendarResponse>;
|
|
515
|
+
/**
|
|
516
|
+
* Creates a code review.
|
|
517
|
+
*
|
|
518
|
+
* @param request - CreateCodeReviewRequest
|
|
519
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
520
|
+
* @returns CreateCodeReviewResponse
|
|
521
|
+
*/
|
|
522
|
+
createCodeReviewWithOptions(request: $_model.CreateCodeReviewRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateCodeReviewResponse>;
|
|
523
|
+
/**
|
|
524
|
+
* Creates a code review.
|
|
525
|
+
*
|
|
526
|
+
* @param request - CreateCodeReviewRequest
|
|
527
|
+
* @returns CreateCodeReviewResponse
|
|
528
|
+
*/
|
|
529
|
+
createCodeReview(request: $_model.CreateCodeReviewRequest): Promise<$_model.CreateCodeReviewResponse>;
|
|
488
530
|
/**
|
|
489
531
|
* Creates a component.
|
|
490
532
|
*
|
|
@@ -536,15 +578,15 @@ export default class Client extends OpenApi {
|
|
|
536
578
|
*
|
|
537
579
|
* @remarks
|
|
538
580
|
* ## Scenarios
|
|
539
|
-
*
|
|
540
|
-
* ## Recommended
|
|
541
|
-
* 1. Call
|
|
542
|
-
* 2. Create a crawler by using a data source that matches the
|
|
543
|
-
* 3. After the crawler is created, call
|
|
581
|
+
* Create a metadata crawler for a specified data source, and configure the collection scope, resource group, scheduling method, and extended configurations.
|
|
582
|
+
* ## Recommended procedure
|
|
583
|
+
* 1. Call GetCrawlerTypeCapabilities to query the crawler types supported in the current region and their configuration capabilities.
|
|
584
|
+
* 2. Create a crawler by using a data source that matches the Type. Before you create the crawler, make sure that the data source and the selected resource group pass the connectivity test by calling the TestDataSourceConnectivity API. This prevents you from creating an invalid crawler.
|
|
585
|
+
* 3. After the crawler is created, call RunCrawler to manually run the crawler, or configure periodic scheduling to automatically run the crawler.
|
|
544
586
|
* ## Edition requirements
|
|
545
|
-
* DataWorks Basic Edition or
|
|
587
|
+
* You must purchase DataWorks Basic Edition or higher to use this feature.
|
|
546
588
|
* ## Precautions
|
|
547
|
-
* A successful creation only indicates that the crawler configuration
|
|
589
|
+
* A successful creation only indicates that the crawler configuration is generated. The metadata collection is not immediately executed.
|
|
548
590
|
*
|
|
549
591
|
* @param tmpReq - CreateCrawlerRequest
|
|
550
592
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -556,25 +598,25 @@ export default class Client extends OpenApi {
|
|
|
556
598
|
*
|
|
557
599
|
* @remarks
|
|
558
600
|
* ## Scenarios
|
|
559
|
-
*
|
|
560
|
-
* ## Recommended
|
|
561
|
-
* 1. Call
|
|
562
|
-
* 2. Create a crawler by using a data source that matches the
|
|
563
|
-
* 3. After the crawler is created, call
|
|
601
|
+
* Create a metadata crawler for a specified data source, and configure the collection scope, resource group, scheduling method, and extended configurations.
|
|
602
|
+
* ## Recommended procedure
|
|
603
|
+
* 1. Call GetCrawlerTypeCapabilities to query the crawler types supported in the current region and their configuration capabilities.
|
|
604
|
+
* 2. Create a crawler by using a data source that matches the Type. Before you create the crawler, make sure that the data source and the selected resource group pass the connectivity test by calling the TestDataSourceConnectivity API. This prevents you from creating an invalid crawler.
|
|
605
|
+
* 3. After the crawler is created, call RunCrawler to manually run the crawler, or configure periodic scheduling to automatically run the crawler.
|
|
564
606
|
* ## Edition requirements
|
|
565
|
-
* DataWorks Basic Edition or
|
|
607
|
+
* You must purchase DataWorks Basic Edition or higher to use this feature.
|
|
566
608
|
* ## Precautions
|
|
567
|
-
* A successful creation only indicates that the crawler configuration
|
|
609
|
+
* A successful creation only indicates that the crawler configuration is generated. The metadata collection is not immediately executed.
|
|
568
610
|
*
|
|
569
611
|
* @param request - CreateCrawlerRequest
|
|
570
612
|
* @returns CreateCrawlerResponse
|
|
571
613
|
*/
|
|
572
614
|
createCrawler(request: $_model.CreateCrawlerRequest): Promise<$_model.CreateCrawlerResponse>;
|
|
573
615
|
/**
|
|
574
|
-
* Creates a cross-workspace deployment
|
|
616
|
+
* Creates a cross-workspace deployment pipeline.
|
|
575
617
|
*
|
|
576
618
|
* @remarks
|
|
577
|
-
* Creates and
|
|
619
|
+
* Creates and solidifies a cross-project deployment pipeline. The ObjectIds parameter must contain exactly one top-level object ID from the source project. Sub-objects of composite objects such as workflows are automatically included by the system. Passing multiple objects causes parameter validation to fail. You can call the ListCrossProjectDeploymentCandidates operation to query candidate objects. After the pipeline is created, call the ExecCrossProjectPipelineRun operation to execute the deployment, and call the GetCrossProjectPipelineRun operation to query the status.
|
|
578
620
|
*
|
|
579
621
|
* @param tmpReq - CreateCrossProjectPipelineRunRequest
|
|
580
622
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -582,10 +624,10 @@ export default class Client extends OpenApi {
|
|
|
582
624
|
*/
|
|
583
625
|
createCrossProjectPipelineRunWithOptions(tmpReq: $_model.CreateCrossProjectPipelineRunRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateCrossProjectPipelineRunResponse>;
|
|
584
626
|
/**
|
|
585
|
-
* Creates a cross-workspace deployment
|
|
627
|
+
* Creates a cross-workspace deployment pipeline.
|
|
586
628
|
*
|
|
587
629
|
* @remarks
|
|
588
|
-
* Creates and
|
|
630
|
+
* Creates and solidifies a cross-project deployment pipeline. The ObjectIds parameter must contain exactly one top-level object ID from the source project. Sub-objects of composite objects such as workflows are automatically included by the system. Passing multiple objects causes parameter validation to fail. You can call the ListCrossProjectDeploymentCandidates operation to query candidate objects. After the pipeline is created, call the ExecCrossProjectPipelineRun operation to execute the deployment, and call the GetCrossProjectPipelineRun operation to query the status.
|
|
589
631
|
*
|
|
590
632
|
* @param request - CreateCrossProjectPipelineRunRequest
|
|
591
633
|
* @returns CreateCrossProjectPipelineRunResponse
|
|
@@ -796,7 +838,7 @@ export default class Client extends OpenApi {
|
|
|
796
838
|
* Creates a data quality monitor.
|
|
797
839
|
*
|
|
798
840
|
* @remarks
|
|
799
|
-
* DataWorks Basic Edition or
|
|
841
|
+
* You must purchase DataWorks Basic Edition or later to use this feature.
|
|
800
842
|
*
|
|
801
843
|
* @param tmpReq - CreateDataQualityScanRequest
|
|
802
844
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -807,7 +849,7 @@ export default class Client extends OpenApi {
|
|
|
807
849
|
* Creates a data quality monitor.
|
|
808
850
|
*
|
|
809
851
|
* @remarks
|
|
810
|
-
* DataWorks Basic Edition or
|
|
852
|
+
* You must purchase DataWorks Basic Edition or later to use this feature.
|
|
811
853
|
*
|
|
812
854
|
* @param request - CreateDataQualityScanRequest
|
|
813
855
|
* @returns CreateDataQualityScanResponse
|
|
@@ -906,7 +948,7 @@ export default class Client extends OpenApi {
|
|
|
906
948
|
*/
|
|
907
949
|
createDataSourceSharedRule(request: $_model.CreateDataSourceSharedRuleRequest): Promise<$_model.CreateDataSourceSharedRuleResponse>;
|
|
908
950
|
/**
|
|
909
|
-
* Creates a dataset.
|
|
951
|
+
* Creates a dataset. Datasets can only be created in workspaces that you have joined. Currently, only DataWorks datasets are supported. The maximum number of datasets per tenant is 2,000.
|
|
910
952
|
*
|
|
911
953
|
* @param tmpReq - CreateDatasetRequest
|
|
912
954
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -914,14 +956,14 @@ export default class Client extends OpenApi {
|
|
|
914
956
|
*/
|
|
915
957
|
createDatasetWithOptions(tmpReq: $_model.CreateDatasetRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateDatasetResponse>;
|
|
916
958
|
/**
|
|
917
|
-
* Creates a dataset.
|
|
959
|
+
* Creates a dataset. Datasets can only be created in workspaces that you have joined. Currently, only DataWorks datasets are supported. The maximum number of datasets per tenant is 2,000.
|
|
918
960
|
*
|
|
919
961
|
* @param request - CreateDatasetRequest
|
|
920
962
|
* @returns CreateDatasetResponse
|
|
921
963
|
*/
|
|
922
964
|
createDataset(request: $_model.CreateDatasetRequest): Promise<$_model.CreateDatasetResponse>;
|
|
923
965
|
/**
|
|
924
|
-
* Creates a dataset version. Currently, only DataWorks datasets are supported
|
|
966
|
+
* Creates a dataset version. Currently, only DataWorks datasets are supported, and the maximum number of versions is 20.
|
|
925
967
|
*
|
|
926
968
|
* @param tmpReq - CreateDatasetVersionRequest
|
|
927
969
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -929,7 +971,7 @@ export default class Client extends OpenApi {
|
|
|
929
971
|
*/
|
|
930
972
|
createDatasetVersionWithOptions(tmpReq: $_model.CreateDatasetVersionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateDatasetVersionResponse>;
|
|
931
973
|
/**
|
|
932
|
-
* Creates a dataset version. Currently, only DataWorks datasets are supported
|
|
974
|
+
* Creates a dataset version. Currently, only DataWorks datasets are supported, and the maximum number of versions is 20.
|
|
933
975
|
*
|
|
934
976
|
* @param request - CreateDatasetVersionRequest
|
|
935
977
|
* @returns CreateDatasetVersionResponse
|
|
@@ -1056,10 +1098,10 @@ export default class Client extends OpenApi {
|
|
|
1056
1098
|
*
|
|
1057
1099
|
* @remarks
|
|
1058
1100
|
* ## Request description
|
|
1059
|
-
* - After
|
|
1060
|
-
* - If the
|
|
1061
|
-
* - The
|
|
1062
|
-
* - The
|
|
1101
|
+
* - After submission, the system verifies the availability of the MCP server based on the provided connection information.
|
|
1102
|
+
* - If the MCP server connection is unavailable, the API returns the corresponding error message.
|
|
1103
|
+
* - The Name field must start with a lowercase letter and can contain only lowercase letters, digits, underscores (_), and hyphens (-). It must be unique within the current account.
|
|
1104
|
+
* - The Visibility field defines the visibility level of the MCP server. Valid values: `TENANT` (visible within the account), `PROJECT` (visible to specified projects), and `USER` (visible to specified users). Depending on the selected value, you must provide the corresponding VisibilityScope parameter to further specify the visibility scope.
|
|
1063
1105
|
*
|
|
1064
1106
|
* @param tmpReq - CreateMcpServerRequest
|
|
1065
1107
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1071,10 +1113,10 @@ export default class Client extends OpenApi {
|
|
|
1071
1113
|
*
|
|
1072
1114
|
* @remarks
|
|
1073
1115
|
* ## Request description
|
|
1074
|
-
* - After
|
|
1075
|
-
* - If the
|
|
1076
|
-
* - The
|
|
1077
|
-
* - The
|
|
1116
|
+
* - After submission, the system verifies the availability of the MCP server based on the provided connection information.
|
|
1117
|
+
* - If the MCP server connection is unavailable, the API returns the corresponding error message.
|
|
1118
|
+
* - The Name field must start with a lowercase letter and can contain only lowercase letters, digits, underscores (_), and hyphens (-). It must be unique within the current account.
|
|
1119
|
+
* - The Visibility field defines the visibility level of the MCP server. Valid values: `TENANT` (visible within the account), `PROJECT` (visible to specified projects), and `USER` (visible to specified users). Depending on the selected value, you must provide the corresponding VisibilityScope parameter to further specify the visibility scope.
|
|
1078
1120
|
*
|
|
1079
1121
|
* @param request - CreateMcpServerRequest
|
|
1080
1122
|
* @returns CreateMcpServerResponse
|
|
@@ -1209,16 +1251,16 @@ export default class Client extends OpenApi {
|
|
|
1209
1251
|
*/
|
|
1210
1252
|
createPipelineRun(request: $_model.CreatePipelineRunRequest): Promise<$_model.CreatePipelineRunResponse>;
|
|
1211
1253
|
/**
|
|
1212
|
-
* Creates
|
|
1254
|
+
* Creates an approval flow definition with custom approval rules and notification services.
|
|
1213
1255
|
*
|
|
1214
1256
|
* @remarks
|
|
1215
|
-
* ##
|
|
1216
|
-
* - This API
|
|
1217
|
-
* - You can define a list of condition rules (RuleConditions) to specify the conditions under which the approval
|
|
1218
|
-
* -
|
|
1219
|
-
* - The approval
|
|
1220
|
-
* - You can choose whether to immediately enable the newly created approval
|
|
1221
|
-
* - Note:
|
|
1257
|
+
* ## Request description
|
|
1258
|
+
* - This API allows you to create an approval flow definition, including setting basic information such as the policy name, description, type, and subtype.
|
|
1259
|
+
* - You can define a list of condition rules (RuleConditions) to specify the conditions under which the approval flow is triggered.
|
|
1260
|
+
* - You can configure multiple notification services (NotificationServices) to send notifications to relevant personnel at different stages of the approval flow.
|
|
1261
|
+
* - The list of approval nodes (ApprovalNodes) defines the nodes that the approval process must pass through and the approver information.
|
|
1262
|
+
* - You can choose whether to immediately enable the newly created approval flow definition.
|
|
1263
|
+
* - Note: Some fields, such as Type, have specific value limits. Refer to the constraint description section in the documentation.
|
|
1222
1264
|
*
|
|
1223
1265
|
* @param tmpReq - CreateProcessDefinitionRequest
|
|
1224
1266
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1226,16 +1268,16 @@ export default class Client extends OpenApi {
|
|
|
1226
1268
|
*/
|
|
1227
1269
|
createProcessDefinitionWithOptions(tmpReq: $_model.CreateProcessDefinitionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateProcessDefinitionResponse>;
|
|
1228
1270
|
/**
|
|
1229
|
-
* Creates
|
|
1271
|
+
* Creates an approval flow definition with custom approval rules and notification services.
|
|
1230
1272
|
*
|
|
1231
1273
|
* @remarks
|
|
1232
|
-
* ##
|
|
1233
|
-
* - This API
|
|
1234
|
-
* - You can define a list of condition rules (RuleConditions) to specify the conditions under which the approval
|
|
1235
|
-
* -
|
|
1236
|
-
* - The approval
|
|
1237
|
-
* - You can choose whether to immediately enable the newly created approval
|
|
1238
|
-
* - Note:
|
|
1274
|
+
* ## Request description
|
|
1275
|
+
* - This API allows you to create an approval flow definition, including setting basic information such as the policy name, description, type, and subtype.
|
|
1276
|
+
* - You can define a list of condition rules (RuleConditions) to specify the conditions under which the approval flow is triggered.
|
|
1277
|
+
* - You can configure multiple notification services (NotificationServices) to send notifications to relevant personnel at different stages of the approval flow.
|
|
1278
|
+
* - The list of approval nodes (ApprovalNodes) defines the nodes that the approval process must pass through and the approver information.
|
|
1279
|
+
* - You can choose whether to immediately enable the newly created approval flow definition.
|
|
1280
|
+
* - Note: Some fields, such as Type, have specific value limits. Refer to the constraint description section in the documentation.
|
|
1239
1281
|
*
|
|
1240
1282
|
* @param request - CreateProcessDefinitionRequest
|
|
1241
1283
|
* @returns CreateProcessDefinitionResponse
|
|
@@ -1340,9 +1382,9 @@ export default class Client extends OpenApi {
|
|
|
1340
1382
|
* Creates a resource group.
|
|
1341
1383
|
*
|
|
1342
1384
|
* @remarks
|
|
1343
|
-
* 1. DataWorks Basic Edition or
|
|
1344
|
-
* 2. **Before you call this operation, make sure that you fully understand the billing methods and [pricing](https://help.aliyun.com/document_detail/2680173.html) of DataWorks general-purpose resource groups.**
|
|
1345
|
-
* 3. **Before you call this operation, make sure that you have created the service-linked role AliyunServiceRoleForDataWorks.**
|
|
1385
|
+
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this API operation.
|
|
1386
|
+
* 2. **Before you call this API operation, make sure that you fully understand the billing methods and [pricing](https://help.aliyun.com/document_detail/2680173.html) of DataWorks general-purpose resource groups.**
|
|
1387
|
+
* 3. **Before you call this API operation, make sure that you have created the service-linked role AliyunServiceRoleForDataWorks.**
|
|
1346
1388
|
*
|
|
1347
1389
|
* @param tmpReq - CreateResourceGroupRequest
|
|
1348
1390
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1353,9 +1395,9 @@ export default class Client extends OpenApi {
|
|
|
1353
1395
|
* Creates a resource group.
|
|
1354
1396
|
*
|
|
1355
1397
|
* @remarks
|
|
1356
|
-
* 1. DataWorks Basic Edition or
|
|
1357
|
-
* 2. **Before you call this operation, make sure that you fully understand the billing methods and [pricing](https://help.aliyun.com/document_detail/2680173.html) of DataWorks general-purpose resource groups.**
|
|
1358
|
-
* 3. **Before you call this operation, make sure that you have created the service-linked role AliyunServiceRoleForDataWorks.**
|
|
1398
|
+
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this API operation.
|
|
1399
|
+
* 2. **Before you call this API operation, make sure that you fully understand the billing methods and [pricing](https://help.aliyun.com/document_detail/2680173.html) of DataWorks general-purpose resource groups.**
|
|
1400
|
+
* 3. **Before you call this API operation, make sure that you have created the service-linked role AliyunServiceRoleForDataWorks.**
|
|
1359
1401
|
*
|
|
1360
1402
|
* @param request - CreateResourceGroupRequest
|
|
1361
1403
|
* @returns CreateResourceGroupResponse
|
|
@@ -1416,17 +1458,17 @@ export default class Client extends OpenApi {
|
|
|
1416
1458
|
*/
|
|
1417
1459
|
createSecurityStrategy(request: $_model.CreateSecurityStrategyRequest): Promise<$_model.CreateSecurityStrategyResponse>;
|
|
1418
1460
|
/**
|
|
1419
|
-
* Saves a reusable semantic
|
|
1461
|
+
* Saves a reusable semantic task definition. If you use a single-file source, apply for and complete the attachment upload first. After the definition is created, call RunSemanticJob with the returned Name.
|
|
1420
1462
|
*
|
|
1421
1463
|
* @remarks
|
|
1422
1464
|
* ## Scenarios
|
|
1423
|
-
* Creates and saves a reusable semantic
|
|
1424
|
-
* ## Recommended
|
|
1425
|
-
* 1.
|
|
1426
|
-
* 2. Configure `Source`, `ProjectId`, and `ResourceGroupId`, and then call this operation to save the
|
|
1427
|
-
* 3.
|
|
1428
|
-
* ##
|
|
1429
|
-
* `Name` must be unique within the current tenant. The
|
|
1465
|
+
* Creates and saves a reusable semantic task definition. This API operation only saves the configurations of the data source, resource group, and reference files, and does not execute the task immediately.
|
|
1466
|
+
* ## Recommended procedure
|
|
1467
|
+
* 1. If `Source.type` is set to `singleTableFile`, call `UploadSemanticFile` first, use the returned `Data.UploadUrl` to complete the PUT upload, and then specify `Data.FileId` in `ReferenceFileIds`. Alternatively, you can provide a single accessible URI.
|
|
1468
|
+
* 2. Configure `Source`, `ProjectId`, and `ResourceGroupId`, and then call this operation to save the task.
|
|
1469
|
+
* 3. Call `RunSemanticJob` by using `Data.Name` in the response. After the task is completed, call `DownloadSemanticResults` to obtain the output.
|
|
1470
|
+
* ## Precautions
|
|
1471
|
+
* `Name` must be unique within the current tenant. The rules for the number of reference files differ between single-file sources and other sources. For details, refer to the descriptions of the `ReferenceFileIds` and `ReferenceFileUris` fields.
|
|
1430
1472
|
*
|
|
1431
1473
|
* @param tmpReq - CreateSemanticJobRequest
|
|
1432
1474
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1434,17 +1476,17 @@ export default class Client extends OpenApi {
|
|
|
1434
1476
|
*/
|
|
1435
1477
|
createSemanticJobWithOptions(tmpReq: $_model.CreateSemanticJobRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateSemanticJobResponse>;
|
|
1436
1478
|
/**
|
|
1437
|
-
* Saves a reusable semantic
|
|
1479
|
+
* Saves a reusable semantic task definition. If you use a single-file source, apply for and complete the attachment upload first. After the definition is created, call RunSemanticJob with the returned Name.
|
|
1438
1480
|
*
|
|
1439
1481
|
* @remarks
|
|
1440
1482
|
* ## Scenarios
|
|
1441
|
-
* Creates and saves a reusable semantic
|
|
1442
|
-
* ## Recommended
|
|
1443
|
-
* 1.
|
|
1444
|
-
* 2. Configure `Source`, `ProjectId`, and `ResourceGroupId`, and then call this operation to save the
|
|
1445
|
-
* 3.
|
|
1446
|
-
* ##
|
|
1447
|
-
* `Name` must be unique within the current tenant. The
|
|
1483
|
+
* Creates and saves a reusable semantic task definition. This API operation only saves the configurations of the data source, resource group, and reference files, and does not execute the task immediately.
|
|
1484
|
+
* ## Recommended procedure
|
|
1485
|
+
* 1. If `Source.type` is set to `singleTableFile`, call `UploadSemanticFile` first, use the returned `Data.UploadUrl` to complete the PUT upload, and then specify `Data.FileId` in `ReferenceFileIds`. Alternatively, you can provide a single accessible URI.
|
|
1486
|
+
* 2. Configure `Source`, `ProjectId`, and `ResourceGroupId`, and then call this operation to save the task.
|
|
1487
|
+
* 3. Call `RunSemanticJob` by using `Data.Name` in the response. After the task is completed, call `DownloadSemanticResults` to obtain the output.
|
|
1488
|
+
* ## Precautions
|
|
1489
|
+
* `Name` must be unique within the current tenant. The rules for the number of reference files differ between single-file sources and other sources. For details, refer to the descriptions of the `ReferenceFileIds` and `ReferenceFileUris` fields.
|
|
1448
1490
|
*
|
|
1449
1491
|
* @param request - CreateSemanticJobRequest
|
|
1450
1492
|
* @returns CreateSemanticJobResponse
|
|
@@ -1477,8 +1519,8 @@ export default class Client extends OpenApi {
|
|
|
1477
1519
|
* @remarks
|
|
1478
1520
|
* ## Request description
|
|
1479
1521
|
* - You must specify either the SkillMdOverride or BundleUrl parameter.
|
|
1480
|
-
* - You can set Visibility to TENANT, PROJECT, or USER, which indicates that the skill is visible
|
|
1481
|
-
* - If
|
|
1522
|
+
* - You can set Visibility to TENANT, PROJECT, or USER, which indicates that the skill is visible within the account, visible to specified projects, or visible to specified users, respectively.
|
|
1523
|
+
* - If Visibility is set to PROJECT, you must specify the IDs of the projects in which the skill is visible by using VisibilityScope.ProjectIds. If Visibility is set to USER, you must specify the IDs of the users who can see the skill by using VisibilityScope.UserIds.
|
|
1482
1524
|
*
|
|
1483
1525
|
* @param tmpReq - CreateSkillRequest
|
|
1484
1526
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1491,8 +1533,8 @@ export default class Client extends OpenApi {
|
|
|
1491
1533
|
* @remarks
|
|
1492
1534
|
* ## Request description
|
|
1493
1535
|
* - You must specify either the SkillMdOverride or BundleUrl parameter.
|
|
1494
|
-
* - You can set Visibility to TENANT, PROJECT, or USER, which indicates that the skill is visible
|
|
1495
|
-
* - If
|
|
1536
|
+
* - You can set Visibility to TENANT, PROJECT, or USER, which indicates that the skill is visible within the account, visible to specified projects, or visible to specified users, respectively.
|
|
1537
|
+
* - If Visibility is set to PROJECT, you must specify the IDs of the projects in which the skill is visible by using VisibilityScope.ProjectIds. If Visibility is set to USER, you must specify the IDs of the users who can see the skill by using VisibilityScope.UserIds.
|
|
1496
1538
|
*
|
|
1497
1539
|
* @param request - CreateSkillRequest
|
|
1498
1540
|
* @returns CreateSkillResponse
|
|
@@ -1537,10 +1579,10 @@ export default class Client extends OpenApi {
|
|
|
1537
1579
|
*/
|
|
1538
1580
|
createWorkflowDefinition(request: $_model.CreateWorkflowDefinitionRequest): Promise<$_model.CreateWorkflowDefinitionResponse>;
|
|
1539
1581
|
/**
|
|
1540
|
-
* Creates a workflow instance
|
|
1582
|
+
* Creates a workflow instance from the specified configuration, for example, a data backfill workflow instance.
|
|
1541
1583
|
*
|
|
1542
1584
|
* @remarks
|
|
1543
|
-
* You must purchase DataWorks Basic Edition or
|
|
1585
|
+
* You must purchase DataWorks Basic Edition or higher to use this operation.
|
|
1544
1586
|
*
|
|
1545
1587
|
* @param tmpReq - CreateWorkflowInstancesRequest
|
|
1546
1588
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1548,10 +1590,10 @@ export default class Client extends OpenApi {
|
|
|
1548
1590
|
*/
|
|
1549
1591
|
createWorkflowInstancesWithOptions(tmpReq: $_model.CreateWorkflowInstancesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateWorkflowInstancesResponse>;
|
|
1550
1592
|
/**
|
|
1551
|
-
* Creates a workflow instance
|
|
1593
|
+
* Creates a workflow instance from the specified configuration, for example, a data backfill workflow instance.
|
|
1552
1594
|
*
|
|
1553
1595
|
* @remarks
|
|
1554
|
-
* You must purchase DataWorks Basic Edition or
|
|
1596
|
+
* You must purchase DataWorks Basic Edition or higher to use this operation.
|
|
1555
1597
|
*
|
|
1556
1598
|
* @param request - CreateWorkflowInstancesRequest
|
|
1557
1599
|
* @returns CreateWorkflowInstancesResponse
|
|
@@ -1580,6 +1622,31 @@ export default class Client extends OpenApi {
|
|
|
1580
1622
|
* @returns DeleteAgentResponse
|
|
1581
1623
|
*/
|
|
1582
1624
|
deleteAgent(request: $_model.DeleteAgentRequest): Promise<$_model.DeleteAgentResponse>;
|
|
1625
|
+
/**
|
|
1626
|
+
* Deletes a specified agent session. This API operation is available only when the canary release feature is enabled. Before calling this operation, ensure that the canary release feature is enabled for the current account and the target region.
|
|
1627
|
+
*
|
|
1628
|
+
* @remarks
|
|
1629
|
+
* This API operation is available only when the canary release feature is enabled. Before calling this operation, ensure that the canary release feature is enabled for the current account and the target region.
|
|
1630
|
+
* Verify the target session before proceeding. A deleted session cannot be recovered by unarchiving it through ArchiveAgentSession. To temporarily hide a session, use ArchiveAgentSession. To stop the current execution, use CancelAgentSession.
|
|
1631
|
+
* The caller must have access permissions for the current session and the corresponding OpenAPI action permissions. An HTTP 200 status code does not indicate a successful business operation. You must check JsonRpcResponse.Error for errors. Successful results are located in JsonRpcResponse.Result.
|
|
1632
|
+
*
|
|
1633
|
+
* @param tmpReq - DeleteAgentSessionRequest
|
|
1634
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
1635
|
+
* @returns DeleteAgentSessionResponse
|
|
1636
|
+
*/
|
|
1637
|
+
deleteAgentSessionWithOptions(tmpReq: $_model.DeleteAgentSessionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteAgentSessionResponse>;
|
|
1638
|
+
/**
|
|
1639
|
+
* Deletes a specified agent session. This API operation is available only when the canary release feature is enabled. Before calling this operation, ensure that the canary release feature is enabled for the current account and the target region.
|
|
1640
|
+
*
|
|
1641
|
+
* @remarks
|
|
1642
|
+
* This API operation is available only when the canary release feature is enabled. Before calling this operation, ensure that the canary release feature is enabled for the current account and the target region.
|
|
1643
|
+
* Verify the target session before proceeding. A deleted session cannot be recovered by unarchiving it through ArchiveAgentSession. To temporarily hide a session, use ArchiveAgentSession. To stop the current execution, use CancelAgentSession.
|
|
1644
|
+
* The caller must have access permissions for the current session and the corresponding OpenAPI action permissions. An HTTP 200 status code does not indicate a successful business operation. You must check JsonRpcResponse.Error for errors. Successful results are located in JsonRpcResponse.Result.
|
|
1645
|
+
*
|
|
1646
|
+
* @param request - DeleteAgentSessionRequest
|
|
1647
|
+
* @returns DeleteAgentSessionResponse
|
|
1648
|
+
*/
|
|
1649
|
+
deleteAgentSession(request: $_model.DeleteAgentSessionRequest): Promise<$_model.DeleteAgentSessionResponse>;
|
|
1583
1650
|
/**
|
|
1584
1651
|
* Deletes a custom monitoring alert rule.
|
|
1585
1652
|
*
|
|
@@ -2916,8 +2983,8 @@ export default class Client extends OpenApi {
|
|
|
2916
2983
|
* Retrieves the details of an agent.
|
|
2917
2984
|
*
|
|
2918
2985
|
* @remarks
|
|
2919
|
-
* ##
|
|
2920
|
-
* This operation retrieves the detailed configuration information of an agent by its name, including but not limited to model configurations, system prompts, and tool lists. You must provide the exact agent name as a parameter in the request.
|
|
2986
|
+
* ## Request description
|
|
2987
|
+
* This API operation retrieves the detailed configuration information of an agent by its name, including but not limited to model configurations, system prompts, and tool lists. You must provide the exact agent name as a parameter in the request.
|
|
2921
2988
|
*
|
|
2922
2989
|
* @param request - GetAgentRequest
|
|
2923
2990
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2928,8 +2995,8 @@ export default class Client extends OpenApi {
|
|
|
2928
2995
|
* Retrieves the details of an agent.
|
|
2929
2996
|
*
|
|
2930
2997
|
* @remarks
|
|
2931
|
-
* ##
|
|
2932
|
-
* This operation retrieves the detailed configuration information of an agent by its name, including but not limited to model configurations, system prompts, and tool lists. You must provide the exact agent name as a parameter in the request.
|
|
2998
|
+
* ## Request description
|
|
2999
|
+
* This API operation retrieves the detailed configuration information of an agent by its name, including but not limited to model configurations, system prompts, and tool lists. You must provide the exact agent name as a parameter in the request.
|
|
2933
3000
|
*
|
|
2934
3001
|
* @param request - GetAgentRequest
|
|
2935
3002
|
* @returns GetAgentResponse
|
|
@@ -2960,6 +3027,53 @@ export default class Client extends OpenApi {
|
|
|
2960
3027
|
* @returns GetAgentSessionArtifactMetaResponse
|
|
2961
3028
|
*/
|
|
2962
3029
|
getAgentSessionArtifactMeta(request: $_model.GetAgentSessionArtifactMetaRequest): Promise<$_model.GetAgentSessionArtifactMetaResponse>;
|
|
3030
|
+
/**
|
|
3031
|
+
* Subscribes to real-time Server-Sent Events (SSE) for a specified agent session independently, with support for resumption using a remote cursor. This API operation is available only when the canary release feature is enabled. Before calling this operation, ensure that the corresponding canary release is enabled for your account and the target region.
|
|
3032
|
+
*
|
|
3033
|
+
* @remarks
|
|
3034
|
+
* This API operation is available only when the canary release feature is enabled. Before calling this operation, ensure that the corresponding canary release is enabled for your account and the target region.
|
|
3035
|
+
* This API operation provides a read-only SSE subscription and does not submit questions. Use a GET request and maintain streaming reads. Do not read the response as a standard JSON object at once. For long-running tasks that may exceed the timeout of a single request, establish an independent event subscription before calling PromptAgentSession. After creating a session, set SessionCode to the SessionId and read both streams in parallel. The Events stream displays real-time progress, while the built-in SSE of the Prompt stream is used to read the final state and business errors of the current turn.
|
|
3036
|
+
* Events display messages, tool invoke, and execution progress. The establishment of a subscription connection, heartbeats, or an HTTP 200 status code does not indicate task completion. Determine task completion based on the actual final state events and the Prompt invoke results.
|
|
3037
|
+
* When resuming after a disconnection, pass the ID of the last consumed remote event as Last-Event-Id. Also, save and pass back the EventEpoch of the same event stream if the server has returned it. When subscribing for the first time without a cursor, omit these two parameters to receive only real-time events after the subscription is established. Explicitly setting Last-Event-Id to 0 attempts to replay from the starting point still in the cache, which does not mean the complete history can be retrieved. Retrieve the complete history by calling LoadAgentSession. Do not generate cursors or epochs yourself, or use local message sequence numbers as replacements.
|
|
3038
|
+
* The event cache is bounded. If you receive a resynchronization prompt such as state_resync_required or the cursor is no longer available, restore the history by calling LoadAgentSession and then re-establish the subscription. LoadAgentSession is used for refreshing and exception recovery, and should not be called repeatedly to replace real-time event subscriptions. If the Prompt stream times out or disconnects before receiving the business final state, the result of the current turn is unknown, and you can continue to observe the progress through the Events stream. Avoid automatically resending the Prompt. Closing the Events subscription does not trigger CancelAgentSession.
|
|
3039
|
+
* Servers that support epoch information return eventEpoch in the data of the stream_open control frame and provide a mapping between the business sessionId and nativeSessionId. Save the identifiers returned by the server. Do not assume that the business session ID is the same as the native session ID. The cursor and eventEpoch must come from the same event stream epoch of the same native session, and cannot be reused across native sessions or epochs. Do not advance the cursor when the control frame does not have an ID.
|
|
3040
|
+
*
|
|
3041
|
+
* @param request - GetAgentSessionEventsRequest
|
|
3042
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
3043
|
+
* @returns GetAgentSessionEventsResponse
|
|
3044
|
+
*/
|
|
3045
|
+
getAgentSessionEventsWithSSE(request: $_model.GetAgentSessionEventsRequest, runtime: $dara.RuntimeOptions): AsyncGenerator<$_model.GetAgentSessionEventsResponse, any, unknown>;
|
|
3046
|
+
/**
|
|
3047
|
+
* Subscribes to real-time Server-Sent Events (SSE) for a specified agent session independently, with support for resumption using a remote cursor. This API operation is available only when the canary release feature is enabled. Before calling this operation, ensure that the corresponding canary release is enabled for your account and the target region.
|
|
3048
|
+
*
|
|
3049
|
+
* @remarks
|
|
3050
|
+
* This API operation is available only when the canary release feature is enabled. Before calling this operation, ensure that the corresponding canary release is enabled for your account and the target region.
|
|
3051
|
+
* This API operation provides a read-only SSE subscription and does not submit questions. Use a GET request and maintain streaming reads. Do not read the response as a standard JSON object at once. For long-running tasks that may exceed the timeout of a single request, establish an independent event subscription before calling PromptAgentSession. After creating a session, set SessionCode to the SessionId and read both streams in parallel. The Events stream displays real-time progress, while the built-in SSE of the Prompt stream is used to read the final state and business errors of the current turn.
|
|
3052
|
+
* Events display messages, tool invoke, and execution progress. The establishment of a subscription connection, heartbeats, or an HTTP 200 status code does not indicate task completion. Determine task completion based on the actual final state events and the Prompt invoke results.
|
|
3053
|
+
* When resuming after a disconnection, pass the ID of the last consumed remote event as Last-Event-Id. Also, save and pass back the EventEpoch of the same event stream if the server has returned it. When subscribing for the first time without a cursor, omit these two parameters to receive only real-time events after the subscription is established. Explicitly setting Last-Event-Id to 0 attempts to replay from the starting point still in the cache, which does not mean the complete history can be retrieved. Retrieve the complete history by calling LoadAgentSession. Do not generate cursors or epochs yourself, or use local message sequence numbers as replacements.
|
|
3054
|
+
* The event cache is bounded. If you receive a resynchronization prompt such as state_resync_required or the cursor is no longer available, restore the history by calling LoadAgentSession and then re-establish the subscription. LoadAgentSession is used for refreshing and exception recovery, and should not be called repeatedly to replace real-time event subscriptions. If the Prompt stream times out or disconnects before receiving the business final state, the result of the current turn is unknown, and you can continue to observe the progress through the Events stream. Avoid automatically resending the Prompt. Closing the Events subscription does not trigger CancelAgentSession.
|
|
3055
|
+
* Servers that support epoch information return eventEpoch in the data of the stream_open control frame and provide a mapping between the business sessionId and nativeSessionId. Save the identifiers returned by the server. Do not assume that the business session ID is the same as the native session ID. The cursor and eventEpoch must come from the same event stream epoch of the same native session, and cannot be reused across native sessions or epochs. Do not advance the cursor when the control frame does not have an ID.
|
|
3056
|
+
*
|
|
3057
|
+
* @param request - GetAgentSessionEventsRequest
|
|
3058
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
3059
|
+
* @returns GetAgentSessionEventsResponse
|
|
3060
|
+
*/
|
|
3061
|
+
getAgentSessionEventsWithOptions(request: $_model.GetAgentSessionEventsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetAgentSessionEventsResponse>;
|
|
3062
|
+
/**
|
|
3063
|
+
* Subscribes to real-time Server-Sent Events (SSE) for a specified agent session independently, with support for resumption using a remote cursor. This API operation is available only when the canary release feature is enabled. Before calling this operation, ensure that the corresponding canary release is enabled for your account and the target region.
|
|
3064
|
+
*
|
|
3065
|
+
* @remarks
|
|
3066
|
+
* This API operation is available only when the canary release feature is enabled. Before calling this operation, ensure that the corresponding canary release is enabled for your account and the target region.
|
|
3067
|
+
* This API operation provides a read-only SSE subscription and does not submit questions. Use a GET request and maintain streaming reads. Do not read the response as a standard JSON object at once. For long-running tasks that may exceed the timeout of a single request, establish an independent event subscription before calling PromptAgentSession. After creating a session, set SessionCode to the SessionId and read both streams in parallel. The Events stream displays real-time progress, while the built-in SSE of the Prompt stream is used to read the final state and business errors of the current turn.
|
|
3068
|
+
* Events display messages, tool invoke, and execution progress. The establishment of a subscription connection, heartbeats, or an HTTP 200 status code does not indicate task completion. Determine task completion based on the actual final state events and the Prompt invoke results.
|
|
3069
|
+
* When resuming after a disconnection, pass the ID of the last consumed remote event as Last-Event-Id. Also, save and pass back the EventEpoch of the same event stream if the server has returned it. When subscribing for the first time without a cursor, omit these two parameters to receive only real-time events after the subscription is established. Explicitly setting Last-Event-Id to 0 attempts to replay from the starting point still in the cache, which does not mean the complete history can be retrieved. Retrieve the complete history by calling LoadAgentSession. Do not generate cursors or epochs yourself, or use local message sequence numbers as replacements.
|
|
3070
|
+
* The event cache is bounded. If you receive a resynchronization prompt such as state_resync_required or the cursor is no longer available, restore the history by calling LoadAgentSession and then re-establish the subscription. LoadAgentSession is used for refreshing and exception recovery, and should not be called repeatedly to replace real-time event subscriptions. If the Prompt stream times out or disconnects before receiving the business final state, the result of the current turn is unknown, and you can continue to observe the progress through the Events stream. Avoid automatically resending the Prompt. Closing the Events subscription does not trigger CancelAgentSession.
|
|
3071
|
+
* Servers that support epoch information return eventEpoch in the data of the stream_open control frame and provide a mapping between the business sessionId and nativeSessionId. Save the identifiers returned by the server. Do not assume that the business session ID is the same as the native session ID. The cursor and eventEpoch must come from the same event stream epoch of the same native session, and cannot be reused across native sessions or epochs. Do not advance the cursor when the control frame does not have an ID.
|
|
3072
|
+
*
|
|
3073
|
+
* @param request - GetAgentSessionEventsRequest
|
|
3074
|
+
* @returns GetAgentSessionEventsResponse
|
|
3075
|
+
*/
|
|
3076
|
+
getAgentSessionEvents(request: $_model.GetAgentSessionEventsRequest): Promise<$_model.GetAgentSessionEventsResponse>;
|
|
2963
3077
|
/**
|
|
2964
3078
|
* Retrieves the cumulative AI token usage for a specified session.
|
|
2965
3079
|
*
|
|
@@ -2999,14 +3113,13 @@ export default class Client extends OpenApi {
|
|
|
2999
3113
|
*/
|
|
3000
3114
|
getAlertRule(request: $_model.GetAlertRuleRequest): Promise<$_model.GetAlertRuleResponse>;
|
|
3001
3115
|
/**
|
|
3002
|
-
*
|
|
3116
|
+
* Retrieves the details of a resource access request for the specified process instance ID.
|
|
3003
3117
|
*
|
|
3004
3118
|
* @remarks
|
|
3005
|
-
* ## Request
|
|
3006
|
-
* -
|
|
3007
|
-
* -
|
|
3008
|
-
* -
|
|
3009
|
-
* - Each application content includes detailed resource information, the grantee, the requested operation permissions, and more.
|
|
3119
|
+
* ## Request description
|
|
3120
|
+
* - Specify a valid `ProcessInstanceId` to retrieve the corresponding resource access request.
|
|
3121
|
+
* - The response includes the basic details and status of the request, along with its items.
|
|
3122
|
+
* - Each item includes information about the resource, the grantee, and the requested operation permissions.
|
|
3010
3123
|
*
|
|
3011
3124
|
* @param request - GetApplicationContentsRequest
|
|
3012
3125
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3014,14 +3127,13 @@ export default class Client extends OpenApi {
|
|
|
3014
3127
|
*/
|
|
3015
3128
|
getApplicationContentsWithOptions(request: $_model.GetApplicationContentsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetApplicationContentsResponse>;
|
|
3016
3129
|
/**
|
|
3017
|
-
*
|
|
3130
|
+
* Retrieves the details of a resource access request for the specified process instance ID.
|
|
3018
3131
|
*
|
|
3019
3132
|
* @remarks
|
|
3020
|
-
* ## Request
|
|
3021
|
-
* -
|
|
3022
|
-
* -
|
|
3023
|
-
* -
|
|
3024
|
-
* - Each application content includes detailed resource information, the grantee, the requested operation permissions, and more.
|
|
3133
|
+
* ## Request description
|
|
3134
|
+
* - Specify a valid `ProcessInstanceId` to retrieve the corresponding resource access request.
|
|
3135
|
+
* - The response includes the basic details and status of the request, along with its items.
|
|
3136
|
+
* - Each item includes information about the resource, the grantee, and the requested operation permissions.
|
|
3025
3137
|
*
|
|
3026
3138
|
* @param request - GetApplicationContentsRequest
|
|
3027
3139
|
* @returns GetApplicationContentsResponse
|
|
@@ -3122,6 +3234,21 @@ export default class Client extends OpenApi {
|
|
|
3122
3234
|
* @returns GetCertificateResponse
|
|
3123
3235
|
*/
|
|
3124
3236
|
getCertificate(request: $_model.GetCertificateRequest): Promise<$_model.GetCertificateResponse>;
|
|
3237
|
+
/**
|
|
3238
|
+
* Retrieves the metadata of a code review.
|
|
3239
|
+
*
|
|
3240
|
+
* @param request - GetCodeReviewRequest
|
|
3241
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
3242
|
+
* @returns GetCodeReviewResponse
|
|
3243
|
+
*/
|
|
3244
|
+
getCodeReviewWithOptions(request: $_model.GetCodeReviewRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetCodeReviewResponse>;
|
|
3245
|
+
/**
|
|
3246
|
+
* Retrieves the metadata of a code review.
|
|
3247
|
+
*
|
|
3248
|
+
* @param request - GetCodeReviewRequest
|
|
3249
|
+
* @returns GetCodeReviewResponse
|
|
3250
|
+
*/
|
|
3251
|
+
getCodeReview(request: $_model.GetCodeReviewRequest): Promise<$_model.GetCodeReviewResponse>;
|
|
3125
3252
|
/**
|
|
3126
3253
|
* Retrieves the details of a specified column in a Data Map table.
|
|
3127
3254
|
*
|
|
@@ -3221,11 +3348,11 @@ export default class Client extends OpenApi {
|
|
|
3221
3348
|
* ## Scenarios
|
|
3222
3349
|
* Queries the configuration, availability status, and latest run information of a specified metadata crawler.
|
|
3223
3350
|
* ## Recommended workflow
|
|
3224
|
-
* 1. Call
|
|
3225
|
-
* 2. Call this operation to
|
|
3226
|
-
* 3. To query the complete run history, call
|
|
3351
|
+
* 1. Call ListCrawlers to query the crawler ID.
|
|
3352
|
+
* 2. Call this operation to obtain the crawler details.
|
|
3353
|
+
* 3. To query the complete run history, call ListCrawlerRuns.
|
|
3227
3354
|
* ## Edition requirements
|
|
3228
|
-
* DataWorks Basic Edition or
|
|
3355
|
+
* You must purchase DataWorks Basic Edition or a more advanced edition to use this operation.
|
|
3229
3356
|
* ## Precautions
|
|
3230
3357
|
* If the crawler has not been run, the latest run status and task instance ID may be empty.
|
|
3231
3358
|
*
|
|
@@ -3241,11 +3368,11 @@ export default class Client extends OpenApi {
|
|
|
3241
3368
|
* ## Scenarios
|
|
3242
3369
|
* Queries the configuration, availability status, and latest run information of a specified metadata crawler.
|
|
3243
3370
|
* ## Recommended workflow
|
|
3244
|
-
* 1. Call
|
|
3245
|
-
* 2. Call this operation to
|
|
3246
|
-
* 3. To query the complete run history, call
|
|
3371
|
+
* 1. Call ListCrawlers to query the crawler ID.
|
|
3372
|
+
* 2. Call this operation to obtain the crawler details.
|
|
3373
|
+
* 3. To query the complete run history, call ListCrawlerRuns.
|
|
3247
3374
|
* ## Edition requirements
|
|
3248
|
-
* DataWorks Basic Edition or
|
|
3375
|
+
* You must purchase DataWorks Basic Edition or a more advanced edition to use this operation.
|
|
3249
3376
|
* ## Precautions
|
|
3250
3377
|
* If the crawler has not been run, the latest run status and task instance ID may be empty.
|
|
3251
3378
|
*
|
|
@@ -3526,10 +3653,10 @@ export default class Client extends OpenApi {
|
|
|
3526
3653
|
*/
|
|
3527
3654
|
getDataQualityScan(request: $_model.GetDataQualityScanRequest): Promise<$_model.GetDataQualityScanResponse>;
|
|
3528
3655
|
/**
|
|
3529
|
-
*
|
|
3656
|
+
* Creates a data quality monitoring run instance.
|
|
3530
3657
|
*
|
|
3531
3658
|
* @remarks
|
|
3532
|
-
* DataWorks Basic Edition or
|
|
3659
|
+
* DataWorks Basic Edition or higher is required.
|
|
3533
3660
|
*
|
|
3534
3661
|
* @param request - GetDataQualityScanRunRequest
|
|
3535
3662
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3537,10 +3664,10 @@ export default class Client extends OpenApi {
|
|
|
3537
3664
|
*/
|
|
3538
3665
|
getDataQualityScanRunWithOptions(request: $_model.GetDataQualityScanRunRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetDataQualityScanRunResponse>;
|
|
3539
3666
|
/**
|
|
3540
|
-
*
|
|
3667
|
+
* Creates a data quality monitoring run instance.
|
|
3541
3668
|
*
|
|
3542
3669
|
* @remarks
|
|
3543
|
-
* DataWorks Basic Edition or
|
|
3670
|
+
* DataWorks Basic Edition or higher is required.
|
|
3544
3671
|
*
|
|
3545
3672
|
* @param request - GetDataQualityScanRunRequest
|
|
3546
3673
|
* @returns GetDataQualityScanRunResponse
|
|
@@ -3778,11 +3905,11 @@ export default class Client extends OpenApi {
|
|
|
3778
3905
|
*/
|
|
3779
3906
|
getImage(request: $_model.GetImageRequest): Promise<$_model.GetImageResponse>;
|
|
3780
3907
|
/**
|
|
3781
|
-
* Retrieves the details of
|
|
3908
|
+
* Retrieves the details of the image test result.
|
|
3782
3909
|
*
|
|
3783
3910
|
* @remarks
|
|
3784
|
-
* 1. DataWorks Basic Edition or
|
|
3785
|
-
* 2. **
|
|
3911
|
+
* 1. DataWorks Basic Edition or higher is required.
|
|
3912
|
+
* 2. **Ensure that the service-linked role AliyunServiceRoleForDataWorks is created before you call this API operation.**
|
|
3786
3913
|
*
|
|
3787
3914
|
* @param request - GetImageTestResultRequest
|
|
3788
3915
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3790,11 +3917,11 @@ export default class Client extends OpenApi {
|
|
|
3790
3917
|
*/
|
|
3791
3918
|
getImageTestResultWithOptions(request: $_model.GetImageTestResultRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetImageTestResultResponse>;
|
|
3792
3919
|
/**
|
|
3793
|
-
* Retrieves the details of
|
|
3920
|
+
* Retrieves the details of the image test result.
|
|
3794
3921
|
*
|
|
3795
3922
|
* @remarks
|
|
3796
|
-
* 1. DataWorks Basic Edition or
|
|
3797
|
-
* 2. **
|
|
3923
|
+
* 1. DataWorks Basic Edition or higher is required.
|
|
3924
|
+
* 2. **Ensure that the service-linked role AliyunServiceRoleForDataWorks is created before you call this API operation.**
|
|
3798
3925
|
*
|
|
3799
3926
|
* @param request - GetImageTestResultRequest
|
|
3800
3927
|
* @returns GetImageTestResultResponse
|
|
@@ -3815,6 +3942,48 @@ export default class Client extends OpenApi {
|
|
|
3815
3942
|
* @returns GetJobStatusResponse
|
|
3816
3943
|
*/
|
|
3817
3944
|
getJobStatus(request: $_model.GetJobStatusRequest): Promise<$_model.GetJobStatusResponse>;
|
|
3945
|
+
/**
|
|
3946
|
+
* Retrieves information about a specified knowledge base and the current caller’s access role.
|
|
3947
|
+
*
|
|
3948
|
+
* @remarks
|
|
3949
|
+
* Retrieves a knowledge base. The tenant and caller identities are determined by the POP authentication context.
|
|
3950
|
+
*
|
|
3951
|
+
* @param request - GetKnowledgeBaseRequest
|
|
3952
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
3953
|
+
* @returns GetKnowledgeBaseResponse
|
|
3954
|
+
*/
|
|
3955
|
+
getKnowledgeBaseWithOptions(request: $_model.GetKnowledgeBaseRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetKnowledgeBaseResponse>;
|
|
3956
|
+
/**
|
|
3957
|
+
* Retrieves information about a specified knowledge base and the current caller’s access role.
|
|
3958
|
+
*
|
|
3959
|
+
* @remarks
|
|
3960
|
+
* Retrieves a knowledge base. The tenant and caller identities are determined by the POP authentication context.
|
|
3961
|
+
*
|
|
3962
|
+
* @param request - GetKnowledgeBaseRequest
|
|
3963
|
+
* @returns GetKnowledgeBaseResponse
|
|
3964
|
+
*/
|
|
3965
|
+
getKnowledgeBase(request: $_model.GetKnowledgeBaseRequest): Promise<$_model.GetKnowledgeBaseResponse>;
|
|
3966
|
+
/**
|
|
3967
|
+
* Retrieves the current details of a single knowledge point, supporting local graphs, topic pages, and knowledge content.
|
|
3968
|
+
*
|
|
3969
|
+
* @remarks
|
|
3970
|
+
* Retrieves the current details of a knowledge point. GRAPH returns a one-hop local graph centered on the specified node. WIKI and KNOWLEDGE_CONTENT return readable content.
|
|
3971
|
+
*
|
|
3972
|
+
* @param request - GetKnowledgePointRequest
|
|
3973
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
3974
|
+
* @returns GetKnowledgePointResponse
|
|
3975
|
+
*/
|
|
3976
|
+
getKnowledgePointWithOptions(request: $_model.GetKnowledgePointRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetKnowledgePointResponse>;
|
|
3977
|
+
/**
|
|
3978
|
+
* Retrieves the current details of a single knowledge point, supporting local graphs, topic pages, and knowledge content.
|
|
3979
|
+
*
|
|
3980
|
+
* @remarks
|
|
3981
|
+
* Retrieves the current details of a knowledge point. GRAPH returns a one-hop local graph centered on the specified node. WIKI and KNOWLEDGE_CONTENT return readable content.
|
|
3982
|
+
*
|
|
3983
|
+
* @param request - GetKnowledgePointRequest
|
|
3984
|
+
* @returns GetKnowledgePointResponse
|
|
3985
|
+
*/
|
|
3986
|
+
getKnowledgePoint(request: $_model.GetKnowledgePointRequest): Promise<$_model.GetKnowledgePointResponse>;
|
|
3818
3987
|
/**
|
|
3819
3988
|
* Retrieves the details of a specified lineage relationship in DataWorks Data Map.
|
|
3820
3989
|
*
|
|
@@ -4018,14 +4187,14 @@ export default class Client extends OpenApi {
|
|
|
4018
4187
|
*/
|
|
4019
4188
|
getPipelineRun(request: $_model.GetPipelineRunRequest): Promise<$_model.GetPipelineRunResponse>;
|
|
4020
4189
|
/**
|
|
4021
|
-
* Retrieves the approval policy
|
|
4190
|
+
* Retrieves the details of an approval policy based on the specified process definition ID.
|
|
4022
4191
|
*
|
|
4023
4192
|
* @remarks
|
|
4024
|
-
* ## Request
|
|
4025
|
-
* - This
|
|
4026
|
-
* -
|
|
4027
|
-
* - The
|
|
4028
|
-
* -
|
|
4193
|
+
* ## Request description
|
|
4194
|
+
* - This operation queries all information about a specific approval process definition by using the specified `Id` parameter.
|
|
4195
|
+
* - `Id` is required and must be a valid process definition ID.
|
|
4196
|
+
* - The returned information includes but is not limited to the basic attributes, rule conditions, notification service configurations, and approval nodes of the process definition.
|
|
4197
|
+
* - If the request is successful, the data containing the complete process definition object is returned. If the request fails, the corresponding error code and message are provided to help troubleshoot the issue.
|
|
4029
4198
|
*
|
|
4030
4199
|
* @param request - GetProcessDefinitionRequest
|
|
4031
4200
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4033,14 +4202,14 @@ export default class Client extends OpenApi {
|
|
|
4033
4202
|
*/
|
|
4034
4203
|
getProcessDefinitionWithOptions(request: $_model.GetProcessDefinitionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetProcessDefinitionResponse>;
|
|
4035
4204
|
/**
|
|
4036
|
-
* Retrieves the approval policy
|
|
4205
|
+
* Retrieves the details of an approval policy based on the specified process definition ID.
|
|
4037
4206
|
*
|
|
4038
4207
|
* @remarks
|
|
4039
|
-
* ## Request
|
|
4040
|
-
* - This
|
|
4041
|
-
* -
|
|
4042
|
-
* - The
|
|
4043
|
-
* -
|
|
4208
|
+
* ## Request description
|
|
4209
|
+
* - This operation queries all information about a specific approval process definition by using the specified `Id` parameter.
|
|
4210
|
+
* - `Id` is required and must be a valid process definition ID.
|
|
4211
|
+
* - The returned information includes but is not limited to the basic attributes, rule conditions, notification service configurations, and approval nodes of the process definition.
|
|
4212
|
+
* - If the request is successful, the data containing the complete process definition object is returned. If the request fails, the corresponding error code and message are provided to help troubleshoot the issue.
|
|
4044
4213
|
*
|
|
4045
4214
|
* @param request - GetProcessDefinitionRequest
|
|
4046
4215
|
* @returns GetProcessDefinitionResponse
|
|
@@ -4498,7 +4667,7 @@ export default class Client extends OpenApi {
|
|
|
4498
4667
|
* Retrieves the details of a specified workflow.
|
|
4499
4668
|
*
|
|
4500
4669
|
* @remarks
|
|
4501
|
-
*
|
|
4670
|
+
* DataWorks Basic Edition or higher is required to use this feature.
|
|
4502
4671
|
*
|
|
4503
4672
|
* @param request - GetWorkflowRequest
|
|
4504
4673
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4509,7 +4678,7 @@ export default class Client extends OpenApi {
|
|
|
4509
4678
|
* Retrieves the details of a specified workflow.
|
|
4510
4679
|
*
|
|
4511
4680
|
* @remarks
|
|
4512
|
-
*
|
|
4681
|
+
* DataWorks Basic Edition or higher is required to use this feature.
|
|
4513
4682
|
*
|
|
4514
4683
|
* @param request - GetWorkflowRequest
|
|
4515
4684
|
* @returns GetWorkflowResponse
|
|
@@ -4687,12 +4856,11 @@ export default class Client extends OpenApi {
|
|
|
4687
4856
|
* Retrieves the conversation history list of agent sessions.
|
|
4688
4857
|
*
|
|
4689
4858
|
* @remarks
|
|
4690
|
-
* ## Request
|
|
4691
|
-
* - You must specify at least one of
|
|
4692
|
-
* -
|
|
4693
|
-
* - The
|
|
4694
|
-
* -
|
|
4695
|
-
* - By default, 50 records are returned per page. You can adjust this by using the maxResults parameter.
|
|
4859
|
+
* ## Request instructions
|
|
4860
|
+
* - You must specify at least one of `Params.AgentName` and `Params.SessionSourceList`. You can also filter sessions by `Params.TagList`, `Params.SessionId`, and `Params.SessionTitle`.
|
|
4861
|
+
* - If `Params.Archived` is set to `true`, only archived sessions are queried. If it is set to `false` or omitted, only unarchived sessions are queried. To query both types of sessions, send separate requests and handle the pagination for each.
|
|
4862
|
+
* - The session list is located in `JsonRpcResponse.Result.AgentSessions`. The pagination information is located in `TotalCount`, `MaxResults`, and `NextToken` under the same `Result`.
|
|
4863
|
+
* - The default value of `Params.MaxResults` is 50. For the first page, you can pass `Params.NextToken=1`. For subsequent pages, pass the `NextToken` value from the response as is.
|
|
4696
4864
|
*
|
|
4697
4865
|
* @param tmpReq - ListAgentSessionsRequest
|
|
4698
4866
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4703,12 +4871,11 @@ export default class Client extends OpenApi {
|
|
|
4703
4871
|
* Retrieves the conversation history list of agent sessions.
|
|
4704
4872
|
*
|
|
4705
4873
|
* @remarks
|
|
4706
|
-
* ## Request
|
|
4707
|
-
* - You must specify at least one of
|
|
4708
|
-
* -
|
|
4709
|
-
* - The
|
|
4710
|
-
* -
|
|
4711
|
-
* - By default, 50 records are returned per page. You can adjust this by using the maxResults parameter.
|
|
4874
|
+
* ## Request instructions
|
|
4875
|
+
* - You must specify at least one of `Params.AgentName` and `Params.SessionSourceList`. You can also filter sessions by `Params.TagList`, `Params.SessionId`, and `Params.SessionTitle`.
|
|
4876
|
+
* - If `Params.Archived` is set to `true`, only archived sessions are queried. If it is set to `false` or omitted, only unarchived sessions are queried. To query both types of sessions, send separate requests and handle the pagination for each.
|
|
4877
|
+
* - The session list is located in `JsonRpcResponse.Result.AgentSessions`. The pagination information is located in `TotalCount`, `MaxResults`, and `NextToken` under the same `Result`.
|
|
4878
|
+
* - The default value of `Params.MaxResults` is 50. For the first page, you can pass `Params.NextToken=1`. For subsequent pages, pass the `NextToken` value from the response as is.
|
|
4712
4879
|
*
|
|
4713
4880
|
* @param request - ListAgentSessionsRequest
|
|
4714
4881
|
* @returns ListAgentSessionsResponse
|
|
@@ -4855,6 +5022,21 @@ export default class Client extends OpenApi {
|
|
|
4855
5022
|
* @returns ListCertificatesResponse
|
|
4856
5023
|
*/
|
|
4857
5024
|
listCertificates(request: $_model.ListCertificatesRequest): Promise<$_model.ListCertificatesResponse>;
|
|
5025
|
+
/**
|
|
5026
|
+
* Performs a paging query of code reviews.
|
|
5027
|
+
*
|
|
5028
|
+
* @param request - ListCodeReviewsRequest
|
|
5029
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
5030
|
+
* @returns ListCodeReviewsResponse
|
|
5031
|
+
*/
|
|
5032
|
+
listCodeReviewsWithOptions(request: $_model.ListCodeReviewsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListCodeReviewsResponse>;
|
|
5033
|
+
/**
|
|
5034
|
+
* Performs a paging query of code reviews.
|
|
5035
|
+
*
|
|
5036
|
+
* @param request - ListCodeReviewsRequest
|
|
5037
|
+
* @returns ListCodeReviewsResponse
|
|
5038
|
+
*/
|
|
5039
|
+
listCodeReviews(request: $_model.ListCodeReviewsRequest): Promise<$_model.ListCodeReviewsResponse>;
|
|
4858
5040
|
/**
|
|
4859
5041
|
* Queries the columns of a specified table in DataWorks Data Map.
|
|
4860
5042
|
*
|
|
@@ -5015,7 +5197,7 @@ export default class Client extends OpenApi {
|
|
|
5015
5197
|
*/
|
|
5016
5198
|
listCrawlers(request: $_model.ListCrawlersRequest): Promise<$_model.ListCrawlersResponse>;
|
|
5017
5199
|
/**
|
|
5018
|
-
* Queries cross-workspace deployment
|
|
5200
|
+
* Queries cross-workspace deployment candidates.
|
|
5019
5201
|
*
|
|
5020
5202
|
* @param request - ListCrossProjectDeploymentCandidatesRequest
|
|
5021
5203
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5023,7 +5205,7 @@ export default class Client extends OpenApi {
|
|
|
5023
5205
|
*/
|
|
5024
5206
|
listCrossProjectDeploymentCandidatesWithOptions(request: $_model.ListCrossProjectDeploymentCandidatesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListCrossProjectDeploymentCandidatesResponse>;
|
|
5025
5207
|
/**
|
|
5026
|
-
* Queries cross-workspace deployment
|
|
5208
|
+
* Queries cross-workspace deployment candidates.
|
|
5027
5209
|
*
|
|
5028
5210
|
* @param request - ListCrossProjectDeploymentCandidatesRequest
|
|
5029
5211
|
* @returns ListCrossProjectDeploymentCandidatesResponse
|
|
@@ -5045,7 +5227,7 @@ export default class Client extends OpenApi {
|
|
|
5045
5227
|
*/
|
|
5046
5228
|
listCrossProjectDeploymentEnvironments(request: $_model.ListCrossProjectDeploymentEnvironmentsRequest): Promise<$_model.ListCrossProjectDeploymentEnvironmentsResponse>;
|
|
5047
5229
|
/**
|
|
5048
|
-
* Queries the
|
|
5230
|
+
* Queries the deployment items of a cross-workspace deployment pipeline.
|
|
5049
5231
|
*
|
|
5050
5232
|
* @param request - ListCrossProjectPipelineRunItemsRequest
|
|
5051
5233
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5053,7 +5235,7 @@ export default class Client extends OpenApi {
|
|
|
5053
5235
|
*/
|
|
5054
5236
|
listCrossProjectPipelineRunItemsWithOptions(request: $_model.ListCrossProjectPipelineRunItemsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListCrossProjectPipelineRunItemsResponse>;
|
|
5055
5237
|
/**
|
|
5056
|
-
* Queries the
|
|
5238
|
+
* Queries the deployment items of a cross-workspace deployment pipeline.
|
|
5057
5239
|
*
|
|
5058
5240
|
* @param request - ListCrossProjectPipelineRunItemsRequest
|
|
5059
5241
|
* @returns ListCrossProjectPipelineRunItemsResponse
|
|
@@ -5075,13 +5257,13 @@ export default class Client extends OpenApi {
|
|
|
5075
5257
|
*/
|
|
5076
5258
|
listCrossProjectPipelineRuns(request: $_model.ListCrossProjectPipelineRunsRequest): Promise<$_model.ListCrossProjectPipelineRunsResponse>;
|
|
5077
5259
|
/**
|
|
5078
|
-
*
|
|
5260
|
+
* Returns a paginated list of custom agents.
|
|
5079
5261
|
*
|
|
5080
5262
|
* @remarks
|
|
5081
5263
|
* ## Request description
|
|
5082
|
-
* - **Search keyword**:
|
|
5083
|
-
* - **Visibility level filter**:
|
|
5084
|
-
* - **Paging information**:
|
|
5264
|
+
* - **Search keyword**: You can use the `Q` parameter to perform a fuzzy match by agent name.
|
|
5265
|
+
* - **Visibility level filter**: You can use the `Visibility` parameter to filter results by visibility level, such as `TENANT`, `PROJECT`, or `USER`.
|
|
5266
|
+
* - **Paging information**: You can use the `MaxResults` and `NextToken` parameters to implement a paged query. The `NextToken` parameter is used to retrieve the next page of data.
|
|
5085
5267
|
*
|
|
5086
5268
|
* @param tmpReq - ListCustomAgentsRequest
|
|
5087
5269
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5089,13 +5271,13 @@ export default class Client extends OpenApi {
|
|
|
5089
5271
|
*/
|
|
5090
5272
|
listCustomAgentsWithOptions(tmpReq: $_model.ListCustomAgentsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListCustomAgentsResponse>;
|
|
5091
5273
|
/**
|
|
5092
|
-
*
|
|
5274
|
+
* Returns a paginated list of custom agents.
|
|
5093
5275
|
*
|
|
5094
5276
|
* @remarks
|
|
5095
5277
|
* ## Request description
|
|
5096
|
-
* - **Search keyword**:
|
|
5097
|
-
* - **Visibility level filter**:
|
|
5098
|
-
* - **Paging information**:
|
|
5278
|
+
* - **Search keyword**: You can use the `Q` parameter to perform a fuzzy match by agent name.
|
|
5279
|
+
* - **Visibility level filter**: You can use the `Visibility` parameter to filter results by visibility level, such as `TENANT`, `PROJECT`, or `USER`.
|
|
5280
|
+
* - **Paging information**: You can use the `MaxResults` and `NextToken` parameters to implement a paged query. The `NextToken` parameter is used to retrieve the next page of data.
|
|
5099
5281
|
*
|
|
5100
5282
|
* @param request - ListCustomAgentsRequest
|
|
5101
5283
|
* @returns ListCustomAgentsResponse
|
|
@@ -5225,7 +5407,7 @@ export default class Client extends OpenApi {
|
|
|
5225
5407
|
* Queries a list of tags.
|
|
5226
5408
|
*
|
|
5227
5409
|
* @remarks
|
|
5228
|
-
* DataWorks Enterprise Edition or
|
|
5410
|
+
* You must purchase DataWorks Enterprise Edition or higher to use this operation.
|
|
5229
5411
|
*
|
|
5230
5412
|
* @param request - ListDataAssetTagsRequest
|
|
5231
5413
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5236,7 +5418,7 @@ export default class Client extends OpenApi {
|
|
|
5236
5418
|
* Queries a list of tags.
|
|
5237
5419
|
*
|
|
5238
5420
|
* @remarks
|
|
5239
|
-
* DataWorks Enterprise Edition or
|
|
5421
|
+
* You must purchase DataWorks Enterprise Edition or higher to use this operation.
|
|
5240
5422
|
*
|
|
5241
5423
|
* @param request - ListDataAssetTagsRequest
|
|
5242
5424
|
* @returns ListDataAssetTagsResponse
|
|
@@ -5310,10 +5492,10 @@ export default class Client extends OpenApi {
|
|
|
5310
5492
|
*/
|
|
5311
5493
|
listDataQualityEvaluationTaskInstances(request: $_model.ListDataQualityEvaluationTaskInstancesRequest): Promise<$_model.ListDataQualityEvaluationTaskInstancesResponse>;
|
|
5312
5494
|
/**
|
|
5313
|
-
*
|
|
5495
|
+
* Queries the data quality monitoring task list by page.
|
|
5314
5496
|
*
|
|
5315
5497
|
* @remarks
|
|
5316
|
-
* You must purchase DataWorks Basic Edition or
|
|
5498
|
+
* You must purchase DataWorks Basic Edition or a higher edition to use this API operation.
|
|
5317
5499
|
*
|
|
5318
5500
|
* @deprecated OpenAPI ListDataQualityEvaluationTasks is deprecated, please use dataworks-public::2024-05-18::ListDataQualityScans instead.
|
|
5319
5501
|
*
|
|
@@ -5323,10 +5505,10 @@ export default class Client extends OpenApi {
|
|
|
5323
5505
|
*/
|
|
5324
5506
|
listDataQualityEvaluationTasksWithOptions(request: $_model.ListDataQualityEvaluationTasksRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListDataQualityEvaluationTasksResponse>;
|
|
5325
5507
|
/**
|
|
5326
|
-
*
|
|
5508
|
+
* Queries the data quality monitoring task list by page.
|
|
5327
5509
|
*
|
|
5328
5510
|
* @remarks
|
|
5329
|
-
* You must purchase DataWorks Basic Edition or
|
|
5511
|
+
* You must purchase DataWorks Basic Edition or a higher edition to use this API operation.
|
|
5330
5512
|
*
|
|
5331
5513
|
* @deprecated OpenAPI ListDataQualityEvaluationTasks is deprecated, please use dataworks-public::2024-05-18::ListDataQualityScans instead.
|
|
5332
5514
|
*
|
|
@@ -5335,10 +5517,10 @@ export default class Client extends OpenApi {
|
|
|
5335
5517
|
*/
|
|
5336
5518
|
listDataQualityEvaluationTasks(request: $_model.ListDataQualityEvaluationTasksRequest): Promise<$_model.ListDataQualityEvaluationTasksResponse>;
|
|
5337
5519
|
/**
|
|
5338
|
-
*
|
|
5520
|
+
* Lists data quality check results with pagination.
|
|
5339
5521
|
*
|
|
5340
5522
|
* @remarks
|
|
5341
|
-
*
|
|
5523
|
+
* You must purchase DataWorks Basic Edition or higher to use this API.
|
|
5342
5524
|
*
|
|
5343
5525
|
* @deprecated OpenAPI ListDataQualityResults is deprecated, please use dataworks-public::2024-05-18::ListDataQualityScanRuns instead.
|
|
5344
5526
|
*
|
|
@@ -5348,10 +5530,10 @@ export default class Client extends OpenApi {
|
|
|
5348
5530
|
*/
|
|
5349
5531
|
listDataQualityResultsWithOptions(request: $_model.ListDataQualityResultsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListDataQualityResultsResponse>;
|
|
5350
5532
|
/**
|
|
5351
|
-
*
|
|
5533
|
+
* Lists data quality check results with pagination.
|
|
5352
5534
|
*
|
|
5353
5535
|
* @remarks
|
|
5354
|
-
*
|
|
5536
|
+
* You must purchase DataWorks Basic Edition or higher to use this API.
|
|
5355
5537
|
*
|
|
5356
5538
|
* @deprecated OpenAPI ListDataQualityResults is deprecated, please use dataworks-public::2024-05-18::ListDataQualityScanRuns instead.
|
|
5357
5539
|
*
|
|
@@ -5627,10 +5809,10 @@ export default class Client extends OpenApi {
|
|
|
5627
5809
|
*/
|
|
5628
5810
|
listDownstreamTaskInstances(request: $_model.ListDownstreamTaskInstancesRequest): Promise<$_model.ListDownstreamTaskInstancesResponse>;
|
|
5629
5811
|
/**
|
|
5630
|
-
* Retrieves a paginated list of downstream
|
|
5812
|
+
* Retrieves a paginated list of downstream tasks for a specified task.
|
|
5631
5813
|
*
|
|
5632
5814
|
* @remarks
|
|
5633
|
-
* DataWorks Basic Edition or
|
|
5815
|
+
* You must purchase DataWorks Basic Edition or a higher edition to use this operation.
|
|
5634
5816
|
*
|
|
5635
5817
|
* @param request - ListDownstreamTasksRequest
|
|
5636
5818
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5638,10 +5820,10 @@ export default class Client extends OpenApi {
|
|
|
5638
5820
|
*/
|
|
5639
5821
|
listDownstreamTasksWithOptions(request: $_model.ListDownstreamTasksRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListDownstreamTasksResponse>;
|
|
5640
5822
|
/**
|
|
5641
|
-
* Retrieves a paginated list of downstream
|
|
5823
|
+
* Retrieves a paginated list of downstream tasks for a specified task.
|
|
5642
5824
|
*
|
|
5643
5825
|
* @remarks
|
|
5644
|
-
* DataWorks Basic Edition or
|
|
5826
|
+
* You must purchase DataWorks Basic Edition or a higher edition to use this operation.
|
|
5645
5827
|
*
|
|
5646
5828
|
* @param request - ListDownstreamTasksRequest
|
|
5647
5829
|
* @returns ListDownstreamTasksResponse
|
|
@@ -5820,6 +6002,48 @@ export default class Client extends OpenApi {
|
|
|
5820
6002
|
* @returns ListImagesResponse
|
|
5821
6003
|
*/
|
|
5822
6004
|
listImages(request: $_model.ListImagesRequest): Promise<$_model.ListImagesResponse>;
|
|
6005
|
+
/**
|
|
6006
|
+
* Queries the knowledge bases that the current caller has permission to view in a specified region by using paging.
|
|
6007
|
+
*
|
|
6008
|
+
* @remarks
|
|
6009
|
+
* Lists knowledge bases. The tenant and caller identities are determined by the POP authentication context.
|
|
6010
|
+
*
|
|
6011
|
+
* @param request - ListKnowledgeBasesRequest
|
|
6012
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
6013
|
+
* @returns ListKnowledgeBasesResponse
|
|
6014
|
+
*/
|
|
6015
|
+
listKnowledgeBasesWithOptions(request: $_model.ListKnowledgeBasesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListKnowledgeBasesResponse>;
|
|
6016
|
+
/**
|
|
6017
|
+
* Queries the knowledge bases that the current caller has permission to view in a specified region by using paging.
|
|
6018
|
+
*
|
|
6019
|
+
* @remarks
|
|
6020
|
+
* Lists knowledge bases. The tenant and caller identities are determined by the POP authentication context.
|
|
6021
|
+
*
|
|
6022
|
+
* @param request - ListKnowledgeBasesRequest
|
|
6023
|
+
* @returns ListKnowledgeBasesResponse
|
|
6024
|
+
*/
|
|
6025
|
+
listKnowledgeBases(request: $_model.ListKnowledgeBasesRequest): Promise<$_model.ListKnowledgeBasesResponse>;
|
|
6026
|
+
/**
|
|
6027
|
+
* Lists knowledge points in a knowledge base by type with pagination.
|
|
6028
|
+
*
|
|
6029
|
+
* @remarks
|
|
6030
|
+
* Lists the currently visible knowledge points in a knowledge base in a paginated manner. You can filter the knowledge points by type, such as GRAPH, WIKI, and KNOWLEDGE_CONTENT.
|
|
6031
|
+
*
|
|
6032
|
+
* @param request - ListKnowledgePointsRequest
|
|
6033
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
6034
|
+
* @returns ListKnowledgePointsResponse
|
|
6035
|
+
*/
|
|
6036
|
+
listKnowledgePointsWithOptions(request: $_model.ListKnowledgePointsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListKnowledgePointsResponse>;
|
|
6037
|
+
/**
|
|
6038
|
+
* Lists knowledge points in a knowledge base by type with pagination.
|
|
6039
|
+
*
|
|
6040
|
+
* @remarks
|
|
6041
|
+
* Lists the currently visible knowledge points in a knowledge base in a paginated manner. You can filter the knowledge points by type, such as GRAPH, WIKI, and KNOWLEDGE_CONTENT.
|
|
6042
|
+
*
|
|
6043
|
+
* @param request - ListKnowledgePointsRequest
|
|
6044
|
+
* @returns ListKnowledgePointsResponse
|
|
6045
|
+
*/
|
|
6046
|
+
listKnowledgePoints(request: $_model.ListKnowledgePointsRequest): Promise<$_model.ListKnowledgePointsResponse>;
|
|
5823
6047
|
/**
|
|
5824
6048
|
* Queries the list of data lineage relationships between two given entities (such as tables, fields, or OSS files) in DataWorks Data Map.
|
|
5825
6049
|
*
|
|
@@ -5947,16 +6171,16 @@ export default class Client extends OpenApi {
|
|
|
5947
6171
|
*/
|
|
5948
6172
|
listMetaEntityDefs(request: $_model.ListMetaEntityDefsRequest): Promise<$_model.ListMetaEntityDefsResponse>;
|
|
5949
6173
|
/**
|
|
5950
|
-
*
|
|
6174
|
+
* Lists all requests for resource access permissions submitted by the current user.
|
|
5951
6175
|
*
|
|
5952
6176
|
* @remarks
|
|
5953
6177
|
* ## Request description
|
|
5954
|
-
* -
|
|
5955
|
-
* - `DefSchema` is
|
|
5956
|
-
* -
|
|
5957
|
-
* -
|
|
5958
|
-
* - `Statuses`
|
|
5959
|
-
* -
|
|
6178
|
+
* - Use `NextToken` and `PageSize` to paginate the results.
|
|
6179
|
+
* - `DefSchema` is required and specifies the resource type.
|
|
6180
|
+
* - Specify multiple resource types in `ResourceType` to narrow the results.
|
|
6181
|
+
* - Use `StartTime` and `EndTime` to restrict the query to a time range.
|
|
6182
|
+
* - Use `Statuses` to filter requests by status, such as pending approval or authorization succeeded.
|
|
6183
|
+
* - To filter by specific resources or grantees, specify the details in `Resource` and `Grantee`.
|
|
5960
6184
|
*
|
|
5961
6185
|
* @param tmpReq - ListMyApplicationsRequest
|
|
5962
6186
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5964,31 +6188,31 @@ export default class Client extends OpenApi {
|
|
|
5964
6188
|
*/
|
|
5965
6189
|
listMyApplicationsWithOptions(tmpReq: $_model.ListMyApplicationsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListMyApplicationsResponse>;
|
|
5966
6190
|
/**
|
|
5967
|
-
*
|
|
6191
|
+
* Lists all requests for resource access permissions submitted by the current user.
|
|
5968
6192
|
*
|
|
5969
6193
|
* @remarks
|
|
5970
6194
|
* ## Request description
|
|
5971
|
-
* -
|
|
5972
|
-
* - `DefSchema` is
|
|
5973
|
-
* -
|
|
5974
|
-
* -
|
|
5975
|
-
* - `Statuses`
|
|
5976
|
-
* -
|
|
6195
|
+
* - Use `NextToken` and `PageSize` to paginate the results.
|
|
6196
|
+
* - `DefSchema` is required and specifies the resource type.
|
|
6197
|
+
* - Specify multiple resource types in `ResourceType` to narrow the results.
|
|
6198
|
+
* - Use `StartTime` and `EndTime` to restrict the query to a time range.
|
|
6199
|
+
* - Use `Statuses` to filter requests by status, such as pending approval or authorization succeeded.
|
|
6200
|
+
* - To filter by specific resources or grantees, specify the details in `Resource` and `Grantee`.
|
|
5977
6201
|
*
|
|
5978
6202
|
* @param request - ListMyApplicationsRequest
|
|
5979
6203
|
* @returns ListMyApplicationsResponse
|
|
5980
6204
|
*/
|
|
5981
6205
|
listMyApplications(request: $_model.ListMyApplicationsRequest): Promise<$_model.ListMyApplicationsResponse>;
|
|
5982
6206
|
/**
|
|
5983
|
-
*
|
|
6207
|
+
* Lists all permission requests for which the current user is an approver or a related party.
|
|
5984
6208
|
*
|
|
5985
6209
|
* @remarks
|
|
5986
|
-
* ## Request
|
|
5987
|
-
* - This
|
|
5988
|
-
* -
|
|
5989
|
-
* -
|
|
5990
|
-
* - `PageSize` defaults to 10
|
|
5991
|
-
* - `DefSchema` and `ResourceType` are required
|
|
6210
|
+
* ## Request description
|
|
6211
|
+
* - This operation lists permission requests for which the current user is an approver, including requests pending approval and requests that have already been reviewed.
|
|
6212
|
+
* - Use `Statuses` to filter requests by status.
|
|
6213
|
+
* - For the first page, omit `NextToken` or set it to `null`. For subsequent pages, pass the `NextToken` value returned in the previous response.
|
|
6214
|
+
* - `PageSize` defaults to 10 and supports a maximum of 200.
|
|
6215
|
+
* - `DefSchema` and `ResourceType` are required. Other parameters are optional.
|
|
5992
6216
|
*
|
|
5993
6217
|
* @param tmpReq - ListMyRelatedApprovalsRequest
|
|
5994
6218
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5996,15 +6220,15 @@ export default class Client extends OpenApi {
|
|
|
5996
6220
|
*/
|
|
5997
6221
|
listMyRelatedApprovalsWithOptions(tmpReq: $_model.ListMyRelatedApprovalsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListMyRelatedApprovalsResponse>;
|
|
5998
6222
|
/**
|
|
5999
|
-
*
|
|
6223
|
+
* Lists all permission requests for which the current user is an approver or a related party.
|
|
6000
6224
|
*
|
|
6001
6225
|
* @remarks
|
|
6002
|
-
* ## Request
|
|
6003
|
-
* - This
|
|
6004
|
-
* -
|
|
6005
|
-
* -
|
|
6006
|
-
* - `PageSize` defaults to 10
|
|
6007
|
-
* - `DefSchema` and `ResourceType` are required
|
|
6226
|
+
* ## Request description
|
|
6227
|
+
* - This operation lists permission requests for which the current user is an approver, including requests pending approval and requests that have already been reviewed.
|
|
6228
|
+
* - Use `Statuses` to filter requests by status.
|
|
6229
|
+
* - For the first page, omit `NextToken` or set it to `null`. For subsequent pages, pass the `NextToken` value returned in the previous response.
|
|
6230
|
+
* - `PageSize` defaults to 10 and supports a maximum of 200.
|
|
6231
|
+
* - `DefSchema` and `ResourceType` are required. Other parameters are optional.
|
|
6008
6232
|
*
|
|
6009
6233
|
* @param request - ListMyRelatedApprovalsRequest
|
|
6010
6234
|
* @returns ListMyRelatedApprovalsResponse
|
|
@@ -6104,12 +6328,12 @@ export default class Client extends OpenApi {
|
|
|
6104
6328
|
*/
|
|
6105
6329
|
listParameters(request: $_model.ListParametersRequest): Promise<$_model.ListParametersResponse>;
|
|
6106
6330
|
/**
|
|
6107
|
-
* Queries the
|
|
6331
|
+
* Queries the partitions of a specified table in DataWorks Data Map. MaxCompute and HMS (EMR cluster) tables are supported.
|
|
6108
6332
|
*
|
|
6109
6333
|
* @remarks
|
|
6110
|
-
* 1.
|
|
6111
|
-
* 2.
|
|
6112
|
-
* 3. Before
|
|
6334
|
+
* 1. DataWorks Basic Edition or a higher edition is required.
|
|
6335
|
+
* 2. Currently, only MaxCompute and HMS (EMR cluster) tables are supported.
|
|
6336
|
+
* 3. Before you call this API operation, call ListCrawlers to obtain the MetaEntityId of the metadata crawler, and then call ListDatabases to obtain the database ID. For MaxCompute projects with the schema feature enabled, call ListSchemas to obtain the schema ID. Then, call ListTables to obtain the TableId, and pass the returned table ID to this API operation.
|
|
6113
6337
|
*
|
|
6114
6338
|
* @param request - ListPartitionsRequest
|
|
6115
6339
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -6117,39 +6341,39 @@ export default class Client extends OpenApi {
|
|
|
6117
6341
|
*/
|
|
6118
6342
|
listPartitionsWithOptions(request: $_model.ListPartitionsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListPartitionsResponse>;
|
|
6119
6343
|
/**
|
|
6120
|
-
* Queries the
|
|
6344
|
+
* Queries the partitions of a specified table in DataWorks Data Map. MaxCompute and HMS (EMR cluster) tables are supported.
|
|
6121
6345
|
*
|
|
6122
6346
|
* @remarks
|
|
6123
|
-
* 1.
|
|
6124
|
-
* 2.
|
|
6125
|
-
* 3. Before
|
|
6347
|
+
* 1. DataWorks Basic Edition or a higher edition is required.
|
|
6348
|
+
* 2. Currently, only MaxCompute and HMS (EMR cluster) tables are supported.
|
|
6349
|
+
* 3. Before you call this API operation, call ListCrawlers to obtain the MetaEntityId of the metadata crawler, and then call ListDatabases to obtain the database ID. For MaxCompute projects with the schema feature enabled, call ListSchemas to obtain the schema ID. Then, call ListTables to obtain the TableId, and pass the returned table ID to this API operation.
|
|
6126
6350
|
*
|
|
6127
6351
|
* @param request - ListPartitionsRequest
|
|
6128
6352
|
* @returns ListPartitionsResponse
|
|
6129
6353
|
*/
|
|
6130
6354
|
listPartitions(request: $_model.ListPartitionsRequest): Promise<$_model.ListPartitionsResponse>;
|
|
6131
6355
|
/**
|
|
6132
|
-
*
|
|
6356
|
+
* Queries the pending permission requests for which the current user is the approver.
|
|
6133
6357
|
*
|
|
6134
6358
|
* @remarks
|
|
6135
|
-
* ## Request
|
|
6136
|
-
* This
|
|
6137
|
-
* - **ResourceType**:
|
|
6138
|
-
* - **Resource**:
|
|
6139
|
-
* - **StartTime and EndTime**:
|
|
6140
|
-
* - **Statuses**:
|
|
6141
|
-
* - **Grantee**:
|
|
6142
|
-
* - **AccessTypes**:
|
|
6143
|
-
* - **PageSize and NextToken**:
|
|
6144
|
-
*
|
|
6145
|
-
* - If no
|
|
6146
|
-
* - The `NextToken` parameter can be empty or omitted
|
|
6359
|
+
* ## Request description
|
|
6360
|
+
* This operation queries all pending permission requests for which the current logged-on user is the approver. You can filter the applications by using various conditions, such as resource type, time range, and approval status, to accurately locate specific applications.
|
|
6361
|
+
* - **ResourceType**: specifies the resource types, such as tables. Multiple values are supported.
|
|
6362
|
+
* - **Resource**: specifies the exact resource search conditions, such as the project, database, or table name.
|
|
6363
|
+
* - **StartTime and EndTime**: define the time range when the applications were initiated.
|
|
6364
|
+
* - **Statuses**: filters the results by approval status, such as viewing only the pending approval status.
|
|
6365
|
+
* - **Grantee**: filters the applications based on the grantee information.
|
|
6366
|
+
* - **AccessTypes**: filters the applications based on the specific permission types requested, such as read or update.
|
|
6367
|
+
* - **PageSize and NextToken**: are used for pagination control. PageSize specifies the number of entries to return per page, and NextToken specifies the cursor required to retrieve the next page.
|
|
6368
|
+
* Precautions:
|
|
6369
|
+
* - If no filter conditions are provided, all matching records are returned by default.
|
|
6370
|
+
* - The `NextToken` parameter can be left empty or omitted in the first call. For subsequent page requests, you must use the `NextToken` value provided in the previous response.
|
|
6147
6371
|
* - The default value of `PageSize` is 10, and the maximum value is 200. If the specified value exceeds the maximum limit, the maximum value is used.
|
|
6148
|
-
* - When
|
|
6149
|
-
* ## Response
|
|
6150
|
-
* After a successful call
|
|
6151
|
-
* - **Data**:
|
|
6152
|
-
* - **ApplicationQueryResponse**:
|
|
6372
|
+
* - When no more data is available, the `HasMore` field is set to `false`, and `NextToken` is empty or does not exist.
|
|
6373
|
+
* ## Response description
|
|
6374
|
+
* After a successful API call, the response body contains the paginated results and the details of each application, such as the application time, resource description, grantee, and requested permissions. In addition, the status of the approval process and other related metadata are provided.
|
|
6375
|
+
* - **Data**: the paginated result set, which includes information such as the page size (`PageSize`), cursor (`NextToken`), and whether more data is available (`HasMore`).
|
|
6376
|
+
* - **ApplicationQueryResponse**: the specific content of each application, including the application reason, initiation time, status, and the detailed list of application contents.
|
|
6153
6377
|
*
|
|
6154
6378
|
* @param tmpReq - ListPendingApprovalsRequest
|
|
6155
6379
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -6157,27 +6381,27 @@ export default class Client extends OpenApi {
|
|
|
6157
6381
|
*/
|
|
6158
6382
|
listPendingApprovalsWithOptions(tmpReq: $_model.ListPendingApprovalsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListPendingApprovalsResponse>;
|
|
6159
6383
|
/**
|
|
6160
|
-
*
|
|
6384
|
+
* Queries the pending permission requests for which the current user is the approver.
|
|
6161
6385
|
*
|
|
6162
6386
|
* @remarks
|
|
6163
|
-
* ## Request
|
|
6164
|
-
* This
|
|
6165
|
-
* - **ResourceType**:
|
|
6166
|
-
* - **Resource**:
|
|
6167
|
-
* - **StartTime and EndTime**:
|
|
6168
|
-
* - **Statuses**:
|
|
6169
|
-
* - **Grantee**:
|
|
6170
|
-
* - **AccessTypes**:
|
|
6171
|
-
* - **PageSize and NextToken**:
|
|
6172
|
-
*
|
|
6173
|
-
* - If no
|
|
6174
|
-
* - The `NextToken` parameter can be empty or omitted
|
|
6387
|
+
* ## Request description
|
|
6388
|
+
* This operation queries all pending permission requests for which the current logged-on user is the approver. You can filter the applications by using various conditions, such as resource type, time range, and approval status, to accurately locate specific applications.
|
|
6389
|
+
* - **ResourceType**: specifies the resource types, such as tables. Multiple values are supported.
|
|
6390
|
+
* - **Resource**: specifies the exact resource search conditions, such as the project, database, or table name.
|
|
6391
|
+
* - **StartTime and EndTime**: define the time range when the applications were initiated.
|
|
6392
|
+
* - **Statuses**: filters the results by approval status, such as viewing only the pending approval status.
|
|
6393
|
+
* - **Grantee**: filters the applications based on the grantee information.
|
|
6394
|
+
* - **AccessTypes**: filters the applications based on the specific permission types requested, such as read or update.
|
|
6395
|
+
* - **PageSize and NextToken**: are used for pagination control. PageSize specifies the number of entries to return per page, and NextToken specifies the cursor required to retrieve the next page.
|
|
6396
|
+
* Precautions:
|
|
6397
|
+
* - If no filter conditions are provided, all matching records are returned by default.
|
|
6398
|
+
* - The `NextToken` parameter can be left empty or omitted in the first call. For subsequent page requests, you must use the `NextToken` value provided in the previous response.
|
|
6175
6399
|
* - The default value of `PageSize` is 10, and the maximum value is 200. If the specified value exceeds the maximum limit, the maximum value is used.
|
|
6176
|
-
* - When
|
|
6177
|
-
* ## Response
|
|
6178
|
-
* After a successful call
|
|
6179
|
-
* - **Data**:
|
|
6180
|
-
* - **ApplicationQueryResponse**:
|
|
6400
|
+
* - When no more data is available, the `HasMore` field is set to `false`, and `NextToken` is empty or does not exist.
|
|
6401
|
+
* ## Response description
|
|
6402
|
+
* After a successful API call, the response body contains the paginated results and the details of each application, such as the application time, resource description, grantee, and requested permissions. In addition, the status of the approval process and other related metadata are provided.
|
|
6403
|
+
* - **Data**: the paginated result set, which includes information such as the page size (`PageSize`), cursor (`NextToken`), and whether more data is available (`HasMore`).
|
|
6404
|
+
* - **ApplicationQueryResponse**: the specific content of each application, including the application reason, initiation time, status, and the detailed list of application contents.
|
|
6181
6405
|
*
|
|
6182
6406
|
* @param request - ListPendingApprovalsRequest
|
|
6183
6407
|
* @returns ListPendingApprovalsResponse
|
|
@@ -6199,11 +6423,10 @@ export default class Client extends OpenApi {
|
|
|
6199
6423
|
*/
|
|
6200
6424
|
listPipelineRunItems(request: $_model.ListPipelineRunItemsRequest): Promise<$_model.ListPipelineRunItemsResponse>;
|
|
6201
6425
|
/**
|
|
6202
|
-
*
|
|
6426
|
+
* Retrieves a paginated list of deployment pipelines. You can also filter the results.
|
|
6203
6427
|
*
|
|
6204
6428
|
* @remarks
|
|
6205
|
-
* >Notice:
|
|
6206
|
-
* Earlier SDK versions may not include this interface. If so, use the ListDeployments interface. It accepts the same parameters.
|
|
6429
|
+
* >Notice: This operation may not be available in earlier versions of the SDK. In this case, use the ListDeployments operation, which uses the same parameters as described in this document.</notice>
|
|
6207
6430
|
*
|
|
6208
6431
|
* @param request - ListPipelineRunsRequest
|
|
6209
6432
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -6211,11 +6434,10 @@ export default class Client extends OpenApi {
|
|
|
6211
6434
|
*/
|
|
6212
6435
|
listPipelineRunsWithOptions(request: $_model.ListPipelineRunsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListPipelineRunsResponse>;
|
|
6213
6436
|
/**
|
|
6214
|
-
*
|
|
6437
|
+
* Retrieves a paginated list of deployment pipelines. You can also filter the results.
|
|
6215
6438
|
*
|
|
6216
6439
|
* @remarks
|
|
6217
|
-
* >Notice:
|
|
6218
|
-
* Earlier SDK versions may not include this interface. If so, use the ListDeployments interface. It accepts the same parameters.
|
|
6440
|
+
* >Notice: This operation may not be available in earlier versions of the SDK. In this case, use the ListDeployments operation, which uses the same parameters as described in this document.</notice>
|
|
6219
6441
|
*
|
|
6220
6442
|
* @param request - ListPipelineRunsRequest
|
|
6221
6443
|
* @returns ListPipelineRunsResponse
|
|
@@ -6389,7 +6611,7 @@ export default class Client extends OpenApi {
|
|
|
6389
6611
|
*/
|
|
6390
6612
|
listResourceGroups(request: $_model.ListResourceGroupsRequest): Promise<$_model.ListResourceGroupsResponse>;
|
|
6391
6613
|
/**
|
|
6392
|
-
*
|
|
6614
|
+
* Lists resource files with pagination and optional filters.
|
|
6393
6615
|
*
|
|
6394
6616
|
* @param request - ListResourcesRequest
|
|
6395
6617
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -6397,7 +6619,7 @@ export default class Client extends OpenApi {
|
|
|
6397
6619
|
*/
|
|
6398
6620
|
listResourcesWithOptions(request: $_model.ListResourcesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListResourcesResponse>;
|
|
6399
6621
|
/**
|
|
6400
|
-
*
|
|
6622
|
+
* Lists resource files with pagination and optional filters.
|
|
6401
6623
|
*
|
|
6402
6624
|
* @param request - ListResourcesRequest
|
|
6403
6625
|
* @returns ListResourcesResponse
|
|
@@ -6510,17 +6732,17 @@ export default class Client extends OpenApi {
|
|
|
6510
6732
|
*/
|
|
6511
6733
|
listSemanticJobRuns(request: $_model.ListSemanticJobRunsRequest): Promise<$_model.ListSemanticJobRunsResponse>;
|
|
6512
6734
|
/**
|
|
6513
|
-
*
|
|
6735
|
+
* Lists semantic job definitions for the current tenant with pagination. Use Name to run or delete a job, ProjectId to query run details, and Source to verify the input scope.
|
|
6514
6736
|
*
|
|
6515
6737
|
* @remarks
|
|
6516
6738
|
* ## Scenarios
|
|
6517
|
-
*
|
|
6518
|
-
* ##
|
|
6519
|
-
* 1. Use `PageNumber` and `PageSize` to
|
|
6520
|
-
* 2. Use the `Name`
|
|
6521
|
-
* 3. Use the `ProjectId`
|
|
6522
|
-
* ##
|
|
6523
|
-
* This operation returns
|
|
6739
|
+
* List saved semantic job definitions for the current tenant to display available jobs, select a job to run, or find the workspace that owns a job.
|
|
6740
|
+
* ## Workflow
|
|
6741
|
+
* 1. Use `PageNumber` and `PageSize` to page through `Data.SemanticJobs`.
|
|
6742
|
+
* 2. Use the `Name` of a list item to invoke `RunSemanticJob`, `DeleteSemanticJob`, or `ListSemanticJobRuns`.
|
|
6743
|
+
* 3. Use the `ProjectId` of a list item together with `ExecutorJobId` to invoke the details, log, and stop operations.
|
|
6744
|
+
* ## Precautions
|
|
6745
|
+
* This operation returns job definitions. For current run status, call `ListSemanticJobRuns`.
|
|
6524
6746
|
*
|
|
6525
6747
|
* @param request - ListSemanticJobsRequest
|
|
6526
6748
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -6528,17 +6750,17 @@ export default class Client extends OpenApi {
|
|
|
6528
6750
|
*/
|
|
6529
6751
|
listSemanticJobsWithOptions(request: $_model.ListSemanticJobsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListSemanticJobsResponse>;
|
|
6530
6752
|
/**
|
|
6531
|
-
*
|
|
6753
|
+
* Lists semantic job definitions for the current tenant with pagination. Use Name to run or delete a job, ProjectId to query run details, and Source to verify the input scope.
|
|
6532
6754
|
*
|
|
6533
6755
|
* @remarks
|
|
6534
6756
|
* ## Scenarios
|
|
6535
|
-
*
|
|
6536
|
-
* ##
|
|
6537
|
-
* 1. Use `PageNumber` and `PageSize` to
|
|
6538
|
-
* 2. Use the `Name`
|
|
6539
|
-
* 3. Use the `ProjectId`
|
|
6540
|
-
* ##
|
|
6541
|
-
* This operation returns
|
|
6757
|
+
* List saved semantic job definitions for the current tenant to display available jobs, select a job to run, or find the workspace that owns a job.
|
|
6758
|
+
* ## Workflow
|
|
6759
|
+
* 1. Use `PageNumber` and `PageSize` to page through `Data.SemanticJobs`.
|
|
6760
|
+
* 2. Use the `Name` of a list item to invoke `RunSemanticJob`, `DeleteSemanticJob`, or `ListSemanticJobRuns`.
|
|
6761
|
+
* 3. Use the `ProjectId` of a list item together with `ExecutorJobId` to invoke the details, log, and stop operations.
|
|
6762
|
+
* ## Precautions
|
|
6763
|
+
* This operation returns job definitions. For current run status, call `ListSemanticJobRuns`.
|
|
6542
6764
|
*
|
|
6543
6765
|
* @param request - ListSemanticJobsRequest
|
|
6544
6766
|
* @returns ListSemanticJobsResponse
|
|
@@ -6587,10 +6809,10 @@ export default class Client extends OpenApi {
|
|
|
6587
6809
|
*/
|
|
6588
6810
|
listServerIdeImages(request: $_model.ListServerIdeImagesRequest): Promise<$_model.ListServerIdeImagesResponse>;
|
|
6589
6811
|
/**
|
|
6590
|
-
*
|
|
6812
|
+
* Lists personal development environment instances with pagination. Use the DataWorks endpoint for the region of the target workspace.
|
|
6591
6813
|
*
|
|
6592
6814
|
* @remarks
|
|
6593
|
-
*
|
|
6815
|
+
* Lists personal development environment (ServerIDE) instances with pagination. You can filter by workspace, resource group, keyword, owner, and instance subtype.
|
|
6594
6816
|
*
|
|
6595
6817
|
* @param request - ListServerIdeInstancesRequest
|
|
6596
6818
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -6598,25 +6820,25 @@ export default class Client extends OpenApi {
|
|
|
6598
6820
|
*/
|
|
6599
6821
|
listServerIdeInstancesWithOptions(request: $_model.ListServerIdeInstancesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListServerIdeInstancesResponse>;
|
|
6600
6822
|
/**
|
|
6601
|
-
*
|
|
6823
|
+
* Lists personal development environment instances with pagination. Use the DataWorks endpoint for the region of the target workspace.
|
|
6602
6824
|
*
|
|
6603
6825
|
* @remarks
|
|
6604
|
-
*
|
|
6826
|
+
* Lists personal development environment (ServerIDE) instances with pagination. You can filter by workspace, resource group, keyword, owner, and instance subtype.
|
|
6605
6827
|
*
|
|
6606
6828
|
* @param request - ListServerIdeInstancesRequest
|
|
6607
6829
|
* @returns ListServerIdeInstancesResponse
|
|
6608
6830
|
*/
|
|
6609
6831
|
listServerIdeInstances(request: $_model.ListServerIdeInstancesRequest): Promise<$_model.ListServerIdeInstancesResponse>;
|
|
6610
6832
|
/**
|
|
6611
|
-
*
|
|
6833
|
+
* Returns a paginated list of skills for the current account.
|
|
6612
6834
|
*
|
|
6613
6835
|
* @remarks
|
|
6614
6836
|
* ## Request description
|
|
6615
|
-
* This
|
|
6616
|
-
* - **Q**: Optional.
|
|
6617
|
-
* - **Visibility**: Optional.
|
|
6618
|
-
* - **MaxResults**: Optional.
|
|
6619
|
-
* - **NextToken**: Optional.
|
|
6837
|
+
* This operation returns a paginated list of skills for the current account. You can filter the results by search keywords and visibility levels.
|
|
6838
|
+
* - **Q**: Optional. The search keyword used for fuzzy match by skill name.
|
|
6839
|
+
* - **Visibility**: Optional. The visibility levels used to filter the results. You can specify multiple values.
|
|
6840
|
+
* - **MaxResults**: Optional. The maximum number of entries to return in the current request.
|
|
6841
|
+
* - **NextToken**: Optional. The paging token used to retrieve the next page of results. Do not specify this parameter in the first request. In subsequent requests, specify the NextToken value returned in the previous response to retrieve the next page.
|
|
6620
6842
|
*
|
|
6621
6843
|
* @param tmpReq - ListSkillsRequest
|
|
6622
6844
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -6624,15 +6846,15 @@ export default class Client extends OpenApi {
|
|
|
6624
6846
|
*/
|
|
6625
6847
|
listSkillsWithOptions(tmpReq: $_model.ListSkillsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListSkillsResponse>;
|
|
6626
6848
|
/**
|
|
6627
|
-
*
|
|
6849
|
+
* Returns a paginated list of skills for the current account.
|
|
6628
6850
|
*
|
|
6629
6851
|
* @remarks
|
|
6630
6852
|
* ## Request description
|
|
6631
|
-
* This
|
|
6632
|
-
* - **Q**: Optional.
|
|
6633
|
-
* - **Visibility**: Optional.
|
|
6634
|
-
* - **MaxResults**: Optional.
|
|
6635
|
-
* - **NextToken**: Optional.
|
|
6853
|
+
* This operation returns a paginated list of skills for the current account. You can filter the results by search keywords and visibility levels.
|
|
6854
|
+
* - **Q**: Optional. The search keyword used for fuzzy match by skill name.
|
|
6855
|
+
* - **Visibility**: Optional. The visibility levels used to filter the results. You can specify multiple values.
|
|
6856
|
+
* - **MaxResults**: Optional. The maximum number of entries to return in the current request.
|
|
6857
|
+
* - **NextToken**: Optional. The paging token used to retrieve the next page of results. Do not specify this parameter in the first request. In subsequent requests, specify the NextToken value returned in the previous response to retrieve the next page.
|
|
6636
6858
|
*
|
|
6637
6859
|
* @param request - ListSkillsRequest
|
|
6638
6860
|
* @returns ListSkillsResponse
|
|
@@ -6675,10 +6897,10 @@ export default class Client extends OpenApi {
|
|
|
6675
6897
|
*/
|
|
6676
6898
|
listTables(request: $_model.ListTablesRequest): Promise<$_model.ListTablesResponse>;
|
|
6677
6899
|
/**
|
|
6678
|
-
* Retrieves a paginated list of operation logs for a specified
|
|
6900
|
+
* Retrieves a paginated list of operation logs for a specified task instance.
|
|
6679
6901
|
*
|
|
6680
6902
|
* @remarks
|
|
6681
|
-
* You must purchase DataWorks Basic Edition or
|
|
6903
|
+
* You must purchase DataWorks Basic Edition or a higher edition to use this API.
|
|
6682
6904
|
* You can only query operation logs generated within the past 31 days.
|
|
6683
6905
|
*
|
|
6684
6906
|
* @param request - ListTaskInstanceOperationLogsRequest
|
|
@@ -6687,10 +6909,10 @@ export default class Client extends OpenApi {
|
|
|
6687
6909
|
*/
|
|
6688
6910
|
listTaskInstanceOperationLogsWithOptions(request: $_model.ListTaskInstanceOperationLogsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListTaskInstanceOperationLogsResponse>;
|
|
6689
6911
|
/**
|
|
6690
|
-
* Retrieves a paginated list of operation logs for a specified
|
|
6912
|
+
* Retrieves a paginated list of operation logs for a specified task instance.
|
|
6691
6913
|
*
|
|
6692
6914
|
* @remarks
|
|
6693
|
-
* You must purchase DataWorks Basic Edition or
|
|
6915
|
+
* You must purchase DataWorks Basic Edition or a higher edition to use this API.
|
|
6694
6916
|
* You can only query operation logs generated within the past 31 days.
|
|
6695
6917
|
*
|
|
6696
6918
|
* @param request - ListTaskInstanceOperationLogsRequest
|
|
@@ -6698,7 +6920,7 @@ export default class Client extends OpenApi {
|
|
|
6698
6920
|
*/
|
|
6699
6921
|
listTaskInstanceOperationLogs(request: $_model.ListTaskInstanceOperationLogsRequest): Promise<$_model.ListTaskInstanceOperationLogsResponse>;
|
|
6700
6922
|
/**
|
|
6701
|
-
*
|
|
6923
|
+
* Queries a paginated list of task instances. You can also perform a filtered query based on specified conditions.
|
|
6702
6924
|
*
|
|
6703
6925
|
* @remarks
|
|
6704
6926
|
* You must purchase DataWorks Basic Edition or later to use this operation.
|
|
@@ -6709,7 +6931,7 @@ export default class Client extends OpenApi {
|
|
|
6709
6931
|
*/
|
|
6710
6932
|
listTaskInstancesWithOptions(tmpReq: $_model.ListTaskInstancesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListTaskInstancesResponse>;
|
|
6711
6933
|
/**
|
|
6712
|
-
*
|
|
6934
|
+
* Queries a paginated list of task instances. You can also perform a filtered query based on specified conditions.
|
|
6713
6935
|
*
|
|
6714
6936
|
* @remarks
|
|
6715
6937
|
* You must purchase DataWorks Basic Edition or later to use this operation.
|
|
@@ -6742,10 +6964,10 @@ export default class Client extends OpenApi {
|
|
|
6742
6964
|
*/
|
|
6743
6965
|
listTaskOperationLogs(request: $_model.ListTaskOperationLogsRequest): Promise<$_model.ListTaskOperationLogsResponse>;
|
|
6744
6966
|
/**
|
|
6745
|
-
* Queries a list of tasks
|
|
6967
|
+
* Queries a paginated list of tasks. You can also filter the results by specifying conditions.
|
|
6746
6968
|
*
|
|
6747
6969
|
* @remarks
|
|
6748
|
-
* DataWorks Basic Edition or
|
|
6970
|
+
* You must purchase DataWorks Basic Edition or a later edition to use this feature.
|
|
6749
6971
|
*
|
|
6750
6972
|
* @param tmpReq - ListTasksRequest
|
|
6751
6973
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -6753,10 +6975,10 @@ export default class Client extends OpenApi {
|
|
|
6753
6975
|
*/
|
|
6754
6976
|
listTasksWithOptions(tmpReq: $_model.ListTasksRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListTasksResponse>;
|
|
6755
6977
|
/**
|
|
6756
|
-
* Queries a list of tasks
|
|
6978
|
+
* Queries a paginated list of tasks. You can also filter the results by specifying conditions.
|
|
6757
6979
|
*
|
|
6758
6980
|
* @remarks
|
|
6759
|
-
* DataWorks Basic Edition or
|
|
6981
|
+
* You must purchase DataWorks Basic Edition or a later edition to use this feature.
|
|
6760
6982
|
*
|
|
6761
6983
|
* @param request - ListTasksRequest
|
|
6762
6984
|
* @returns ListTasksResponse
|
|
@@ -6841,10 +7063,10 @@ export default class Client extends OpenApi {
|
|
|
6841
7063
|
*/
|
|
6842
7064
|
listWorkflowInstances(request: $_model.ListWorkflowInstancesRequest): Promise<$_model.ListWorkflowInstancesResponse>;
|
|
6843
7065
|
/**
|
|
6844
|
-
* Retrieves a list of workflows with
|
|
7066
|
+
* Retrieves a paginated list of workflows with optional filters.
|
|
6845
7067
|
*
|
|
6846
7068
|
* @remarks
|
|
6847
|
-
* You must purchase DataWorks Basic Edition or later to use this
|
|
7069
|
+
* You must purchase DataWorks Basic Edition or a later edition to use this feature.
|
|
6848
7070
|
*
|
|
6849
7071
|
* @param tmpReq - ListWorkflowsRequest
|
|
6850
7072
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -6852,25 +7074,25 @@ export default class Client extends OpenApi {
|
|
|
6852
7074
|
*/
|
|
6853
7075
|
listWorkflowsWithOptions(tmpReq: $_model.ListWorkflowsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListWorkflowsResponse>;
|
|
6854
7076
|
/**
|
|
6855
|
-
* Retrieves a list of workflows with
|
|
7077
|
+
* Retrieves a paginated list of workflows with optional filters.
|
|
6856
7078
|
*
|
|
6857
7079
|
* @remarks
|
|
6858
|
-
* You must purchase DataWorks Basic Edition or later to use this
|
|
7080
|
+
* You must purchase DataWorks Basic Edition or a later edition to use this feature.
|
|
6859
7081
|
*
|
|
6860
7082
|
* @param request - ListWorkflowsRequest
|
|
6861
7083
|
* @returns ListWorkflowsResponse
|
|
6862
7084
|
*/
|
|
6863
7085
|
listWorkflows(request: $_model.ListWorkflowsRequest): Promise<$_model.ListWorkflowsResponse>;
|
|
6864
7086
|
/**
|
|
6865
|
-
* Loads the historical messages of an existing session and returns them
|
|
7087
|
+
* Loads the historical messages of an existing agent session and returns them by using Server-Sent Events (SSE) for page refreshes and history recovery after exceptions.
|
|
6866
7088
|
*
|
|
6867
7089
|
* @remarks
|
|
6868
7090
|
* ## Request description
|
|
6869
|
-
* - This operation
|
|
6870
|
-
* - If the target session does not exist, an error frame with
|
|
6871
|
-
* - The response
|
|
6872
|
-
* - The stopReason field indicates the reason why the agent stops the current conversation turn. Valid values include but are not limited to reaching the maximum
|
|
6873
|
-
* - The returned content complies with the open
|
|
7091
|
+
* - This operation recovers the details of a specified session and returns the agent response in a streaming manner by using Server-Sent Events (SSE).
|
|
7092
|
+
* - If the target session does not exist, an error frame with the error code 400 is returned.
|
|
7093
|
+
* - The response includes processing information about how the agent handles the request, such as message chunks, thinking process, and tool invocation status updates.
|
|
7094
|
+
* - The `stopReason` field indicates the reason why the agent stops the current conversation turn. Valid values include but are not limited to reaching the maximum number of turns and being canceled.
|
|
7095
|
+
* - The returned content complies with the open source Agent Client Protocol (ACP) specification. For more information, see https://agentclientprotocol.com.
|
|
6874
7096
|
*
|
|
6875
7097
|
* @param tmpReq - LoadAgentSessionRequest
|
|
6876
7098
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -6878,15 +7100,15 @@ export default class Client extends OpenApi {
|
|
|
6878
7100
|
*/
|
|
6879
7101
|
loadAgentSessionWithSSE(tmpReq: $_model.LoadAgentSessionRequest, runtime: $dara.RuntimeOptions): AsyncGenerator<$_model.LoadAgentSessionResponse, any, unknown>;
|
|
6880
7102
|
/**
|
|
6881
|
-
* Loads the historical messages of an existing session and returns them
|
|
7103
|
+
* Loads the historical messages of an existing agent session and returns them by using Server-Sent Events (SSE) for page refreshes and history recovery after exceptions.
|
|
6882
7104
|
*
|
|
6883
7105
|
* @remarks
|
|
6884
7106
|
* ## Request description
|
|
6885
|
-
* - This operation
|
|
6886
|
-
* - If the target session does not exist, an error frame with
|
|
6887
|
-
* - The response
|
|
6888
|
-
* - The stopReason field indicates the reason why the agent stops the current conversation turn. Valid values include but are not limited to reaching the maximum
|
|
6889
|
-
* - The returned content complies with the open
|
|
7107
|
+
* - This operation recovers the details of a specified session and returns the agent response in a streaming manner by using Server-Sent Events (SSE).
|
|
7108
|
+
* - If the target session does not exist, an error frame with the error code 400 is returned.
|
|
7109
|
+
* - The response includes processing information about how the agent handles the request, such as message chunks, thinking process, and tool invocation status updates.
|
|
7110
|
+
* - The `stopReason` field indicates the reason why the agent stops the current conversation turn. Valid values include but are not limited to reaching the maximum number of turns and being canceled.
|
|
7111
|
+
* - The returned content complies with the open source Agent Client Protocol (ACP) specification. For more information, see https://agentclientprotocol.com.
|
|
6890
7112
|
*
|
|
6891
7113
|
* @param tmpReq - LoadAgentSessionRequest
|
|
6892
7114
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -6894,15 +7116,15 @@ export default class Client extends OpenApi {
|
|
|
6894
7116
|
*/
|
|
6895
7117
|
loadAgentSessionWithOptions(tmpReq: $_model.LoadAgentSessionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.LoadAgentSessionResponse>;
|
|
6896
7118
|
/**
|
|
6897
|
-
* Loads the historical messages of an existing session and returns them
|
|
7119
|
+
* Loads the historical messages of an existing agent session and returns them by using Server-Sent Events (SSE) for page refreshes and history recovery after exceptions.
|
|
6898
7120
|
*
|
|
6899
7121
|
* @remarks
|
|
6900
7122
|
* ## Request description
|
|
6901
|
-
* - This operation
|
|
6902
|
-
* - If the target session does not exist, an error frame with
|
|
6903
|
-
* - The response
|
|
6904
|
-
* - The stopReason field indicates the reason why the agent stops the current conversation turn. Valid values include but are not limited to reaching the maximum
|
|
6905
|
-
* - The returned content complies with the open
|
|
7123
|
+
* - This operation recovers the details of a specified session and returns the agent response in a streaming manner by using Server-Sent Events (SSE).
|
|
7124
|
+
* - If the target session does not exist, an error frame with the error code 400 is returned.
|
|
7125
|
+
* - The response includes processing information about how the agent handles the request, such as message chunks, thinking process, and tool invocation status updates.
|
|
7126
|
+
* - The `stopReason` field indicates the reason why the agent stops the current conversation turn. Valid values include but are not limited to reaching the maximum number of turns and being canceled.
|
|
7127
|
+
* - The returned content complies with the open source Agent Client Protocol (ACP) specification. For more information, see https://agentclientprotocol.com.
|
|
6906
7128
|
*
|
|
6907
7129
|
* @param request - LoadAgentSessionRequest
|
|
6908
7130
|
* @returns LoadAgentSessionResponse
|
|
@@ -6989,19 +7211,51 @@ export default class Client extends OpenApi {
|
|
|
6989
7211
|
* @returns PreviewDatasetVersionResponse
|
|
6990
7212
|
*/
|
|
6991
7213
|
previewDatasetVersion(request: $_model.PreviewDatasetVersionRequest): Promise<$_model.PreviewDatasetVersionResponse>;
|
|
7214
|
+
/**
|
|
7215
|
+
* Previews scheduling parameters without creating actual nodes or running instances.
|
|
7216
|
+
*
|
|
7217
|
+
* @remarks
|
|
7218
|
+
* Previews the parameter parsing results for each cycle based on the provided script parameters, business date, and scheduling configuration. A task ID is not required.
|
|
7219
|
+
* - This operation only performs a simulated preview and does not create or run actual tasks. The simulated cycles returned for weekly and monthly schedules cannot be used as the basis for determining actual trigger dates.
|
|
7220
|
+
* - `Bizdate` is the starting business date, normalized to 00:00:00 on that date in the time zone of the service region. `TriggerTime` is the scheduled trigger time for the corresponding simulated cycle.
|
|
7221
|
+
* - System identifiers such as `$nodeid` use a simulated context. The preview value of `$nodeid` is `0`, which does not represent an actual task.
|
|
7222
|
+
* - The parsing result for each cycle is indicated by `Success`. If the parsing is successful, `Parameters` is returned. If the parsing fails, `ErrorMessage` is returned, and partial parsing results for the cycle are not returned.
|
|
7223
|
+
*
|
|
7224
|
+
* @param request - PreviewTaskParametersRequest
|
|
7225
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
7226
|
+
* @returns PreviewTaskParametersResponse
|
|
7227
|
+
*/
|
|
7228
|
+
previewTaskParametersWithOptions(request: $_model.PreviewTaskParametersRequest, runtime: $dara.RuntimeOptions): Promise<$_model.PreviewTaskParametersResponse>;
|
|
7229
|
+
/**
|
|
7230
|
+
* Previews scheduling parameters without creating actual nodes or running instances.
|
|
7231
|
+
*
|
|
7232
|
+
* @remarks
|
|
7233
|
+
* Previews the parameter parsing results for each cycle based on the provided script parameters, business date, and scheduling configuration. A task ID is not required.
|
|
7234
|
+
* - This operation only performs a simulated preview and does not create or run actual tasks. The simulated cycles returned for weekly and monthly schedules cannot be used as the basis for determining actual trigger dates.
|
|
7235
|
+
* - `Bizdate` is the starting business date, normalized to 00:00:00 on that date in the time zone of the service region. `TriggerTime` is the scheduled trigger time for the corresponding simulated cycle.
|
|
7236
|
+
* - System identifiers such as `$nodeid` use a simulated context. The preview value of `$nodeid` is `0`, which does not represent an actual task.
|
|
7237
|
+
* - The parsing result for each cycle is indicated by `Success`. If the parsing is successful, `Parameters` is returned. If the parsing fails, `ErrorMessage` is returned, and partial parsing results for the cycle are not returned.
|
|
7238
|
+
*
|
|
7239
|
+
* @param request - PreviewTaskParametersRequest
|
|
7240
|
+
* @returns PreviewTaskParametersResponse
|
|
7241
|
+
*/
|
|
7242
|
+
previewTaskParameters(request: $_model.PreviewTaskParametersRequest): Promise<$_model.PreviewTaskParametersResponse>;
|
|
6992
7243
|
/**
|
|
6993
7244
|
* Sends a user prompt to an existing session and streams the agent response.
|
|
6994
7245
|
*
|
|
6995
7246
|
* @remarks
|
|
6996
7247
|
* ## Request description
|
|
6997
|
-
* - This API operation sends a user prompt to a specified session ID and accepts the
|
|
6998
|
-
* - The response may include
|
|
6999
|
-
* - If the specified session does not exist, a 400
|
|
7000
|
-
* - The stopReason field indicates the reason why the agent stopped the current conversation.
|
|
7001
|
-
* -
|
|
7002
|
-
* - You can optionally provide additional metadata in
|
|
7248
|
+
* - This API operation sends a user prompt to a specified session ID and accepts the agent response as Server-Sent Events (SSE) streams.
|
|
7249
|
+
* - The response may include message chunks, thinking procedures, and tool invocation status updates.
|
|
7250
|
+
* - If the specified session does not exist, a 400 error is returned in an SSE error frame.
|
|
7251
|
+
* - The `stopReason` field indicates the reason why the agent stopped the current conversation turn.
|
|
7252
|
+
* - This operation supports multiple types of content blocks as prompt input, such as text and OSS file download links.
|
|
7253
|
+
* - You can optionally provide additional metadata in `Meta` to pass more context to the server.
|
|
7003
7254
|
* - The returned content complies with the open-source Agent Client Protocol (ACP) specification. For more information, see https://agentclientprotocol.com.
|
|
7004
|
-
* - **Before you
|
|
7255
|
+
* - **Before you use this API operation, make sure that you fully understand the billing methods and pricing of Data Agent**: https://www.alibabacloud.com/help/en/dataworks/dataworks-data-agent-agent-billing
|
|
7256
|
+
* ## Long-running tasks and timeout recovery
|
|
7257
|
+
* For long-running tasks that may exceed the single-request timeout, after the GetAgentSessionEvents canary release is enabled for the current account and target region, first establish an Events subscription and then call PromptAgentSession to read both streams in parallel. Use Events to display real-time progress, and use the Prompt stream to read the final state and business errors of the current turn. Each message is displayed only once.
|
|
7258
|
+
* If the Prompt stream times out or disconnects before the final business state is received, the result of the current turn is unknown. Continue to observe Events, and call LoadAgentSession when you need to verify the session history. Do not automatically resend the prompt.
|
|
7005
7259
|
*
|
|
7006
7260
|
* @param tmpReq - PromptAgentSessionRequest
|
|
7007
7261
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -7013,14 +7267,17 @@ export default class Client extends OpenApi {
|
|
|
7013
7267
|
*
|
|
7014
7268
|
* @remarks
|
|
7015
7269
|
* ## Request description
|
|
7016
|
-
* - This API operation sends a user prompt to a specified session ID and accepts the
|
|
7017
|
-
* - The response may include
|
|
7018
|
-
* - If the specified session does not exist, a 400
|
|
7019
|
-
* - The stopReason field indicates the reason why the agent stopped the current conversation.
|
|
7020
|
-
* -
|
|
7021
|
-
* - You can optionally provide additional metadata in
|
|
7270
|
+
* - This API operation sends a user prompt to a specified session ID and accepts the agent response as Server-Sent Events (SSE) streams.
|
|
7271
|
+
* - The response may include message chunks, thinking procedures, and tool invocation status updates.
|
|
7272
|
+
* - If the specified session does not exist, a 400 error is returned in an SSE error frame.
|
|
7273
|
+
* - The `stopReason` field indicates the reason why the agent stopped the current conversation turn.
|
|
7274
|
+
* - This operation supports multiple types of content blocks as prompt input, such as text and OSS file download links.
|
|
7275
|
+
* - You can optionally provide additional metadata in `Meta` to pass more context to the server.
|
|
7022
7276
|
* - The returned content complies with the open-source Agent Client Protocol (ACP) specification. For more information, see https://agentclientprotocol.com.
|
|
7023
|
-
* - **Before you
|
|
7277
|
+
* - **Before you use this API operation, make sure that you fully understand the billing methods and pricing of Data Agent**: https://www.alibabacloud.com/help/en/dataworks/dataworks-data-agent-agent-billing
|
|
7278
|
+
* ## Long-running tasks and timeout recovery
|
|
7279
|
+
* For long-running tasks that may exceed the single-request timeout, after the GetAgentSessionEvents canary release is enabled for the current account and target region, first establish an Events subscription and then call PromptAgentSession to read both streams in parallel. Use Events to display real-time progress, and use the Prompt stream to read the final state and business errors of the current turn. Each message is displayed only once.
|
|
7280
|
+
* If the Prompt stream times out or disconnects before the final business state is received, the result of the current turn is unknown. Continue to observe Events, and call LoadAgentSession when you need to verify the session history. Do not automatically resend the prompt.
|
|
7024
7281
|
*
|
|
7025
7282
|
* @param tmpReq - PromptAgentSessionRequest
|
|
7026
7283
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -7032,14 +7289,17 @@ export default class Client extends OpenApi {
|
|
|
7032
7289
|
*
|
|
7033
7290
|
* @remarks
|
|
7034
7291
|
* ## Request description
|
|
7035
|
-
* - This API operation sends a user prompt to a specified session ID and accepts the
|
|
7036
|
-
* - The response may include
|
|
7037
|
-
* - If the specified session does not exist, a 400
|
|
7038
|
-
* - The stopReason field indicates the reason why the agent stopped the current conversation.
|
|
7039
|
-
* -
|
|
7040
|
-
* - You can optionally provide additional metadata in
|
|
7292
|
+
* - This API operation sends a user prompt to a specified session ID and accepts the agent response as Server-Sent Events (SSE) streams.
|
|
7293
|
+
* - The response may include message chunks, thinking procedures, and tool invocation status updates.
|
|
7294
|
+
* - If the specified session does not exist, a 400 error is returned in an SSE error frame.
|
|
7295
|
+
* - The `stopReason` field indicates the reason why the agent stopped the current conversation turn.
|
|
7296
|
+
* - This operation supports multiple types of content blocks as prompt input, such as text and OSS file download links.
|
|
7297
|
+
* - You can optionally provide additional metadata in `Meta` to pass more context to the server.
|
|
7041
7298
|
* - The returned content complies with the open-source Agent Client Protocol (ACP) specification. For more information, see https://agentclientprotocol.com.
|
|
7042
|
-
* - **Before you
|
|
7299
|
+
* - **Before you use this API operation, make sure that you fully understand the billing methods and pricing of Data Agent**: https://www.alibabacloud.com/help/en/dataworks/dataworks-data-agent-agent-billing
|
|
7300
|
+
* ## Long-running tasks and timeout recovery
|
|
7301
|
+
* For long-running tasks that may exceed the single-request timeout, after the GetAgentSessionEvents canary release is enabled for the current account and target region, first establish an Events subscription and then call PromptAgentSession to read both streams in parallel. Use Events to display real-time progress, and use the Prompt stream to read the final state and business errors of the current turn. Each message is displayed only once.
|
|
7302
|
+
* If the Prompt stream times out or disconnects before the final business state is received, the result of the current turn is unknown. Continue to observe Events, and call LoadAgentSession when you need to verify the session history. Do not automatically resend the prompt.
|
|
7043
7303
|
*
|
|
7044
7304
|
* @param request - PromptAgentSessionRequest
|
|
7045
7305
|
* @returns PromptAgentSessionResponse
|
|
@@ -7049,8 +7309,8 @@ export default class Client extends OpenApi {
|
|
|
7049
7309
|
* Publishes an image.
|
|
7050
7310
|
*
|
|
7051
7311
|
* @remarks
|
|
7052
|
-
* 1. You must purchase DataWorks Basic Edition or
|
|
7053
|
-
* 2. **Make sure that the service-linked role AliyunServiceRoleForDataWorks
|
|
7312
|
+
* 1. You must purchase DataWorks Basic Edition or later to use this operation.
|
|
7313
|
+
* 2. **Make sure that the service-linked role AliyunServiceRoleForDataWorks is created before you call this operation.**
|
|
7054
7314
|
*
|
|
7055
7315
|
* @param request - PublishImageRequest
|
|
7056
7316
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -7061,8 +7321,8 @@ export default class Client extends OpenApi {
|
|
|
7061
7321
|
* Publishes an image.
|
|
7062
7322
|
*
|
|
7063
7323
|
* @remarks
|
|
7064
|
-
* 1. You must purchase DataWorks Basic Edition or
|
|
7065
|
-
* 2. **Make sure that the service-linked role AliyunServiceRoleForDataWorks
|
|
7324
|
+
* 1. You must purchase DataWorks Basic Edition or later to use this operation.
|
|
7325
|
+
* 2. **Make sure that the service-linked role AliyunServiceRoleForDataWorks is created before you call this operation.**
|
|
7066
7326
|
*
|
|
7067
7327
|
* @param request - PublishImageRequest
|
|
7068
7328
|
* @returns PublishImageResponse
|
|
@@ -7092,10 +7352,10 @@ export default class Client extends OpenApi {
|
|
|
7092
7352
|
*/
|
|
7093
7353
|
removeEntityFromMetaCollection(request: $_model.RemoveEntityFromMetaCollectionRequest): Promise<$_model.RemoveEntityFromMetaCollectionResponse>;
|
|
7094
7354
|
/**
|
|
7095
|
-
* Removes multiple upstream dependencies of
|
|
7355
|
+
* Removes multiple upstream dependencies of a node instance in batches.
|
|
7096
7356
|
*
|
|
7097
7357
|
* @remarks
|
|
7098
|
-
* You must purchase DataWorks Basic Edition or a
|
|
7358
|
+
* You must purchase DataWorks Basic Edition or a later edition to use this operation.
|
|
7099
7359
|
*
|
|
7100
7360
|
* @param tmpReq - RemoveTaskInstanceDependenciesRequest
|
|
7101
7361
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -7103,10 +7363,10 @@ export default class Client extends OpenApi {
|
|
|
7103
7363
|
*/
|
|
7104
7364
|
removeTaskInstanceDependenciesWithOptions(tmpReq: $_model.RemoveTaskInstanceDependenciesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.RemoveTaskInstanceDependenciesResponse>;
|
|
7105
7365
|
/**
|
|
7106
|
-
* Removes multiple upstream dependencies of
|
|
7366
|
+
* Removes multiple upstream dependencies of a node instance in batches.
|
|
7107
7367
|
*
|
|
7108
7368
|
* @remarks
|
|
7109
|
-
* You must purchase DataWorks Basic Edition or a
|
|
7369
|
+
* You must purchase DataWorks Basic Edition or a later edition to use this operation.
|
|
7110
7370
|
*
|
|
7111
7371
|
* @param request - RemoveTaskInstanceDependenciesRequest
|
|
7112
7372
|
* @returns RemoveTaskInstanceDependenciesResponse
|
|
@@ -7194,10 +7454,10 @@ export default class Client extends OpenApi {
|
|
|
7194
7454
|
*/
|
|
7195
7455
|
replyAgentSession(request: $_model.ReplyAgentSessionRequest): Promise<$_model.ReplyAgentSessionResponse>;
|
|
7196
7456
|
/**
|
|
7197
|
-
* Reruns multiple
|
|
7457
|
+
* Reruns multiple task instances in a batch.
|
|
7198
7458
|
*
|
|
7199
7459
|
* @remarks
|
|
7200
|
-
*
|
|
7460
|
+
* Requires DataWorks Basic Edition or higher.
|
|
7201
7461
|
*
|
|
7202
7462
|
* @param tmpReq - RerunTaskInstancesRequest
|
|
7203
7463
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -7205,10 +7465,10 @@ export default class Client extends OpenApi {
|
|
|
7205
7465
|
*/
|
|
7206
7466
|
rerunTaskInstancesWithOptions(tmpReq: $_model.RerunTaskInstancesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.RerunTaskInstancesResponse>;
|
|
7207
7467
|
/**
|
|
7208
|
-
* Reruns multiple
|
|
7468
|
+
* Reruns multiple task instances in a batch.
|
|
7209
7469
|
*
|
|
7210
7470
|
* @remarks
|
|
7211
|
-
*
|
|
7471
|
+
* Requires DataWorks Basic Edition or higher.
|
|
7212
7472
|
*
|
|
7213
7473
|
* @param request - RerunTaskInstancesRequest
|
|
7214
7474
|
* @returns RerunTaskInstancesResponse
|
|
@@ -7230,7 +7490,7 @@ export default class Client extends OpenApi {
|
|
|
7230
7490
|
*/
|
|
7231
7491
|
rerunWorkflowInstances(request: $_model.RerunWorkflowInstancesRequest): Promise<$_model.RerunWorkflowInstancesResponse>;
|
|
7232
7492
|
/**
|
|
7233
|
-
* Resumes multiple
|
|
7493
|
+
* Resumes multiple paused task instances.
|
|
7234
7494
|
*
|
|
7235
7495
|
* @remarks
|
|
7236
7496
|
* You must purchase DataWorks Basic Edition or a higher edition to use this operation.
|
|
@@ -7241,7 +7501,7 @@ export default class Client extends OpenApi {
|
|
|
7241
7501
|
*/
|
|
7242
7502
|
resumeTaskInstancesWithOptions(tmpReq: $_model.ResumeTaskInstancesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ResumeTaskInstancesResponse>;
|
|
7243
7503
|
/**
|
|
7244
|
-
* Resumes multiple
|
|
7504
|
+
* Resumes multiple paused task instances.
|
|
7245
7505
|
*
|
|
7246
7506
|
* @remarks
|
|
7247
7507
|
* You must purchase DataWorks Basic Edition or a higher edition to use this operation.
|
|
@@ -7250,6 +7510,27 @@ export default class Client extends OpenApi {
|
|
|
7250
7510
|
* @returns ResumeTaskInstancesResponse
|
|
7251
7511
|
*/
|
|
7252
7512
|
resumeTaskInstances(request: $_model.ResumeTaskInstancesRequest): Promise<$_model.ResumeTaskInstancesResponse>;
|
|
7513
|
+
/**
|
|
7514
|
+
* Searches one or more authorized knowledge bases for knowledge points and returns summaries, relationship paths, and candidates for ambiguous references.
|
|
7515
|
+
*
|
|
7516
|
+
* @remarks
|
|
7517
|
+
* Searches one or more knowledge bases that the caller is authorized to access and returns knowledge point summaries, relationship paths, and candidates for ambiguous references.
|
|
7518
|
+
*
|
|
7519
|
+
* @param tmpReq - RetrieveKnowledgePointsRequest
|
|
7520
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
7521
|
+
* @returns RetrieveKnowledgePointsResponse
|
|
7522
|
+
*/
|
|
7523
|
+
retrieveKnowledgePointsWithOptions(tmpReq: $_model.RetrieveKnowledgePointsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.RetrieveKnowledgePointsResponse>;
|
|
7524
|
+
/**
|
|
7525
|
+
* Searches one or more authorized knowledge bases for knowledge points and returns summaries, relationship paths, and candidates for ambiguous references.
|
|
7526
|
+
*
|
|
7527
|
+
* @remarks
|
|
7528
|
+
* Searches one or more knowledge bases that the caller is authorized to access and returns knowledge point summaries, relationship paths, and candidates for ambiguous references.
|
|
7529
|
+
*
|
|
7530
|
+
* @param request - RetrieveKnowledgePointsRequest
|
|
7531
|
+
* @returns RetrieveKnowledgePointsResponse
|
|
7532
|
+
*/
|
|
7533
|
+
retrieveKnowledgePoints(request: $_model.RetrieveKnowledgePointsRequest): Promise<$_model.RetrieveKnowledgePointsResponse>;
|
|
7253
7534
|
/**
|
|
7254
7535
|
* Revokes roles from a workspace member.
|
|
7255
7536
|
*
|
|
@@ -7419,10 +7700,10 @@ export default class Client extends OpenApi {
|
|
|
7419
7700
|
*/
|
|
7420
7701
|
runSemanticJob(request: $_model.RunSemanticJobRequest): Promise<$_model.RunSemanticJobResponse>;
|
|
7421
7702
|
/**
|
|
7422
|
-
*
|
|
7703
|
+
* Marks multiple task instances as successful.
|
|
7423
7704
|
*
|
|
7424
7705
|
* @remarks
|
|
7425
|
-
* You must purchase DataWorks Basic Edition or
|
|
7706
|
+
* You must purchase DataWorks Basic Edition or higher to use this operation.
|
|
7426
7707
|
*
|
|
7427
7708
|
* @param tmpReq - SetSuccessTaskInstancesRequest
|
|
7428
7709
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -7430,10 +7711,10 @@ export default class Client extends OpenApi {
|
|
|
7430
7711
|
*/
|
|
7431
7712
|
setSuccessTaskInstancesWithOptions(tmpReq: $_model.SetSuccessTaskInstancesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.SetSuccessTaskInstancesResponse>;
|
|
7432
7713
|
/**
|
|
7433
|
-
*
|
|
7714
|
+
* Marks multiple task instances as successful.
|
|
7434
7715
|
*
|
|
7435
7716
|
* @remarks
|
|
7436
|
-
* You must purchase DataWorks Basic Edition or
|
|
7717
|
+
* You must purchase DataWorks Basic Edition or higher to use this operation.
|
|
7437
7718
|
*
|
|
7438
7719
|
* @param request - SetSuccessTaskInstancesRequest
|
|
7439
7720
|
* @returns SetSuccessTaskInstancesResponse
|
|
@@ -7482,10 +7763,10 @@ export default class Client extends OpenApi {
|
|
|
7482
7763
|
*/
|
|
7483
7764
|
startServerIdeInstance(request: $_model.StartServerIdeInstanceRequest): Promise<$_model.StartServerIdeInstanceResponse>;
|
|
7484
7765
|
/**
|
|
7485
|
-
* Starts multiple workflow instances
|
|
7766
|
+
* Starts multiple workflow instances.
|
|
7486
7767
|
*
|
|
7487
7768
|
* @remarks
|
|
7488
|
-
* You must purchase DataWorks Basic Edition or
|
|
7769
|
+
* You must purchase DataWorks Basic Edition or later to use this operation.
|
|
7489
7770
|
*
|
|
7490
7771
|
* @param tmpReq - StartWorkflowInstancesRequest
|
|
7491
7772
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -7493,10 +7774,10 @@ export default class Client extends OpenApi {
|
|
|
7493
7774
|
*/
|
|
7494
7775
|
startWorkflowInstancesWithOptions(tmpReq: $_model.StartWorkflowInstancesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.StartWorkflowInstancesResponse>;
|
|
7495
7776
|
/**
|
|
7496
|
-
* Starts multiple workflow instances
|
|
7777
|
+
* Starts multiple workflow instances.
|
|
7497
7778
|
*
|
|
7498
7779
|
* @remarks
|
|
7499
|
-
* You must purchase DataWorks Basic Edition or
|
|
7780
|
+
* You must purchase DataWorks Basic Edition or later to use this operation.
|
|
7500
7781
|
*
|
|
7501
7782
|
* @param request - StartWorkflowInstancesRequest
|
|
7502
7783
|
* @returns StartWorkflowInstancesResponse
|
|
@@ -7614,11 +7895,11 @@ export default class Client extends OpenApi {
|
|
|
7614
7895
|
* Terminates multiple task instances.
|
|
7615
7896
|
*
|
|
7616
7897
|
* @remarks
|
|
7617
|
-
* You must purchase DataWorks Basic Edition or
|
|
7898
|
+
* You must purchase DataWorks Basic Edition or higher to use this operation.
|
|
7618
7899
|
* Instance termination mechanism and precautions:
|
|
7619
|
-
* 1. Instance termination is an asynchronous operation.
|
|
7620
|
-
* 2. The DataWorks instance status may
|
|
7621
|
-
* 3. Pay special attention to MaxCompute tasks that
|
|
7900
|
+
* 1. Instance termination is an asynchronous operation. Sending a termination request does not mean that the instance stops immediately. Continue to query the instance status after the request to confirm the termination result. If external compute resources are involved, you must also verify the actual status of the remote job.
|
|
7901
|
+
* 2. The DataWorks instance status may not be consistent with the remote job status. For tasks that rely on external compute resources (such as MaxCompute, EMR, and SSH), DataWorks sends a termination request to the remote end through a client. Due to network exceptions, client compatibility, and other factors, the DataWorks instance may be marked as failed while the remote job is still running. Therefore, you cannot determine that the remote job has terminated based only on the DataWorks instance status. Go to the corresponding computing platform to check the status and manually terminate the job if necessary to prevent the job from continuing to run or consuming additional resources.
|
|
7902
|
+
* 3. Pay special attention to MaxCompute tasks that run in public scheduling resource groups. DataWorks public scheduling resource groups will be taken offline soon. Due to component version and compatibility limitations, the termination commands for some MaxCompute tasks may not take effect on the remote end. In this case, go to MaxCompute to query the actual status of the corresponding instance. If it is still running, execute the kill operation in MaxCompute and confirm again that it has terminated.
|
|
7622
7903
|
*
|
|
7623
7904
|
* @param tmpReq - StopTaskInstancesRequest
|
|
7624
7905
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -7629,11 +7910,11 @@ export default class Client extends OpenApi {
|
|
|
7629
7910
|
* Terminates multiple task instances.
|
|
7630
7911
|
*
|
|
7631
7912
|
* @remarks
|
|
7632
|
-
* You must purchase DataWorks Basic Edition or
|
|
7913
|
+
* You must purchase DataWorks Basic Edition or higher to use this operation.
|
|
7633
7914
|
* Instance termination mechanism and precautions:
|
|
7634
|
-
* 1. Instance termination is an asynchronous operation.
|
|
7635
|
-
* 2. The DataWorks instance status may
|
|
7636
|
-
* 3. Pay special attention to MaxCompute tasks that
|
|
7915
|
+
* 1. Instance termination is an asynchronous operation. Sending a termination request does not mean that the instance stops immediately. Continue to query the instance status after the request to confirm the termination result. If external compute resources are involved, you must also verify the actual status of the remote job.
|
|
7916
|
+
* 2. The DataWorks instance status may not be consistent with the remote job status. For tasks that rely on external compute resources (such as MaxCompute, EMR, and SSH), DataWorks sends a termination request to the remote end through a client. Due to network exceptions, client compatibility, and other factors, the DataWorks instance may be marked as failed while the remote job is still running. Therefore, you cannot determine that the remote job has terminated based only on the DataWorks instance status. Go to the corresponding computing platform to check the status and manually terminate the job if necessary to prevent the job from continuing to run or consuming additional resources.
|
|
7917
|
+
* 3. Pay special attention to MaxCompute tasks that run in public scheduling resource groups. DataWorks public scheduling resource groups will be taken offline soon. Due to component version and compatibility limitations, the termination commands for some MaxCompute tasks may not take effect on the remote end. In this case, go to MaxCompute to query the actual status of the corresponding instance. If it is still running, execute the kill operation in MaxCompute and confirm again that it has terminated.
|
|
7637
7918
|
*
|
|
7638
7919
|
* @param request - StopTaskInstancesRequest
|
|
7639
7920
|
* @returns StopTaskInstancesResponse
|
|
@@ -7643,7 +7924,7 @@ export default class Client extends OpenApi {
|
|
|
7643
7924
|
* Terminates multiple workflow instances.
|
|
7644
7925
|
*
|
|
7645
7926
|
* @remarks
|
|
7646
|
-
* You must purchase DataWorks Basic Edition or
|
|
7927
|
+
* You must purchase DataWorks Basic Edition or higher to use this feature.
|
|
7647
7928
|
*
|
|
7648
7929
|
* @param tmpReq - StopWorkflowInstancesRequest
|
|
7649
7930
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -7654,7 +7935,7 @@ export default class Client extends OpenApi {
|
|
|
7654
7935
|
* Terminates multiple workflow instances.
|
|
7655
7936
|
*
|
|
7656
7937
|
* @remarks
|
|
7657
|
-
* You must purchase DataWorks Basic Edition or
|
|
7938
|
+
* You must purchase DataWorks Basic Edition or higher to use this feature.
|
|
7658
7939
|
*
|
|
7659
7940
|
* @param request - StopWorkflowInstancesRequest
|
|
7660
7941
|
* @returns StopWorkflowInstancesResponse
|
|
@@ -7694,7 +7975,7 @@ export default class Client extends OpenApi {
|
|
|
7694
7975
|
* Pauses multiple task instances.
|
|
7695
7976
|
*
|
|
7696
7977
|
* @remarks
|
|
7697
|
-
* You must purchase DataWorks Basic Edition or
|
|
7978
|
+
* You must purchase DataWorks Basic Edition or higher to use this operation.
|
|
7698
7979
|
*
|
|
7699
7980
|
* @param tmpReq - SuspendTaskInstancesRequest
|
|
7700
7981
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -7705,7 +7986,7 @@ export default class Client extends OpenApi {
|
|
|
7705
7986
|
* Pauses multiple task instances.
|
|
7706
7987
|
*
|
|
7707
7988
|
* @remarks
|
|
7708
|
-
* You must purchase DataWorks Basic Edition or
|
|
7989
|
+
* You must purchase DataWorks Basic Edition or higher to use this operation.
|
|
7709
7990
|
*
|
|
7710
7991
|
* @param request - SuspendTaskInstancesRequest
|
|
7711
7992
|
* @returns SuspendTaskInstancesResponse
|
|
@@ -7715,7 +7996,7 @@ export default class Client extends OpenApi {
|
|
|
7715
7996
|
* Attaches tags to data assets.
|
|
7716
7997
|
*
|
|
7717
7998
|
* @remarks
|
|
7718
|
-
*
|
|
7999
|
+
* You must purchase DataWorks Enterprise Edition or higher to use this operation.
|
|
7719
8000
|
*
|
|
7720
8001
|
* @param tmpReq - TagDataAssetsRequest
|
|
7721
8002
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -7726,7 +8007,7 @@ export default class Client extends OpenApi {
|
|
|
7726
8007
|
* Attaches tags to data assets.
|
|
7727
8008
|
*
|
|
7728
8009
|
* @remarks
|
|
7729
|
-
*
|
|
8010
|
+
* You must purchase DataWorks Enterprise Edition or higher to use this operation.
|
|
7730
8011
|
*
|
|
7731
8012
|
* @param request - TagDataAssetsRequest
|
|
7732
8013
|
* @returns TagDataAssetsResponse
|
|
@@ -7799,6 +8080,35 @@ export default class Client extends OpenApi {
|
|
|
7799
8080
|
* @returns UnTagDataAssetsResponse
|
|
7800
8081
|
*/
|
|
7801
8082
|
unTagDataAssets(request: $_model.UnTagDataAssetsRequest): Promise<$_model.UnTagDataAssetsResponse>;
|
|
8083
|
+
/**
|
|
8084
|
+
* Updates the definition of a specified agent and increments the definition version, with the option to publish immediately. This operation is available only when the canary release feature is enabled. Before calling this operation, ensure that the canary release feature is enabled for the current account and the target region.
|
|
8085
|
+
*
|
|
8086
|
+
* @remarks
|
|
8087
|
+
* This operation is available only when the canary release feature is enabled. Before calling this operation, ensure that the canary release feature is enabled for the current account and the target region.
|
|
8088
|
+
* Updates a custom agent that the current identity has administrative permissions for. The Name parameter is used to locate the target agent and is not used for renaming. Call GetAgent first to read the current AgentVersion, and explicitly pass ExpectedVersion during the update. If a conflict occurs, re-read the version and verify the differences instead of blindly overwriting.
|
|
8089
|
+
* Omit reference lists that do not need to be modified. The current new backend retains existing references for empty arrays of Tools, Skills, and CallableAgents, but clears references for an empty array of ExpertSuites. A unified empty array clearing rule cannot be used. Tools already includes Kind and the corresponding tool configurations, using the same structure as CreateAgent. Specifying only Name is not a valid tool configuration.
|
|
8090
|
+
* For official skills, specify only Source=OFFICIAL and SkillId. For official suites, specify only Source=OFFICIAL and SuiteId, without mixing in name, version, or artifact fields. The integer Version and VersionSelector for custom resources are mutually exclusive. The version selection capability depends on the deployment of the target server.
|
|
8091
|
+
* If PublishImmediately is omitted or set to false, only the definition is saved. If it is set to true, a new draft version is saved before requesting publication. Saving and publishing are not atomic operations. If publishing fails, the draft version may have already been incremented. In this case, call GetAgent to read the current version before deciding whether to retry, to avoid generating duplicate versions.
|
|
8092
|
+
*
|
|
8093
|
+
* @param tmpReq - UpdateAgentRequest
|
|
8094
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
8095
|
+
* @returns UpdateAgentResponse
|
|
8096
|
+
*/
|
|
8097
|
+
updateAgentWithOptions(tmpReq: $_model.UpdateAgentRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateAgentResponse>;
|
|
8098
|
+
/**
|
|
8099
|
+
* Updates the definition of a specified agent and increments the definition version, with the option to publish immediately. This operation is available only when the canary release feature is enabled. Before calling this operation, ensure that the canary release feature is enabled for the current account and the target region.
|
|
8100
|
+
*
|
|
8101
|
+
* @remarks
|
|
8102
|
+
* This operation is available only when the canary release feature is enabled. Before calling this operation, ensure that the canary release feature is enabled for the current account and the target region.
|
|
8103
|
+
* Updates a custom agent that the current identity has administrative permissions for. The Name parameter is used to locate the target agent and is not used for renaming. Call GetAgent first to read the current AgentVersion, and explicitly pass ExpectedVersion during the update. If a conflict occurs, re-read the version and verify the differences instead of blindly overwriting.
|
|
8104
|
+
* Omit reference lists that do not need to be modified. The current new backend retains existing references for empty arrays of Tools, Skills, and CallableAgents, but clears references for an empty array of ExpertSuites. A unified empty array clearing rule cannot be used. Tools already includes Kind and the corresponding tool configurations, using the same structure as CreateAgent. Specifying only Name is not a valid tool configuration.
|
|
8105
|
+
* For official skills, specify only Source=OFFICIAL and SkillId. For official suites, specify only Source=OFFICIAL and SuiteId, without mixing in name, version, or artifact fields. The integer Version and VersionSelector for custom resources are mutually exclusive. The version selection capability depends on the deployment of the target server.
|
|
8106
|
+
* If PublishImmediately is omitted or set to false, only the definition is saved. If it is set to true, a new draft version is saved before requesting publication. Saving and publishing are not atomic operations. If publishing fails, the draft version may have already been incremented. In this case, call GetAgent to read the current version before deciding whether to retry, to avoid generating duplicate versions.
|
|
8107
|
+
*
|
|
8108
|
+
* @param request - UpdateAgentRequest
|
|
8109
|
+
* @returns UpdateAgentResponse
|
|
8110
|
+
*/
|
|
8111
|
+
updateAgent(request: $_model.UpdateAgentRequest): Promise<$_model.UpdateAgentResponse>;
|
|
7802
8112
|
/**
|
|
7803
8113
|
* Modifies the title of an agent session accessible by the current identity without changing the task execution status.
|
|
7804
8114
|
*
|
|
@@ -7873,6 +8183,21 @@ export default class Client extends OpenApi {
|
|
|
7873
8183
|
* @returns UpdateCalendarResponse
|
|
7874
8184
|
*/
|
|
7875
8185
|
updateCalendar(request: $_model.UpdateCalendarRequest): Promise<$_model.UpdateCalendarResponse>;
|
|
8186
|
+
/**
|
|
8187
|
+
* Approves or rejects a code review.
|
|
8188
|
+
*
|
|
8189
|
+
* @param request - UpdateCodeReviewRequest
|
|
8190
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
8191
|
+
* @returns UpdateCodeReviewResponse
|
|
8192
|
+
*/
|
|
8193
|
+
updateCodeReviewWithOptions(request: $_model.UpdateCodeReviewRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateCodeReviewResponse>;
|
|
8194
|
+
/**
|
|
8195
|
+
* Approves or rejects a code review.
|
|
8196
|
+
*
|
|
8197
|
+
* @param request - UpdateCodeReviewRequest
|
|
8198
|
+
* @returns UpdateCodeReviewResponse
|
|
8199
|
+
*/
|
|
8200
|
+
updateCodeReview(request: $_model.UpdateCodeReviewRequest): Promise<$_model.UpdateCodeReviewResponse>;
|
|
7876
8201
|
/**
|
|
7877
8202
|
* Updates the business metadata for a column in a data map. This operation can only update the business description and custom attributes.
|
|
7878
8203
|
*
|
|
@@ -8062,10 +8387,10 @@ export default class Client extends OpenApi {
|
|
|
8062
8387
|
*/
|
|
8063
8388
|
updateDIJob(request: $_model.UpdateDIJobRequest): Promise<$_model.UpdateDIJobResponse>;
|
|
8064
8389
|
/**
|
|
8065
|
-
* Updates a
|
|
8390
|
+
* Updates a tag.
|
|
8066
8391
|
*
|
|
8067
8392
|
* @remarks
|
|
8068
|
-
* You must purchase DataWorks Enterprise Edition or a
|
|
8393
|
+
* You must purchase DataWorks Enterprise Edition or a later edition to use this feature.
|
|
8069
8394
|
*
|
|
8070
8395
|
* @param tmpReq - UpdateDataAssetTagRequest
|
|
8071
8396
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -8073,10 +8398,10 @@ export default class Client extends OpenApi {
|
|
|
8073
8398
|
*/
|
|
8074
8399
|
updateDataAssetTagWithOptions(tmpReq: $_model.UpdateDataAssetTagRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateDataAssetTagResponse>;
|
|
8075
8400
|
/**
|
|
8076
|
-
* Updates a
|
|
8401
|
+
* Updates a tag.
|
|
8077
8402
|
*
|
|
8078
8403
|
* @remarks
|
|
8079
|
-
* You must purchase DataWorks Enterprise Edition or a
|
|
8404
|
+
* You must purchase DataWorks Enterprise Edition or a later edition to use this feature.
|
|
8080
8405
|
*
|
|
8081
8406
|
* @param request - UpdateDataAssetTagRequest
|
|
8082
8407
|
* @returns UpdateDataAssetTagResponse
|
|
@@ -8488,11 +8813,11 @@ export default class Client extends OpenApi {
|
|
|
8488
8813
|
* Updates an existing approval process definition.
|
|
8489
8814
|
*
|
|
8490
8815
|
* @remarks
|
|
8491
|
-
* ## Request
|
|
8492
|
-
* -
|
|
8493
|
-
* -
|
|
8816
|
+
* ## Request description
|
|
8817
|
+
* - This operation allows you to modify an existing approval process definition, including the name, description, rule conditions, notification services, and approval nodes.
|
|
8818
|
+
* - `Id` is a required parameter used to specify the approval process definition to be updated.
|
|
8494
8819
|
* - To overwrite the existing configuration, set the `Overwrite` parameter to `true`.
|
|
8495
|
-
* -
|
|
8820
|
+
* - `ClientToken` is optional and used to ensure the idempotency of the request.
|
|
8496
8821
|
*
|
|
8497
8822
|
* @param tmpReq - UpdateProcessDefinitionRequest
|
|
8498
8823
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -8503,11 +8828,11 @@ export default class Client extends OpenApi {
|
|
|
8503
8828
|
* Updates an existing approval process definition.
|
|
8504
8829
|
*
|
|
8505
8830
|
* @remarks
|
|
8506
|
-
* ## Request
|
|
8507
|
-
* -
|
|
8508
|
-
* -
|
|
8831
|
+
* ## Request description
|
|
8832
|
+
* - This operation allows you to modify an existing approval process definition, including the name, description, rule conditions, notification services, and approval nodes.
|
|
8833
|
+
* - `Id` is a required parameter used to specify the approval process definition to be updated.
|
|
8509
8834
|
* - To overwrite the existing configuration, set the `Overwrite` parameter to `true`.
|
|
8510
|
-
* -
|
|
8835
|
+
* - `ClientToken` is optional and used to ensure the idempotency of the request.
|
|
8511
8836
|
*
|
|
8512
8837
|
* @param request - UpdateProcessDefinitionRequest
|
|
8513
8838
|
* @returns UpdateProcessDefinitionResponse
|
|
@@ -8748,10 +9073,10 @@ export default class Client extends OpenApi {
|
|
|
8748
9073
|
*/
|
|
8749
9074
|
updateTaskAsync(request: $_model.UpdateTaskAsyncRequest): Promise<$_model.UpdateTaskAsyncResponse>;
|
|
8750
9075
|
/**
|
|
8751
|
-
*
|
|
9076
|
+
* Modifies the properties of multiple node instances, including the priority, scheduling resource group, and data source.
|
|
8752
9077
|
*
|
|
8753
9078
|
* @remarks
|
|
8754
|
-
* You must purchase DataWorks Basic Edition or
|
|
9079
|
+
* You must purchase DataWorks Basic Edition or higher to use this feature.
|
|
8755
9080
|
*
|
|
8756
9081
|
* @param tmpReq - UpdateTaskInstancesRequest
|
|
8757
9082
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -8759,10 +9084,10 @@ export default class Client extends OpenApi {
|
|
|
8759
9084
|
*/
|
|
8760
9085
|
updateTaskInstancesWithOptions(tmpReq: $_model.UpdateTaskInstancesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateTaskInstancesResponse>;
|
|
8761
9086
|
/**
|
|
8762
|
-
*
|
|
9087
|
+
* Modifies the properties of multiple node instances, including the priority, scheduling resource group, and data source.
|
|
8763
9088
|
*
|
|
8764
9089
|
* @remarks
|
|
8765
|
-
* You must purchase DataWorks Basic Edition or
|
|
9090
|
+
* You must purchase DataWorks Basic Edition or higher to use this feature.
|
|
8766
9091
|
*
|
|
8767
9092
|
* @param request - UpdateTaskInstancesRequest
|
|
8768
9093
|
* @returns UpdateTaskInstancesResponse
|
|
@@ -8784,10 +9109,10 @@ export default class Client extends OpenApi {
|
|
|
8784
9109
|
*/
|
|
8785
9110
|
updateUdfFile(request: $_model.UpdateUdfFileRequest): Promise<$_model.UpdateUdfFileResponse>;
|
|
8786
9111
|
/**
|
|
8787
|
-
*
|
|
9112
|
+
* Performs a full update of the specified workflow. The owner, data source, scheduling resource group, description, and trigger run mode (normal, dry run, or paused) can be synchronized to Data Studio.
|
|
8788
9113
|
*
|
|
8789
9114
|
* @remarks
|
|
8790
|
-
* DataWorks Basic Edition or
|
|
9115
|
+
* You must purchase DataWorks Basic Edition or later to use this operation.
|
|
8791
9116
|
*
|
|
8792
9117
|
* @param tmpReq - UpdateWorkflowRequest
|
|
8793
9118
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -8795,10 +9120,10 @@ export default class Client extends OpenApi {
|
|
|
8795
9120
|
*/
|
|
8796
9121
|
updateWorkflowWithOptions(tmpReq: $_model.UpdateWorkflowRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateWorkflowResponse>;
|
|
8797
9122
|
/**
|
|
8798
|
-
*
|
|
9123
|
+
* Performs a full update of the specified workflow. The owner, data source, scheduling resource group, description, and trigger run mode (normal, dry run, or paused) can be synchronized to Data Studio.
|
|
8799
9124
|
*
|
|
8800
9125
|
* @remarks
|
|
8801
|
-
* DataWorks Basic Edition or
|
|
9126
|
+
* You must purchase DataWorks Basic Edition or later to use this operation.
|
|
8802
9127
|
*
|
|
8803
9128
|
* @param request - UpdateWorkflowRequest
|
|
8804
9129
|
* @returns UpdateWorkflowResponse
|
|
@@ -8827,6 +9152,27 @@ export default class Client extends OpenApi {
|
|
|
8827
9152
|
* @returns UpdateWorkflowDefinitionResponse
|
|
8828
9153
|
*/
|
|
8829
9154
|
updateWorkflowDefinition(request: $_model.UpdateWorkflowDefinitionRequest): Promise<$_model.UpdateWorkflowDefinitionResponse>;
|
|
9155
|
+
/**
|
|
9156
|
+
* 上传 Agent 会话附件
|
|
9157
|
+
*
|
|
9158
|
+
* @remarks
|
|
9159
|
+
* 将文件通过 OSS 上传到当前账号有权访问的 Agent 会话。先用 prepare 获取 5 分钟公网 PUT 签名,上传原始字节后用 complete 确认,由会话 runtime 下载、校验并写入工作目录。UploadMode 必填,不接受 ContentBase64。须同时检查 POP/BFF 外层错误与 JsonRpcResponse.Error。
|
|
9160
|
+
*
|
|
9161
|
+
* @param tmpReq - UploadAgentSessionFileRequest
|
|
9162
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
9163
|
+
* @returns UploadAgentSessionFileResponse
|
|
9164
|
+
*/
|
|
9165
|
+
uploadAgentSessionFileWithOptions(tmpReq: $_model.UploadAgentSessionFileRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UploadAgentSessionFileResponse>;
|
|
9166
|
+
/**
|
|
9167
|
+
* 上传 Agent 会话附件
|
|
9168
|
+
*
|
|
9169
|
+
* @remarks
|
|
9170
|
+
* 将文件通过 OSS 上传到当前账号有权访问的 Agent 会话。先用 prepare 获取 5 分钟公网 PUT 签名,上传原始字节后用 complete 确认,由会话 runtime 下载、校验并写入工作目录。UploadMode 必填,不接受 ContentBase64。须同时检查 POP/BFF 外层错误与 JsonRpcResponse.Error。
|
|
9171
|
+
*
|
|
9172
|
+
* @param request - UploadAgentSessionFileRequest
|
|
9173
|
+
* @returns UploadAgentSessionFileResponse
|
|
9174
|
+
*/
|
|
9175
|
+
uploadAgentSessionFile(request: $_model.UploadAgentSessionFileRequest): Promise<$_model.UploadAgentSessionFileResponse>;
|
|
8830
9176
|
/**
|
|
8831
9177
|
* Requests a temporary OSS PUT upload URL. Complete the PUT upload before the URL expires, then pass the returned FileId to the ReferenceFileIds parameter of CreateSemanticJob.
|
|
8832
9178
|
*
|