@alicloud/dataworks-public20240518 9.10.3 → 9.11.1
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 +236 -221
- package/dist/client.js +285 -221
- package/dist/client.js.map +1 -1
- package/dist/models/AbolishCrossProjectPipelineRunRequest.d.ts +3 -3
- package/dist/models/AbolishCrossProjectPipelineRunResponseBody.d.ts +2 -2
- package/dist/models/BuildImageRequest.d.ts +3 -3
- package/dist/models/BuildImageResponseBody.d.ts +4 -4
- package/dist/models/CancelImageTestRequest.d.ts +1 -1
- package/dist/models/CancelImageTestResponseBody.d.ts +3 -3
- package/dist/models/CreateAgentRequest.d.ts +102 -7
- package/dist/models/CreateAgentRequest.js +41 -1
- package/dist/models/CreateAgentRequest.js.map +1 -1
- package/dist/models/CreateAgentResponseBody.d.ts +124 -2
- package/dist/models/CreateAgentResponseBody.js +67 -1
- package/dist/models/CreateAgentResponseBody.js.map +1 -1
- package/dist/models/CreateAgentSessionRequest.d.ts +34 -22
- package/dist/models/CreateAgentSessionRequest.js +4 -0
- package/dist/models/CreateAgentSessionRequest.js.map +1 -1
- package/dist/models/CreateAgentSessionResponseBody.d.ts +60 -3
- package/dist/models/CreateAgentSessionResponseBody.js +33 -1
- package/dist/models/CreateAgentSessionResponseBody.js.map +1 -1
- package/dist/models/CreateAgentSessionShrinkRequest.d.ts +2 -2
- package/dist/models/CreateAgentShrinkRequest.d.ts +25 -6
- package/dist/models/CreateAgentShrinkRequest.js +4 -0
- package/dist/models/CreateAgentShrinkRequest.js.map +1 -1
- package/dist/models/CreateFileRequest.d.ts +85 -146
- package/dist/models/CreateFileRequest.js.map +1 -1
- package/dist/models/CreateFileResponseBody.d.ts +5 -4
- package/dist/models/CreateFileResponseBody.js.map +1 -1
- package/dist/models/DataQualityRuleTemplate.d.ts +3 -0
- package/dist/models/DataQualityRuleTemplate.js.map +1 -1
- package/dist/models/DeleteImageResponseBody.d.ts +3 -3
- package/dist/models/DeleteTaskRequest.d.ts +2 -8
- package/dist/models/DeleteTaskRequest.js.map +1 -1
- package/dist/models/DeleteTaskResponseBody.d.ts +2 -2
- package/dist/models/DisableImageResponseBody.d.ts +3 -3
- package/dist/models/EnableImageResponseBody.d.ts +3 -3
- package/dist/models/ExecPipelineRunStageRequest.d.ts +3 -3
- package/dist/models/ExecPipelineRunStageResponseBody.d.ts +4 -12
- package/dist/models/ExecPipelineRunStageResponseBody.js.map +1 -1
- package/dist/models/GetAgentRequest.d.ts +9 -1
- package/dist/models/GetAgentRequest.js +2 -0
- package/dist/models/GetAgentRequest.js.map +1 -1
- package/dist/models/GetAgentResponseBody.d.ts +155 -26
- package/dist/models/GetAgentResponseBody.js +51 -1
- package/dist/models/GetAgentResponseBody.js.map +1 -1
- package/dist/models/GetBatchChangeTableOwnerStatusRequest.d.ts +1 -1
- package/dist/models/GetBatchChangeTableOwnerStatusResponseBody.d.ts +5 -5
- package/dist/models/GetCatalogRequest.d.ts +5 -5
- package/dist/models/GetCatalogResponseBody.d.ts +1 -1
- package/dist/models/GetColumnRequest.d.ts +5 -5
- package/dist/models/GetComputeResourceAuthUserMappingsRequest.d.ts +1 -1
- package/dist/models/GetComputeResourceAuthUserMappingsResponseBody.d.ts +3 -3
- package/dist/models/GetCrossProjectPipelineRunRequest.d.ts +1 -1
- package/dist/models/GetCrossProjectPipelineRunResponseBody.d.ts +11 -17
- package/dist/models/GetCrossProjectPipelineRunResponseBody.js.map +1 -1
- package/dist/models/GetDataQualityEvaluationTaskInstanceRequest.d.ts +1 -1
- package/dist/models/GetDataQualityEvaluationTaskInstanceResponseBody.d.ts +383 -44
- package/dist/models/GetDataQualityEvaluationTaskInstanceResponseBody.js.map +1 -1
- package/dist/models/GetDijobRequest.d.ts +4 -4
- package/dist/models/GetDijobResponseBody.d.ts +190 -258
- package/dist/models/GetDijobResponseBody.js.map +1 -1
- package/dist/models/GetLineageRelationshipRequest.d.ts +1 -1
- package/dist/models/GetLineageRelationshipResponseBody.d.ts +1 -1
- package/dist/models/GetProjectMemberRequest.d.ts +3 -3
- package/dist/models/GetProjectMemberResponseBody.d.ts +26 -41
- package/dist/models/GetProjectMemberResponseBody.js.map +1 -1
- package/dist/models/GetSnapshotResponseBody.d.ts +4 -4
- package/dist/models/GetTableRequest.d.ts +16 -16
- package/dist/models/GetTableResponseBody.d.ts +1 -1
- package/dist/models/GetWorkflowRequest.d.ts +2 -6
- package/dist/models/GetWorkflowRequest.js.map +1 -1
- package/dist/models/GetWorkflowResponseBody.d.ts +76 -71
- package/dist/models/GetWorkflowResponseBody.js.map +1 -1
- package/dist/models/ListAgentSessionsRequest.d.ts +14 -7
- package/dist/models/ListAgentSessionsRequest.js +2 -0
- package/dist/models/ListAgentSessionsRequest.js.map +1 -1
- package/dist/models/ListAgentSessionsResponseBody.d.ts +63 -9
- package/dist/models/ListAgentSessionsResponseBody.js +33 -1
- package/dist/models/ListAgentSessionsResponseBody.js.map +1 -1
- package/dist/models/ListAgentSessionsShrinkRequest.d.ts +2 -2
- package/dist/models/ListDataQualityEvaluationTasksRequest.d.ts +5 -5
- package/dist/models/ListDataQualityEvaluationTasksResponseBody.d.ts +33 -31
- package/dist/models/ListDataQualityEvaluationTasksResponseBody.js.map +1 -1
- package/dist/models/ListDijobsRequest.d.ts +16 -18
- package/dist/models/ListDijobsRequest.js.map +1 -1
- package/dist/models/ListDijobsResponseBody.d.ts +31 -35
- package/dist/models/ListDijobsResponseBody.js.map +1 -1
- package/dist/models/ListDownstreamTasksRequest.d.ts +3 -9
- package/dist/models/ListDownstreamTasksRequest.js.map +1 -1
- package/dist/models/ListDownstreamTasksResponseBody.d.ts +96 -106
- package/dist/models/ListDownstreamTasksResponseBody.js.map +1 -1
- package/dist/models/ListProjectMembersRequest.d.ts +5 -5
- package/dist/models/ListProjectMembersResponseBody.d.ts +21 -18
- package/dist/models/ListProjectMembersResponseBody.js.map +1 -1
- package/dist/models/ListProjectMembersShrinkRequest.d.ts +5 -5
- package/dist/models/ListTablesRequest.d.ts +8 -8
- package/dist/models/ListTablesResponseBody.d.ts +2 -2
- package/dist/models/ListTablesShrinkRequest.d.ts +8 -8
- package/dist/models/ListTaskInstanceOperationLogsRequest.d.ts +3 -3
- package/dist/models/ListTaskInstanceOperationLogsResponseBody.d.ts +9 -7
- package/dist/models/ListTaskInstanceOperationLogsResponseBody.js.map +1 -1
- package/dist/models/LoadAgentSessionRequest.d.ts +7 -7
- package/dist/models/LoadAgentSessionResponseBody.d.ts +7 -7
- package/dist/models/LoadAgentSessionShrinkRequest.d.ts +3 -3
- package/dist/models/PromptAgentSessionRequest.d.ts +23 -21
- package/dist/models/PromptAgentSessionRequest.js.map +1 -1
- package/dist/models/PromptAgentSessionResponseBody.d.ts +80 -6
- package/dist/models/PromptAgentSessionResponseBody.js +55 -1
- package/dist/models/PromptAgentSessionResponseBody.js.map +1 -1
- package/dist/models/PromptAgentSessionShrinkRequest.d.ts +2 -2
- package/dist/models/RollbackImageRequest.d.ts +1 -1
- package/dist/models/RollbackImageResponseBody.d.ts +3 -3
- package/dist/models/StopTaskInstancesResponseBody.d.ts +2 -2
- package/dist/models/StopWorkflowInstancesRequest.d.ts +1 -1
- package/dist/models/StopWorkflowInstancesResponseBody.d.ts +2 -2
- package/dist/models/StopWorkflowInstancesShrinkRequest.d.ts +1 -1
- package/dist/models/SuspendTaskInstancesRequest.d.ts +2 -2
- package/dist/models/SuspendTaskInstancesResponseBody.d.ts +3 -3
- package/dist/models/SuspendTaskInstancesShrinkRequest.d.ts +2 -2
- package/dist/models/UpdateAgentSessionTitleRequest.d.ts +66 -0
- package/dist/models/UpdateAgentSessionTitleRequest.js +86 -0
- package/dist/models/UpdateAgentSessionTitleRequest.js.map +1 -0
- package/dist/models/UpdateAgentSessionTitleResponse.d.ts +19 -0
- package/dist/models/UpdateAgentSessionTitleResponse.js +69 -0
- package/dist/models/UpdateAgentSessionTitleResponse.js.map +1 -0
- package/dist/models/UpdateAgentSessionTitleResponseBody.d.ts +144 -0
- package/dist/models/UpdateAgentSessionTitleResponseBody.js +142 -0
- package/dist/models/UpdateAgentSessionTitleResponseBody.js.map +1 -0
- package/dist/models/UpdateAgentSessionTitleShrinkRequest.d.ts +34 -0
- package/dist/models/UpdateAgentSessionTitleShrinkRequest.js +62 -0
- package/dist/models/UpdateAgentSessionTitleShrinkRequest.js.map +1 -0
- package/dist/models/model.d.ts +16 -0
- package/dist/models/model.js +107 -75
- package/dist/models/model.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +295 -221
- package/src/models/AbolishCrossProjectPipelineRunRequest.ts +3 -3
- package/src/models/AbolishCrossProjectPipelineRunResponseBody.ts +2 -2
- package/src/models/BuildImageRequest.ts +3 -3
- package/src/models/BuildImageResponseBody.ts +4 -4
- package/src/models/CancelImageTestRequest.ts +1 -1
- package/src/models/CancelImageTestResponseBody.ts +3 -3
- package/src/models/CreateAgentRequest.ts +133 -7
- package/src/models/CreateAgentResponseBody.ts +172 -2
- package/src/models/CreateAgentSessionRequest.ts +38 -22
- package/src/models/CreateAgentSessionResponseBody.ts +83 -3
- package/src/models/CreateAgentSessionShrinkRequest.ts +2 -2
- package/src/models/CreateAgentShrinkRequest.ts +29 -6
- package/src/models/CreateFileRequest.ts +85 -146
- package/src/models/CreateFileResponseBody.ts +5 -4
- package/src/models/DataQualityRuleTemplate.ts +3 -0
- package/src/models/DeleteImageResponseBody.ts +3 -3
- package/src/models/DeleteTaskRequest.ts +2 -8
- package/src/models/DeleteTaskResponseBody.ts +2 -2
- package/src/models/DisableImageResponseBody.ts +3 -3
- package/src/models/EnableImageResponseBody.ts +3 -3
- package/src/models/ExecPipelineRunStageRequest.ts +3 -3
- package/src/models/ExecPipelineRunStageResponseBody.ts +4 -12
- package/src/models/GetAgentRequest.ts +11 -1
- package/src/models/GetAgentResponseBody.ts +196 -26
- package/src/models/GetBatchChangeTableOwnerStatusRequest.ts +1 -1
- package/src/models/GetBatchChangeTableOwnerStatusResponseBody.ts +5 -5
- package/src/models/GetCatalogRequest.ts +5 -5
- package/src/models/GetCatalogResponseBody.ts +1 -1
- package/src/models/GetColumnRequest.ts +5 -5
- package/src/models/GetComputeResourceAuthUserMappingsRequest.ts +1 -1
- package/src/models/GetComputeResourceAuthUserMappingsResponseBody.ts +3 -3
- package/src/models/GetCrossProjectPipelineRunRequest.ts +1 -1
- package/src/models/GetCrossProjectPipelineRunResponseBody.ts +11 -17
- package/src/models/GetDataQualityEvaluationTaskInstanceRequest.ts +1 -1
- package/src/models/GetDataQualityEvaluationTaskInstanceResponseBody.ts +383 -44
- package/src/models/GetDijobRequest.ts +4 -4
- package/src/models/GetDijobResponseBody.ts +190 -258
- package/src/models/GetLineageRelationshipRequest.ts +1 -1
- package/src/models/GetLineageRelationshipResponseBody.ts +1 -1
- package/src/models/GetProjectMemberRequest.ts +3 -3
- package/src/models/GetProjectMemberResponseBody.ts +26 -41
- package/src/models/GetSnapshotResponseBody.ts +4 -4
- package/src/models/GetTableRequest.ts +16 -16
- package/src/models/GetTableResponseBody.ts +1 -1
- package/src/models/GetWorkflowRequest.ts +2 -6
- package/src/models/GetWorkflowResponseBody.ts +76 -71
- package/src/models/ListAgentSessionsRequest.ts +16 -7
- package/src/models/ListAgentSessionsResponseBody.ts +86 -9
- package/src/models/ListAgentSessionsShrinkRequest.ts +2 -2
- package/src/models/ListDataQualityEvaluationTasksRequest.ts +5 -5
- package/src/models/ListDataQualityEvaluationTasksResponseBody.ts +33 -31
- package/src/models/ListDijobsRequest.ts +16 -18
- package/src/models/ListDijobsResponseBody.ts +31 -35
- package/src/models/ListDownstreamTasksRequest.ts +3 -9
- package/src/models/ListDownstreamTasksResponseBody.ts +96 -106
- package/src/models/ListProjectMembersRequest.ts +5 -5
- package/src/models/ListProjectMembersResponseBody.ts +21 -18
- package/src/models/ListProjectMembersShrinkRequest.ts +5 -5
- package/src/models/ListTablesRequest.ts +8 -8
- package/src/models/ListTablesResponseBody.ts +2 -2
- package/src/models/ListTablesShrinkRequest.ts +8 -8
- package/src/models/ListTaskInstanceOperationLogsRequest.ts +3 -3
- package/src/models/ListTaskInstanceOperationLogsResponseBody.ts +9 -7
- package/src/models/LoadAgentSessionRequest.ts +7 -7
- package/src/models/LoadAgentSessionResponseBody.ts +7 -7
- package/src/models/LoadAgentSessionShrinkRequest.ts +3 -3
- package/src/models/PromptAgentSessionRequest.ts +23 -21
- package/src/models/PromptAgentSessionResponseBody.ts +116 -6
- package/src/models/PromptAgentSessionShrinkRequest.ts +2 -2
- package/src/models/RollbackImageRequest.ts +1 -1
- package/src/models/RollbackImageResponseBody.ts +3 -3
- package/src/models/StopTaskInstancesResponseBody.ts +2 -2
- package/src/models/StopWorkflowInstancesRequest.ts +1 -1
- package/src/models/StopWorkflowInstancesResponseBody.ts +2 -2
- package/src/models/StopWorkflowInstancesShrinkRequest.ts +1 -1
- package/src/models/SuspendTaskInstancesRequest.ts +2 -2
- package/src/models/SuspendTaskInstancesResponseBody.ts +3 -3
- package/src/models/SuspendTaskInstancesShrinkRequest.ts +2 -2
- package/src/models/UpdateAgentSessionTitleRequest.ts +98 -0
- package/src/models/UpdateAgentSessionTitleResponse.ts +40 -0
- package/src/models/UpdateAgentSessionTitleResponseBody.ts +214 -0
- package/src/models/UpdateAgentSessionTitleShrinkRequest.ts +51 -0
- package/src/models/model.ts +16 -0
package/dist/client.d.ts
CHANGED
|
@@ -14,7 +14,7 @@ export default class Client extends OpenApi {
|
|
|
14
14
|
[key: string]: string;
|
|
15
15
|
}, endpoint: string): string;
|
|
16
16
|
/**
|
|
17
|
-
*
|
|
17
|
+
* Terminates a cross-workspace deployment pipeline run.
|
|
18
18
|
*
|
|
19
19
|
* @param request - AbolishCrossProjectPipelineRunRequest
|
|
20
20
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -22,7 +22,7 @@ export default class Client extends OpenApi {
|
|
|
22
22
|
*/
|
|
23
23
|
abolishCrossProjectPipelineRunWithOptions(request: $_model.AbolishCrossProjectPipelineRunRequest, runtime: $dara.RuntimeOptions): Promise<$_model.AbolishCrossProjectPipelineRunResponse>;
|
|
24
24
|
/**
|
|
25
|
-
*
|
|
25
|
+
* Terminates a cross-workspace deployment pipeline run.
|
|
26
26
|
*
|
|
27
27
|
* @param request - AbolishCrossProjectPipelineRunRequest
|
|
28
28
|
* @returns AbolishCrossProjectPipelineRunResponse
|
|
@@ -276,8 +276,8 @@ export default class Client extends OpenApi {
|
|
|
276
276
|
* Builds an image.
|
|
277
277
|
*
|
|
278
278
|
* @remarks
|
|
279
|
-
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this
|
|
280
|
-
* 2. **
|
|
279
|
+
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
|
|
280
|
+
* 2. **Ensure that the service-linked role AliyunServiceRoleForDataWorks is created before you call this API operation.**
|
|
281
281
|
*
|
|
282
282
|
* @param request - BuildImageRequest
|
|
283
283
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -288,8 +288,8 @@ export default class Client extends OpenApi {
|
|
|
288
288
|
* Builds an image.
|
|
289
289
|
*
|
|
290
290
|
* @remarks
|
|
291
|
-
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this
|
|
292
|
-
* 2. **
|
|
291
|
+
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
|
|
292
|
+
* 2. **Ensure that the service-linked role AliyunServiceRoleForDataWorks is created before you call this API operation.**
|
|
293
293
|
*
|
|
294
294
|
* @param request - BuildImageRequest
|
|
295
295
|
* @returns BuildImageResponse
|
|
@@ -324,7 +324,7 @@ export default class Client extends OpenApi {
|
|
|
324
324
|
* Cancels an image test.
|
|
325
325
|
*
|
|
326
326
|
* @remarks
|
|
327
|
-
* 1. You must purchase DataWorks Basic Edition or a
|
|
327
|
+
* 1. You must purchase DataWorks Basic Edition or a more advanced edition to use this feature.
|
|
328
328
|
* 2. **Make sure that the service-linked role AliyunServiceRoleForDataWorks is created before you call this operation.**
|
|
329
329
|
*
|
|
330
330
|
* @param request - CancelImageTestRequest
|
|
@@ -336,7 +336,7 @@ export default class Client extends OpenApi {
|
|
|
336
336
|
* Cancels an image test.
|
|
337
337
|
*
|
|
338
338
|
* @remarks
|
|
339
|
-
* 1. You must purchase DataWorks Basic Edition or a
|
|
339
|
+
* 1. You must purchase DataWorks Basic Edition or a more advanced edition to use this feature.
|
|
340
340
|
* 2. **Make sure that the service-linked role AliyunServiceRoleForDataWorks is created before you call this operation.**
|
|
341
341
|
*
|
|
342
342
|
* @param request - CancelImageTestRequest
|
|
@@ -372,12 +372,12 @@ export default class Client extends OpenApi {
|
|
|
372
372
|
* Creates an agent.
|
|
373
373
|
*
|
|
374
374
|
* @remarks
|
|
375
|
-
* ## Request
|
|
375
|
+
* ## Request instructions
|
|
376
376
|
* - **Agent name**: Must be unique within the current account.
|
|
377
|
-
* - **Model configuration**: Optional
|
|
378
|
-
* - **Visibility level**: Defines who can access the agent.
|
|
379
|
-
* - **Visibility scope**: When `PROJECT` or `USER` is selected as the visibility level, you must specify the specific project IDs or user
|
|
380
|
-
* - **Other parameters**:
|
|
377
|
+
* - **Model configuration**: Optional parameter used to specify the model used by the agent and its related settings.
|
|
378
|
+
* - **Visibility level**: Defines who can access the agent. Supports visibility within the account, project, or specific users.
|
|
379
|
+
* - **Visibility scope**: When `PROJECT` or `USER` is selected as the visibility level, you must further specify the specific project IDs or user ID lists.
|
|
380
|
+
* - **Other parameters**: Display name and description are optional and can be filled in as needed.
|
|
381
381
|
*
|
|
382
382
|
* @param tmpReq - CreateAgentRequest
|
|
383
383
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -388,29 +388,29 @@ export default class Client extends OpenApi {
|
|
|
388
388
|
* Creates an agent.
|
|
389
389
|
*
|
|
390
390
|
* @remarks
|
|
391
|
-
* ## Request
|
|
391
|
+
* ## Request instructions
|
|
392
392
|
* - **Agent name**: Must be unique within the current account.
|
|
393
|
-
* - **Model configuration**: Optional
|
|
394
|
-
* - **Visibility level**: Defines who can access the agent.
|
|
395
|
-
* - **Visibility scope**: When `PROJECT` or `USER` is selected as the visibility level, you must specify the specific project IDs or user
|
|
396
|
-
* - **Other parameters**:
|
|
393
|
+
* - **Model configuration**: Optional parameter used to specify the model used by the agent and its related settings.
|
|
394
|
+
* - **Visibility level**: Defines who can access the agent. Supports visibility within the account, project, or specific users.
|
|
395
|
+
* - **Visibility scope**: When `PROJECT` or `USER` is selected as the visibility level, you must further specify the specific project IDs or user ID lists.
|
|
396
|
+
* - **Other parameters**: Display name and description are optional and can be filled in as needed.
|
|
397
397
|
*
|
|
398
398
|
* @param request - CreateAgentRequest
|
|
399
399
|
* @returns CreateAgentResponse
|
|
400
400
|
*/
|
|
401
401
|
createAgent(request: $_model.CreateAgentRequest): Promise<$_model.CreateAgentResponse>;
|
|
402
402
|
/**
|
|
403
|
-
* Creates
|
|
403
|
+
* Creates an agent session and returns the session ID.
|
|
404
404
|
*
|
|
405
405
|
* @remarks
|
|
406
|
-
* ##
|
|
407
|
-
* - This operation creates
|
|
408
|
-
* -
|
|
409
|
-
* - dataworks_data_agent: DataWorks built-in agent
|
|
410
|
-
* - dataworks_chatbi_agent: DataWorks built-in agent
|
|
411
|
-
* - dataworks_ai_assistant_agent: DataWorks built-in agent
|
|
412
|
-
* -
|
|
413
|
-
* -
|
|
406
|
+
* ## Request description
|
|
407
|
+
* - This operation creates an agent session.
|
|
408
|
+
* - You must specify the name of the bound agent by using `_meta.agent.agentName`. This parameter is required.
|
|
409
|
+
* - 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
|
+
* - 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
|
+
* - 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 pass through the session source identifier by using `_meta.config.sessionSource` to facilitate subsequent retrieval by source.
|
|
413
|
+
* - You can pass session tags by using `_meta.config.sessionTags[].sessionTagCode`.
|
|
414
414
|
*
|
|
415
415
|
* @param tmpReq - CreateAgentSessionRequest
|
|
416
416
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -418,17 +418,17 @@ export default class Client extends OpenApi {
|
|
|
418
418
|
*/
|
|
419
419
|
createAgentSessionWithOptions(tmpReq: $_model.CreateAgentSessionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateAgentSessionResponse>;
|
|
420
420
|
/**
|
|
421
|
-
* Creates
|
|
421
|
+
* Creates an agent session and returns the session ID.
|
|
422
422
|
*
|
|
423
423
|
* @remarks
|
|
424
|
-
* ##
|
|
425
|
-
* - This operation creates
|
|
426
|
-
* -
|
|
427
|
-
* - dataworks_data_agent: DataWorks built-in agent
|
|
428
|
-
* - dataworks_chatbi_agent: DataWorks built-in agent
|
|
429
|
-
* - dataworks_ai_assistant_agent: DataWorks built-in agent
|
|
430
|
-
* -
|
|
431
|
-
* -
|
|
424
|
+
* ## Request description
|
|
425
|
+
* - This operation creates an agent session.
|
|
426
|
+
* - You must specify the name of the bound agent by using `_meta.agent.agentName`. This parameter is required.
|
|
427
|
+
* - 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
|
+
* - 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
|
+
* - 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 pass through the session source identifier by using `_meta.config.sessionSource` to facilitate subsequent retrieval by source.
|
|
431
|
+
* - You can pass session tags by using `_meta.config.sessionTags[].sessionTagCode`.
|
|
432
432
|
*
|
|
433
433
|
* @param request - CreateAgentSessionRequest
|
|
434
434
|
* @returns CreateAgentSessionResponse
|
|
@@ -936,7 +936,7 @@ export default class Client extends OpenApi {
|
|
|
936
936
|
*/
|
|
937
937
|
createDatasetVersion(request: $_model.CreateDatasetVersionRequest): Promise<$_model.CreateDatasetVersionResponse>;
|
|
938
938
|
/**
|
|
939
|
-
* Creates a file in Data Studio. This operation does not support creating
|
|
939
|
+
* Creates a file in Data Studio. This operation does not support creating data integration node tasks.
|
|
940
940
|
*
|
|
941
941
|
* @param request - CreateFileRequest
|
|
942
942
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -944,7 +944,7 @@ export default class Client extends OpenApi {
|
|
|
944
944
|
*/
|
|
945
945
|
createFileWithOptions(request: $_model.CreateFileRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateFileResponse>;
|
|
946
946
|
/**
|
|
947
|
-
* Creates a file in Data Studio. This operation does not support creating
|
|
947
|
+
* Creates a file in Data Studio. This operation does not support creating data integration node tasks.
|
|
948
948
|
*
|
|
949
949
|
* @param request - CreateFileRequest
|
|
950
950
|
* @returns CreateFileResponse
|
|
@@ -1868,9 +1868,6 @@ export default class Client extends OpenApi {
|
|
|
1868
1868
|
/**
|
|
1869
1869
|
* Deletes a data quality monitoring rule.
|
|
1870
1870
|
*
|
|
1871
|
-
* @remarks
|
|
1872
|
-
* 需要购买DataWorks基础版及以上版本才能使用
|
|
1873
|
-
*
|
|
1874
1871
|
* @param request - DeleteDataQualityRuleRequest
|
|
1875
1872
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
1876
1873
|
* @returns DeleteDataQualityRuleResponse
|
|
@@ -1879,9 +1876,6 @@ export default class Client extends OpenApi {
|
|
|
1879
1876
|
/**
|
|
1880
1877
|
* Deletes a data quality monitoring rule.
|
|
1881
1878
|
*
|
|
1882
|
-
* @remarks
|
|
1883
|
-
* 需要购买DataWorks基础版及以上版本才能使用
|
|
1884
|
-
*
|
|
1885
1879
|
* @param request - DeleteDataQualityRuleRequest
|
|
1886
1880
|
* @returns DeleteDataQualityRuleResponse
|
|
1887
1881
|
*/
|
|
@@ -2096,8 +2090,8 @@ export default class Client extends OpenApi {
|
|
|
2096
2090
|
* Deletes an image.
|
|
2097
2091
|
*
|
|
2098
2092
|
* @remarks
|
|
2099
|
-
* 1.
|
|
2100
|
-
* 2. **
|
|
2093
|
+
* 1. DataWorks Basic Edition or a higher edition is required.
|
|
2094
|
+
* 2. **Make sure that the service-linked role AliyunServiceRoleForDataWorks is created before you call this API operation.**
|
|
2101
2095
|
*
|
|
2102
2096
|
* @param request - DeleteImageRequest
|
|
2103
2097
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2108,8 +2102,8 @@ export default class Client extends OpenApi {
|
|
|
2108
2102
|
* Deletes an image.
|
|
2109
2103
|
*
|
|
2110
2104
|
* @remarks
|
|
2111
|
-
* 1.
|
|
2112
|
-
* 2. **
|
|
2105
|
+
* 1. DataWorks Basic Edition or a higher edition is required.
|
|
2106
|
+
* 2. **Make sure that the service-linked role AliyunServiceRoleForDataWorks is created before you call this API operation.**
|
|
2113
2107
|
*
|
|
2114
2108
|
* @param request - DeleteImageRequest
|
|
2115
2109
|
* @returns DeleteImageResponse
|
|
@@ -2538,10 +2532,10 @@ export default class Client extends OpenApi {
|
|
|
2538
2532
|
*/
|
|
2539
2533
|
deleteSkill(request: $_model.DeleteSkillRequest): Promise<$_model.DeleteSkillResponse>;
|
|
2540
2534
|
/**
|
|
2541
|
-
* Deletes a task.
|
|
2535
|
+
* Deletes a specified task.
|
|
2542
2536
|
*
|
|
2543
2537
|
* @remarks
|
|
2544
|
-
* You must purchase DataWorks Basic Edition or
|
|
2538
|
+
* You must purchase DataWorks Basic Edition or later to use this feature.
|
|
2545
2539
|
*
|
|
2546
2540
|
* @param request - DeleteTaskRequest
|
|
2547
2541
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2549,10 +2543,10 @@ export default class Client extends OpenApi {
|
|
|
2549
2543
|
*/
|
|
2550
2544
|
deleteTaskWithOptions(request: $_model.DeleteTaskRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteTaskResponse>;
|
|
2551
2545
|
/**
|
|
2552
|
-
* Deletes a task.
|
|
2546
|
+
* Deletes a specified task.
|
|
2553
2547
|
*
|
|
2554
2548
|
* @remarks
|
|
2555
|
-
* You must purchase DataWorks Basic Edition or
|
|
2549
|
+
* You must purchase DataWorks Basic Edition or later to use this feature.
|
|
2556
2550
|
*
|
|
2557
2551
|
* @param request - DeleteTaskRequest
|
|
2558
2552
|
* @returns DeleteTaskResponse
|
|
@@ -2644,8 +2638,8 @@ export default class Client extends OpenApi {
|
|
|
2644
2638
|
* Disables an image.
|
|
2645
2639
|
*
|
|
2646
2640
|
* @remarks
|
|
2647
|
-
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this operation.
|
|
2648
|
-
* 2. **
|
|
2641
|
+
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this API operation.
|
|
2642
|
+
* 2. **Make sure that the service-linked role AliyunServiceRoleForDataWorks is created before you call this API operation.**
|
|
2649
2643
|
*
|
|
2650
2644
|
* @param request - DisableImageRequest
|
|
2651
2645
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2656,8 +2650,8 @@ export default class Client extends OpenApi {
|
|
|
2656
2650
|
* Disables an image.
|
|
2657
2651
|
*
|
|
2658
2652
|
* @remarks
|
|
2659
|
-
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this operation.
|
|
2660
|
-
* 2. **
|
|
2653
|
+
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this API operation.
|
|
2654
|
+
* 2. **Make sure that the service-linked role AliyunServiceRoleForDataWorks is created before you call this API operation.**
|
|
2661
2655
|
*
|
|
2662
2656
|
* @param request - DisableImageRequest
|
|
2663
2657
|
* @returns DisableImageResponse
|
|
@@ -2778,7 +2772,7 @@ export default class Client extends OpenApi {
|
|
|
2778
2772
|
*
|
|
2779
2773
|
* @remarks
|
|
2780
2774
|
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
|
|
2781
|
-
* 2. **Make sure that the service-linked role AliyunServiceRoleForDataWorks
|
|
2775
|
+
* 2. **Make sure that you have created the service-linked role AliyunServiceRoleForDataWorks before you call this API operation.**
|
|
2782
2776
|
*
|
|
2783
2777
|
* @param request - EnableImageRequest
|
|
2784
2778
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2790,7 +2784,7 @@ export default class Client extends OpenApi {
|
|
|
2790
2784
|
*
|
|
2791
2785
|
* @remarks
|
|
2792
2786
|
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
|
|
2793
|
-
* 2. **Make sure that the service-linked role AliyunServiceRoleForDataWorks
|
|
2787
|
+
* 2. **Make sure that you have created the service-linked role AliyunServiceRoleForDataWorks before you call this API operation.**
|
|
2794
2788
|
*
|
|
2795
2789
|
* @param request - EnableImageRequest
|
|
2796
2790
|
* @returns EnableImageResponse
|
|
@@ -2850,12 +2844,12 @@ export default class Client extends OpenApi {
|
|
|
2850
2844
|
*/
|
|
2851
2845
|
execCrossProjectPipelineRun(request: $_model.ExecCrossProjectPipelineRunRequest): Promise<$_model.ExecCrossProjectPipelineRunResponse>;
|
|
2852
2846
|
/**
|
|
2853
|
-
* Executes a specified stage of a deployment
|
|
2847
|
+
* Executes a specified stage of a deployment pipeline.
|
|
2854
2848
|
*
|
|
2855
2849
|
* @remarks
|
|
2856
|
-
* >
|
|
2857
|
-
* >
|
|
2858
|
-
* >
|
|
2850
|
+
* >Notice: The stages in a deployment pipeline are sequential. For more information, see the return values of GetPipelineRun. You cannot skip or repeatedly execute a stage.
|
|
2851
|
+
* >Notice: The execution process is asynchronous. The return value only indicates whether the execution is successfully triggered, not whether the stage is successfully executed. The execution result is subject to the return values of GetPipelineRun.
|
|
2852
|
+
* >Notice: This operation may not be available in earlier SDK versions. In this case, use the ExecDeploymentStage operation, which uses the same parameters as described in this document.
|
|
2859
2853
|
*
|
|
2860
2854
|
* @param request - ExecPipelineRunStageRequest
|
|
2861
2855
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2863,12 +2857,12 @@ export default class Client extends OpenApi {
|
|
|
2863
2857
|
*/
|
|
2864
2858
|
execPipelineRunStageWithOptions(request: $_model.ExecPipelineRunStageRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ExecPipelineRunStageResponse>;
|
|
2865
2859
|
/**
|
|
2866
|
-
* Executes a specified stage of a deployment
|
|
2860
|
+
* Executes a specified stage of a deployment pipeline.
|
|
2867
2861
|
*
|
|
2868
2862
|
* @remarks
|
|
2869
|
-
* >
|
|
2870
|
-
* >
|
|
2871
|
-
* >
|
|
2863
|
+
* >Notice: The stages in a deployment pipeline are sequential. For more information, see the return values of GetPipelineRun. You cannot skip or repeatedly execute a stage.
|
|
2864
|
+
* >Notice: The execution process is asynchronous. The return value only indicates whether the execution is successfully triggered, not whether the stage is successfully executed. The execution result is subject to the return values of GetPipelineRun.
|
|
2865
|
+
* >Notice: This operation may not be available in earlier SDK versions. In this case, use the ExecDeploymentStage operation, which uses the same parameters as described in this document.
|
|
2872
2866
|
*
|
|
2873
2867
|
* @param request - ExecPipelineRunStageRequest
|
|
2874
2868
|
* @returns ExecPipelineRunStageResponse
|
|
@@ -2919,11 +2913,11 @@ export default class Client extends OpenApi {
|
|
|
2919
2913
|
*/
|
|
2920
2914
|
findBestMatchSecurityStrategy(request: $_model.FindBestMatchSecurityStrategyRequest): Promise<$_model.FindBestMatchSecurityStrategyResponse>;
|
|
2921
2915
|
/**
|
|
2922
|
-
* Retrieves
|
|
2916
|
+
* Retrieves the details of an agent.
|
|
2923
2917
|
*
|
|
2924
2918
|
* @remarks
|
|
2925
|
-
* ##
|
|
2926
|
-
* This
|
|
2919
|
+
* ## Operation description
|
|
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.
|
|
2927
2921
|
*
|
|
2928
2922
|
* @param request - GetAgentRequest
|
|
2929
2923
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2931,11 +2925,11 @@ export default class Client extends OpenApi {
|
|
|
2931
2925
|
*/
|
|
2932
2926
|
getAgentWithOptions(request: $_model.GetAgentRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetAgentResponse>;
|
|
2933
2927
|
/**
|
|
2934
|
-
* Retrieves
|
|
2928
|
+
* Retrieves the details of an agent.
|
|
2935
2929
|
*
|
|
2936
2930
|
* @remarks
|
|
2937
|
-
* ##
|
|
2938
|
-
* This
|
|
2931
|
+
* ## Operation description
|
|
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.
|
|
2939
2933
|
*
|
|
2940
2934
|
* @param request - GetAgentRequest
|
|
2941
2935
|
* @returns GetAgentResponse
|
|
@@ -3085,10 +3079,10 @@ export default class Client extends OpenApi {
|
|
|
3085
3079
|
*/
|
|
3086
3080
|
getCalendar(request: $_model.GetCalendarRequest): Promise<$_model.GetCalendarResponse>;
|
|
3087
3081
|
/**
|
|
3088
|
-
* Retrieves the details of a specified data catalog in DataWorks Data Map. Currently, DLF and StarRocks
|
|
3082
|
+
* Retrieves the details of a specified data catalog in DataWorks Data Map. Currently, DLF and StarRocks types are supported.
|
|
3089
3083
|
*
|
|
3090
3084
|
* @remarks
|
|
3091
|
-
* 1.
|
|
3085
|
+
* 1. DataWorks Basic Edition or a higher edition is required.
|
|
3092
3086
|
*
|
|
3093
3087
|
* @param request - GetCatalogRequest
|
|
3094
3088
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3096,10 +3090,10 @@ export default class Client extends OpenApi {
|
|
|
3096
3090
|
*/
|
|
3097
3091
|
getCatalogWithOptions(request: $_model.GetCatalogRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetCatalogResponse>;
|
|
3098
3092
|
/**
|
|
3099
|
-
* Retrieves the details of a specified data catalog in DataWorks Data Map. Currently, DLF and StarRocks
|
|
3093
|
+
* Retrieves the details of a specified data catalog in DataWorks Data Map. Currently, DLF and StarRocks types are supported.
|
|
3100
3094
|
*
|
|
3101
3095
|
* @remarks
|
|
3102
|
-
* 1.
|
|
3096
|
+
* 1. DataWorks Basic Edition or a higher edition is required.
|
|
3103
3097
|
*
|
|
3104
3098
|
* @param request - GetCatalogRequest
|
|
3105
3099
|
* @returns GetCatalogResponse
|
|
@@ -3129,10 +3123,10 @@ export default class Client extends OpenApi {
|
|
|
3129
3123
|
*/
|
|
3130
3124
|
getCertificate(request: $_model.GetCertificateRequest): Promise<$_model.GetCertificateResponse>;
|
|
3131
3125
|
/**
|
|
3132
|
-
* Retrieves the details of a specified column in a
|
|
3126
|
+
* Retrieves the details of a specified column in a Data Map table.
|
|
3133
3127
|
*
|
|
3134
3128
|
* @remarks
|
|
3135
|
-
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this operation.
|
|
3129
|
+
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this API operation.
|
|
3136
3130
|
*
|
|
3137
3131
|
* @param request - GetColumnRequest
|
|
3138
3132
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3140,10 +3134,10 @@ export default class Client extends OpenApi {
|
|
|
3140
3134
|
*/
|
|
3141
3135
|
getColumnWithOptions(request: $_model.GetColumnRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetColumnResponse>;
|
|
3142
3136
|
/**
|
|
3143
|
-
* Retrieves the details of a specified column in a
|
|
3137
|
+
* Retrieves the details of a specified column in a Data Map table.
|
|
3144
3138
|
*
|
|
3145
3139
|
* @remarks
|
|
3146
|
-
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this operation.
|
|
3140
|
+
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this API operation.
|
|
3147
3141
|
*
|
|
3148
3142
|
* @param request - GetColumnRequest
|
|
3149
3143
|
* @returns GetColumnResponse
|
|
@@ -3196,12 +3190,12 @@ export default class Client extends OpenApi {
|
|
|
3196
3190
|
*/
|
|
3197
3191
|
getComputeResource(request: $_model.GetComputeResourceRequest): Promise<$_model.GetComputeResourceResponse>;
|
|
3198
3192
|
/**
|
|
3199
|
-
* Queries the user mappings
|
|
3193
|
+
* Queries the user mappings for compute resources, supporting EMR and Serverless Spark resource types.
|
|
3200
3194
|
*
|
|
3201
3195
|
* @remarks
|
|
3202
|
-
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this
|
|
3196
|
+
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
|
|
3203
3197
|
* 2. You must have at least one of the following roles in the DataWorks workspace:
|
|
3204
|
-
* - Tenant
|
|
3198
|
+
* - Tenant owner, workspace administrator, deployer, developer, project owner, or operator.
|
|
3205
3199
|
*
|
|
3206
3200
|
* @param request - GetComputeResourceAuthUserMappingsRequest
|
|
3207
3201
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3209,12 +3203,12 @@ export default class Client extends OpenApi {
|
|
|
3209
3203
|
*/
|
|
3210
3204
|
getComputeResourceAuthUserMappingsWithOptions(request: $_model.GetComputeResourceAuthUserMappingsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetComputeResourceAuthUserMappingsResponse>;
|
|
3211
3205
|
/**
|
|
3212
|
-
* Queries the user mappings
|
|
3206
|
+
* Queries the user mappings for compute resources, supporting EMR and Serverless Spark resource types.
|
|
3213
3207
|
*
|
|
3214
3208
|
* @remarks
|
|
3215
|
-
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this
|
|
3209
|
+
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
|
|
3216
3210
|
* 2. You must have at least one of the following roles in the DataWorks workspace:
|
|
3217
|
-
* - Tenant
|
|
3211
|
+
* - Tenant owner, workspace administrator, deployer, developer, project owner, or operator.
|
|
3218
3212
|
*
|
|
3219
3213
|
* @param request - GetComputeResourceAuthUserMappingsRequest
|
|
3220
3214
|
* @returns GetComputeResourceAuthUserMappingsResponse
|
|
@@ -3318,7 +3312,7 @@ export default class Client extends OpenApi {
|
|
|
3318
3312
|
*/
|
|
3319
3313
|
getCreateWorkflowInstancesResult(request: $_model.GetCreateWorkflowInstancesResultRequest): Promise<$_model.GetCreateWorkflowInstancesResultResponse>;
|
|
3320
3314
|
/**
|
|
3321
|
-
* Queries the details of a cross-workspace deployment
|
|
3315
|
+
* Queries the details of a cross-workspace deployment pipeline run.
|
|
3322
3316
|
*
|
|
3323
3317
|
* @param request - GetCrossProjectPipelineRunRequest
|
|
3324
3318
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3326,7 +3320,7 @@ export default class Client extends OpenApi {
|
|
|
3326
3320
|
*/
|
|
3327
3321
|
getCrossProjectPipelineRunWithOptions(request: $_model.GetCrossProjectPipelineRunRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetCrossProjectPipelineRunResponse>;
|
|
3328
3322
|
/**
|
|
3329
|
-
* Queries the details of a cross-workspace deployment
|
|
3323
|
+
* Queries the details of a cross-workspace deployment pipeline run.
|
|
3330
3324
|
*
|
|
3331
3325
|
* @param request - GetCrossProjectPipelineRunRequest
|
|
3332
3326
|
* @returns GetCrossProjectPipelineRunResponse
|
|
@@ -3348,10 +3342,10 @@ export default class Client extends OpenApi {
|
|
|
3348
3342
|
*/
|
|
3349
3343
|
getCustomAttribute(request: $_model.GetCustomAttributeRequest): Promise<$_model.GetCustomAttributeResponse>;
|
|
3350
3344
|
/**
|
|
3351
|
-
*
|
|
3345
|
+
* Queries the details of a data integration task.
|
|
3352
3346
|
*
|
|
3353
3347
|
* @remarks
|
|
3354
|
-
*
|
|
3348
|
+
* DataWorks Basic Edition or a higher edition is required.
|
|
3355
3349
|
*
|
|
3356
3350
|
* @param request - GetDIJobRequest
|
|
3357
3351
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3359,10 +3353,10 @@ export default class Client extends OpenApi {
|
|
|
3359
3353
|
*/
|
|
3360
3354
|
getDIJobWithOptions(request: $_model.GetDIJobRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetDIJobResponse>;
|
|
3361
3355
|
/**
|
|
3362
|
-
*
|
|
3356
|
+
* Queries the details of a data integration task.
|
|
3363
3357
|
*
|
|
3364
3358
|
* @remarks
|
|
3365
|
-
*
|
|
3359
|
+
* DataWorks Basic Edition or a higher edition is required.
|
|
3366
3360
|
*
|
|
3367
3361
|
* @param request - GetDIJobRequest
|
|
3368
3362
|
* @returns GetDIJobResponse
|
|
@@ -3439,7 +3433,7 @@ export default class Client extends OpenApi {
|
|
|
3439
3433
|
* Retrieves the details of a data quality check task instance.
|
|
3440
3434
|
*
|
|
3441
3435
|
* @remarks
|
|
3442
|
-
* DataWorks Basic Edition or a higher edition is required
|
|
3436
|
+
* DataWorks Basic Edition or a higher edition is required.
|
|
3443
3437
|
*
|
|
3444
3438
|
* @deprecated OpenAPI GetDataQualityEvaluationTaskInstance is deprecated, please use dataworks-public::2024-05-18::GetDataQualityScanRun instead.
|
|
3445
3439
|
*
|
|
@@ -3452,7 +3446,7 @@ export default class Client extends OpenApi {
|
|
|
3452
3446
|
* Retrieves the details of a data quality check task instance.
|
|
3453
3447
|
*
|
|
3454
3448
|
* @remarks
|
|
3455
|
-
* DataWorks Basic Edition or a higher edition is required
|
|
3449
|
+
* DataWorks Basic Edition or a higher edition is required.
|
|
3456
3450
|
*
|
|
3457
3451
|
* @deprecated OpenAPI GetDataQualityEvaluationTaskInstance is deprecated, please use dataworks-public::2024-05-18::GetDataQualityScanRun instead.
|
|
3458
3452
|
*
|
|
@@ -3825,7 +3819,7 @@ export default class Client extends OpenApi {
|
|
|
3825
3819
|
* Retrieves the details of a specified lineage relationship in DataWorks Data Map.
|
|
3826
3820
|
*
|
|
3827
3821
|
* @remarks
|
|
3828
|
-
* 1. You must
|
|
3822
|
+
* 1. You must purchase DataWorks Standard Edition or a higher edition to use this operation.
|
|
3829
3823
|
*
|
|
3830
3824
|
* @param request - GetLineageRelationshipRequest
|
|
3831
3825
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3836,7 +3830,7 @@ export default class Client extends OpenApi {
|
|
|
3836
3830
|
* Retrieves the details of a specified lineage relationship in DataWorks Data Map.
|
|
3837
3831
|
*
|
|
3838
3832
|
* @remarks
|
|
3839
|
-
* 1. You must
|
|
3833
|
+
* 1. You must purchase DataWorks Standard Edition or a higher edition to use this operation.
|
|
3840
3834
|
*
|
|
3841
3835
|
* @param request - GetLineageRelationshipRequest
|
|
3842
3836
|
* @returns GetLineageRelationshipResponse
|
|
@@ -4097,10 +4091,10 @@ export default class Client extends OpenApi {
|
|
|
4097
4091
|
*/
|
|
4098
4092
|
getProject(request: $_model.GetProjectRequest): Promise<$_model.GetProjectResponse>;
|
|
4099
4093
|
/**
|
|
4100
|
-
*
|
|
4094
|
+
* Queries the details of a workspace member.
|
|
4101
4095
|
*
|
|
4102
4096
|
* @remarks
|
|
4103
|
-
*
|
|
4097
|
+
* You must purchase DataWorks Basic Edition or a higher edition to use this feature.
|
|
4104
4098
|
*
|
|
4105
4099
|
* @param request - GetProjectMemberRequest
|
|
4106
4100
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4108,10 +4102,10 @@ export default class Client extends OpenApi {
|
|
|
4108
4102
|
*/
|
|
4109
4103
|
getProjectMemberWithOptions(request: $_model.GetProjectMemberRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetProjectMemberResponse>;
|
|
4110
4104
|
/**
|
|
4111
|
-
*
|
|
4105
|
+
* Queries the details of a workspace member.
|
|
4112
4106
|
*
|
|
4113
4107
|
* @remarks
|
|
4114
|
-
*
|
|
4108
|
+
* You must purchase DataWorks Basic Edition or a higher edition to use this feature.
|
|
4115
4109
|
*
|
|
4116
4110
|
* @param request - GetProjectMemberRequest
|
|
4117
4111
|
* @returns GetProjectMemberResponse
|
|
@@ -4396,10 +4390,10 @@ export default class Client extends OpenApi {
|
|
|
4396
4390
|
*/
|
|
4397
4391
|
getSnapshot(request: $_model.GetSnapshotRequest): Promise<$_model.GetSnapshotResponse>;
|
|
4398
4392
|
/**
|
|
4399
|
-
*
|
|
4393
|
+
* Queries the details of a specified table in DataWorks Data Map. You can choose whether to return business metadata.
|
|
4400
4394
|
*
|
|
4401
4395
|
* @remarks
|
|
4402
|
-
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this
|
|
4396
|
+
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this API.
|
|
4403
4397
|
*
|
|
4404
4398
|
* @param request - GetTableRequest
|
|
4405
4399
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4407,10 +4401,10 @@ export default class Client extends OpenApi {
|
|
|
4407
4401
|
*/
|
|
4408
4402
|
getTableWithOptions(request: $_model.GetTableRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetTableResponse>;
|
|
4409
4403
|
/**
|
|
4410
|
-
*
|
|
4404
|
+
* Queries the details of a specified table in DataWorks Data Map. You can choose whether to return business metadata.
|
|
4411
4405
|
*
|
|
4412
4406
|
* @remarks
|
|
4413
|
-
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this
|
|
4407
|
+
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this API.
|
|
4414
4408
|
*
|
|
4415
4409
|
* @param request - GetTableRequest
|
|
4416
4410
|
* @returns GetTableResponse
|
|
@@ -4501,10 +4495,10 @@ export default class Client extends OpenApi {
|
|
|
4501
4495
|
*/
|
|
4502
4496
|
getUpdateTaskResult(request: $_model.GetUpdateTaskResultRequest): Promise<$_model.GetUpdateTaskResultResponse>;
|
|
4503
4497
|
/**
|
|
4504
|
-
*
|
|
4498
|
+
* Retrieves the details of a specified workflow.
|
|
4505
4499
|
*
|
|
4506
4500
|
* @remarks
|
|
4507
|
-
*
|
|
4501
|
+
* This feature requires DataWorks Basic Edition or later.
|
|
4508
4502
|
*
|
|
4509
4503
|
* @param request - GetWorkflowRequest
|
|
4510
4504
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4512,10 +4506,10 @@ export default class Client extends OpenApi {
|
|
|
4512
4506
|
*/
|
|
4513
4507
|
getWorkflowWithOptions(request: $_model.GetWorkflowRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetWorkflowResponse>;
|
|
4514
4508
|
/**
|
|
4515
|
-
*
|
|
4509
|
+
* Retrieves the details of a specified workflow.
|
|
4516
4510
|
*
|
|
4517
4511
|
* @remarks
|
|
4518
|
-
*
|
|
4512
|
+
* This feature requires DataWorks Basic Edition or later.
|
|
4519
4513
|
*
|
|
4520
4514
|
* @param request - GetWorkflowRequest
|
|
4521
4515
|
* @returns GetWorkflowResponse
|
|
@@ -4690,15 +4684,15 @@ export default class Client extends OpenApi {
|
|
|
4690
4684
|
*/
|
|
4691
4685
|
listAgentSessionArtifacts(request: $_model.ListAgentSessionArtifactsRequest): Promise<$_model.ListAgentSessionArtifactsResponse>;
|
|
4692
4686
|
/**
|
|
4693
|
-
*
|
|
4687
|
+
* Retrieves the conversation history list of agent sessions.
|
|
4694
4688
|
*
|
|
4695
4689
|
* @remarks
|
|
4696
|
-
* ##
|
|
4697
|
-
* -
|
|
4698
|
-
* -
|
|
4699
|
-
* - The response
|
|
4700
|
-
* - If
|
|
4701
|
-
* - By default, 50 records are returned per page.
|
|
4690
|
+
* ## Request description
|
|
4691
|
+
* - You must specify at least one of agentName and sessionSourceList.
|
|
4692
|
+
* - You can combine tagList, sessionId, and sessionTitle for filtering.
|
|
4693
|
+
* - The response follows the Alibaba Cloud OpenAPI paging specification, including totalCount, maxResults, nextToken, and sessionList.
|
|
4694
|
+
* - If nextToken is an invalid string, it is processed as 1 by default.
|
|
4695
|
+
* - By default, 50 records are returned per page. You can adjust this by using the maxResults parameter.
|
|
4702
4696
|
*
|
|
4703
4697
|
* @param tmpReq - ListAgentSessionsRequest
|
|
4704
4698
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4706,15 +4700,15 @@ export default class Client extends OpenApi {
|
|
|
4706
4700
|
*/
|
|
4707
4701
|
listAgentSessionsWithOptions(tmpReq: $_model.ListAgentSessionsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListAgentSessionsResponse>;
|
|
4708
4702
|
/**
|
|
4709
|
-
*
|
|
4703
|
+
* Retrieves the conversation history list of agent sessions.
|
|
4710
4704
|
*
|
|
4711
4705
|
* @remarks
|
|
4712
|
-
* ##
|
|
4713
|
-
* -
|
|
4714
|
-
* -
|
|
4715
|
-
* - The response
|
|
4716
|
-
* - If
|
|
4717
|
-
* - By default, 50 records are returned per page.
|
|
4706
|
+
* ## Request description
|
|
4707
|
+
* - You must specify at least one of agentName and sessionSourceList.
|
|
4708
|
+
* - You can combine tagList, sessionId, and sessionTitle for filtering.
|
|
4709
|
+
* - The response follows the Alibaba Cloud OpenAPI paging specification, including totalCount, maxResults, nextToken, and sessionList.
|
|
4710
|
+
* - If nextToken is an invalid string, it is processed as 1 by default.
|
|
4711
|
+
* - By default, 50 records are returned per page. You can adjust this by using the maxResults parameter.
|
|
4718
4712
|
*
|
|
4719
4713
|
* @param request - ListAgentSessionsRequest
|
|
4720
4714
|
* @returns ListAgentSessionsResponse
|
|
@@ -5207,10 +5201,10 @@ export default class Client extends OpenApi {
|
|
|
5207
5201
|
*/
|
|
5208
5202
|
listDIJobRunDetails(request: $_model.ListDIJobRunDetailsRequest): Promise<$_model.ListDIJobRunDetailsResponse>;
|
|
5209
5203
|
/**
|
|
5210
|
-
*
|
|
5204
|
+
* Queries synchronization tasks in the new version of Data Integration, including full-database real-time synchronization tasks, full-database batch synchronization tasks, and single-table real-time synchronization tasks.
|
|
5211
5205
|
*
|
|
5212
5206
|
* @remarks
|
|
5213
|
-
*
|
|
5207
|
+
* You must purchase DataWorks Basic Edition or a higher edition to use this operation.
|
|
5214
5208
|
*
|
|
5215
5209
|
* @param request - ListDIJobsRequest
|
|
5216
5210
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5218,10 +5212,10 @@ export default class Client extends OpenApi {
|
|
|
5218
5212
|
*/
|
|
5219
5213
|
listDIJobsWithOptions(request: $_model.ListDIJobsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListDIJobsResponse>;
|
|
5220
5214
|
/**
|
|
5221
|
-
*
|
|
5215
|
+
* Queries synchronization tasks in the new version of Data Integration, including full-database real-time synchronization tasks, full-database batch synchronization tasks, and single-table real-time synchronization tasks.
|
|
5222
5216
|
*
|
|
5223
5217
|
* @remarks
|
|
5224
|
-
*
|
|
5218
|
+
* You must purchase DataWorks Basic Edition or a higher edition to use this operation.
|
|
5225
5219
|
*
|
|
5226
5220
|
* @param request - ListDIJobsRequest
|
|
5227
5221
|
* @returns ListDIJobsResponse
|
|
@@ -5316,10 +5310,10 @@ export default class Client extends OpenApi {
|
|
|
5316
5310
|
*/
|
|
5317
5311
|
listDataQualityEvaluationTaskInstances(request: $_model.ListDataQualityEvaluationTaskInstancesRequest): Promise<$_model.ListDataQualityEvaluationTaskInstancesResponse>;
|
|
5318
5312
|
/**
|
|
5319
|
-
*
|
|
5313
|
+
* Performs a paging query on the data quality monitoring task list.
|
|
5320
5314
|
*
|
|
5321
5315
|
* @remarks
|
|
5322
|
-
* You must purchase DataWorks Basic Edition or
|
|
5316
|
+
* You must purchase DataWorks Basic Edition or later to use this feature.
|
|
5323
5317
|
*
|
|
5324
5318
|
* @deprecated OpenAPI ListDataQualityEvaluationTasks is deprecated, please use dataworks-public::2024-05-18::ListDataQualityScans instead.
|
|
5325
5319
|
*
|
|
@@ -5329,10 +5323,10 @@ export default class Client extends OpenApi {
|
|
|
5329
5323
|
*/
|
|
5330
5324
|
listDataQualityEvaluationTasksWithOptions(request: $_model.ListDataQualityEvaluationTasksRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListDataQualityEvaluationTasksResponse>;
|
|
5331
5325
|
/**
|
|
5332
|
-
*
|
|
5326
|
+
* Performs a paging query on the data quality monitoring task list.
|
|
5333
5327
|
*
|
|
5334
5328
|
* @remarks
|
|
5335
|
-
* You must purchase DataWorks Basic Edition or
|
|
5329
|
+
* You must purchase DataWorks Basic Edition or later to use this feature.
|
|
5336
5330
|
*
|
|
5337
5331
|
* @deprecated OpenAPI ListDataQualityEvaluationTasks is deprecated, please use dataworks-public::2024-05-18::ListDataQualityScans instead.
|
|
5338
5332
|
*
|
|
@@ -5633,10 +5627,10 @@ export default class Client extends OpenApi {
|
|
|
5633
5627
|
*/
|
|
5634
5628
|
listDownstreamTaskInstances(request: $_model.ListDownstreamTaskInstancesRequest): Promise<$_model.ListDownstreamTaskInstancesResponse>;
|
|
5635
5629
|
/**
|
|
5636
|
-
*
|
|
5630
|
+
* Retrieves a paginated list of downstream nodes for a specified node.
|
|
5637
5631
|
*
|
|
5638
5632
|
* @remarks
|
|
5639
|
-
*
|
|
5633
|
+
* DataWorks Basic Edition or later is required.
|
|
5640
5634
|
*
|
|
5641
5635
|
* @param request - ListDownstreamTasksRequest
|
|
5642
5636
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5644,10 +5638,10 @@ export default class Client extends OpenApi {
|
|
|
5644
5638
|
*/
|
|
5645
5639
|
listDownstreamTasksWithOptions(request: $_model.ListDownstreamTasksRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListDownstreamTasksResponse>;
|
|
5646
5640
|
/**
|
|
5647
|
-
*
|
|
5641
|
+
* Retrieves a paginated list of downstream nodes for a specified node.
|
|
5648
5642
|
*
|
|
5649
5643
|
* @remarks
|
|
5650
|
-
*
|
|
5644
|
+
* DataWorks Basic Edition or later is required.
|
|
5651
5645
|
*
|
|
5652
5646
|
* @param request - ListDownstreamTasksRequest
|
|
5653
5647
|
* @returns ListDownstreamTasksResponse
|
|
@@ -6259,10 +6253,10 @@ export default class Client extends OpenApi {
|
|
|
6259
6253
|
*/
|
|
6260
6254
|
listProcessDefinitions(request: $_model.ListProcessDefinitionsRequest): Promise<$_model.ListProcessDefinitionsResponse>;
|
|
6261
6255
|
/**
|
|
6262
|
-
*
|
|
6256
|
+
* Performs a paging query on the details of workspace members.
|
|
6263
6257
|
*
|
|
6264
6258
|
* @remarks
|
|
6265
|
-
*
|
|
6259
|
+
* You must purchase DataWorks Basic Edition or a higher edition to use this operation.
|
|
6266
6260
|
*
|
|
6267
6261
|
* @param tmpReq - ListProjectMembersRequest
|
|
6268
6262
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -6270,10 +6264,10 @@ export default class Client extends OpenApi {
|
|
|
6270
6264
|
*/
|
|
6271
6265
|
listProjectMembersWithOptions(tmpReq: $_model.ListProjectMembersRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListProjectMembersResponse>;
|
|
6272
6266
|
/**
|
|
6273
|
-
*
|
|
6267
|
+
* Performs a paging query on the details of workspace members.
|
|
6274
6268
|
*
|
|
6275
6269
|
* @remarks
|
|
6276
|
-
*
|
|
6270
|
+
* You must purchase DataWorks Basic Edition or a higher edition to use this operation.
|
|
6277
6271
|
*
|
|
6278
6272
|
* @param request - ListProjectMembersRequest
|
|
6279
6273
|
* @returns ListProjectMembersResponse
|
|
@@ -6660,10 +6654,10 @@ export default class Client extends OpenApi {
|
|
|
6660
6654
|
*/
|
|
6661
6655
|
listSnapshots(request: $_model.ListSnapshotsRequest): Promise<$_model.ListSnapshotsResponse>;
|
|
6662
6656
|
/**
|
|
6663
|
-
* Queries
|
|
6657
|
+
* Queries a list of data tables in DataWorks Data Map. For data source types that do not support the schema level, this operation queries data tables in a specified database. For data source types that support the schema level, this operation queries data tables in a specified database, MaxCompute project, or schema. The response includes only basic information about the data tables and excludes technical and business metadata. For non-MaxCompute data sources, the response is not real-time and may be delayed by up to one hour compared to the metadata collection results.
|
|
6664
6658
|
*
|
|
6665
6659
|
* @remarks
|
|
6666
|
-
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this
|
|
6660
|
+
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this operation.
|
|
6667
6661
|
*
|
|
6668
6662
|
* @param tmpReq - ListTablesRequest
|
|
6669
6663
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -6671,21 +6665,21 @@ export default class Client extends OpenApi {
|
|
|
6671
6665
|
*/
|
|
6672
6666
|
listTablesWithOptions(tmpReq: $_model.ListTablesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListTablesResponse>;
|
|
6673
6667
|
/**
|
|
6674
|
-
* Queries
|
|
6668
|
+
* Queries a list of data tables in DataWorks Data Map. For data source types that do not support the schema level, this operation queries data tables in a specified database. For data source types that support the schema level, this operation queries data tables in a specified database, MaxCompute project, or schema. The response includes only basic information about the data tables and excludes technical and business metadata. For non-MaxCompute data sources, the response is not real-time and may be delayed by up to one hour compared to the metadata collection results.
|
|
6675
6669
|
*
|
|
6676
6670
|
* @remarks
|
|
6677
|
-
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this
|
|
6671
|
+
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this operation.
|
|
6678
6672
|
*
|
|
6679
6673
|
* @param request - ListTablesRequest
|
|
6680
6674
|
* @returns ListTablesResponse
|
|
6681
6675
|
*/
|
|
6682
6676
|
listTables(request: $_model.ListTablesRequest): Promise<$_model.ListTablesResponse>;
|
|
6683
6677
|
/**
|
|
6684
|
-
* Retrieves a paginated list of operation logs for a
|
|
6678
|
+
* Retrieves a paginated list of operation logs for a specified node instance.
|
|
6685
6679
|
*
|
|
6686
6680
|
* @remarks
|
|
6687
|
-
* DataWorks Basic Edition or
|
|
6688
|
-
*
|
|
6681
|
+
* You must purchase DataWorks Basic Edition or later to use this API.
|
|
6682
|
+
* You can only query operation logs generated within the past 31 days.
|
|
6689
6683
|
*
|
|
6690
6684
|
* @param request - ListTaskInstanceOperationLogsRequest
|
|
6691
6685
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -6693,11 +6687,11 @@ export default class Client extends OpenApi {
|
|
|
6693
6687
|
*/
|
|
6694
6688
|
listTaskInstanceOperationLogsWithOptions(request: $_model.ListTaskInstanceOperationLogsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListTaskInstanceOperationLogsResponse>;
|
|
6695
6689
|
/**
|
|
6696
|
-
* Retrieves a paginated list of operation logs for a
|
|
6690
|
+
* Retrieves a paginated list of operation logs for a specified node instance.
|
|
6697
6691
|
*
|
|
6698
6692
|
* @remarks
|
|
6699
|
-
* DataWorks Basic Edition or
|
|
6700
|
-
*
|
|
6693
|
+
* You must purchase DataWorks Basic Edition or later to use this API.
|
|
6694
|
+
* You can only query operation logs generated within the past 31 days.
|
|
6701
6695
|
*
|
|
6702
6696
|
* @param request - ListTaskInstanceOperationLogsRequest
|
|
6703
6697
|
* @returns ListTaskInstanceOperationLogsResponse
|
|
@@ -6868,15 +6862,15 @@ export default class Client extends OpenApi {
|
|
|
6868
6862
|
*/
|
|
6869
6863
|
listWorkflows(request: $_model.ListWorkflowsRequest): Promise<$_model.ListWorkflowsResponse>;
|
|
6870
6864
|
/**
|
|
6871
|
-
* Loads the
|
|
6865
|
+
* Loads the historical messages of an existing session and returns them in a Server-Sent Events (SSE) stream. If the session does not exist, a JSONRPCResponse.error with a code of 400 is output through SSE. The Content-Type is text/event-stream. This operation applies to session context restoration scenarios.
|
|
6872
6866
|
*
|
|
6873
6867
|
* @remarks
|
|
6874
|
-
* ## Request
|
|
6875
|
-
* - This operation
|
|
6876
|
-
* - If the target session does not exist,
|
|
6877
|
-
* - The response
|
|
6878
|
-
* - The
|
|
6879
|
-
* - The returned content
|
|
6868
|
+
* ## Request description
|
|
6869
|
+
* - This operation is used to recover the details of a specified session and return the agent response in a Server-Sent Events (SSE) stream.
|
|
6870
|
+
* - If the target session does not exist, an error frame with an error code of 400 is returned.
|
|
6871
|
+
* - The response contains process information about how the agent handles the request, such as message chunks, reasoning steps, and tool call status updates.
|
|
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 turn limit and being canceled.
|
|
6873
|
+
* - The returned content complies with the open-source Agent Client Protocol (ACP) specification. For more information, see https://agentclientprotocol.com.
|
|
6880
6874
|
*
|
|
6881
6875
|
* @param tmpReq - LoadAgentSessionRequest
|
|
6882
6876
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -6884,15 +6878,15 @@ export default class Client extends OpenApi {
|
|
|
6884
6878
|
*/
|
|
6885
6879
|
loadAgentSessionWithSSE(tmpReq: $_model.LoadAgentSessionRequest, runtime: $dara.RuntimeOptions): AsyncGenerator<$_model.LoadAgentSessionResponse, any, unknown>;
|
|
6886
6880
|
/**
|
|
6887
|
-
* Loads the
|
|
6881
|
+
* Loads the historical messages of an existing session and returns them in a Server-Sent Events (SSE) stream. If the session does not exist, a JSONRPCResponse.error with a code of 400 is output through SSE. The Content-Type is text/event-stream. This operation applies to session context restoration scenarios.
|
|
6888
6882
|
*
|
|
6889
6883
|
* @remarks
|
|
6890
|
-
* ## Request
|
|
6891
|
-
* - This operation
|
|
6892
|
-
* - If the target session does not exist,
|
|
6893
|
-
* - The response
|
|
6894
|
-
* - The
|
|
6895
|
-
* - The returned content
|
|
6884
|
+
* ## Request description
|
|
6885
|
+
* - This operation is used to recover the details of a specified session and return the agent response in a Server-Sent Events (SSE) stream.
|
|
6886
|
+
* - If the target session does not exist, an error frame with an error code of 400 is returned.
|
|
6887
|
+
* - The response contains process information about how the agent handles the request, such as message chunks, reasoning steps, and tool call status updates.
|
|
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 turn limit and being canceled.
|
|
6889
|
+
* - The returned content complies with the open-source Agent Client Protocol (ACP) specification. For more information, see https://agentclientprotocol.com.
|
|
6896
6890
|
*
|
|
6897
6891
|
* @param tmpReq - LoadAgentSessionRequest
|
|
6898
6892
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -6900,15 +6894,15 @@ export default class Client extends OpenApi {
|
|
|
6900
6894
|
*/
|
|
6901
6895
|
loadAgentSessionWithOptions(tmpReq: $_model.LoadAgentSessionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.LoadAgentSessionResponse>;
|
|
6902
6896
|
/**
|
|
6903
|
-
* Loads the
|
|
6897
|
+
* Loads the historical messages of an existing session and returns them in a Server-Sent Events (SSE) stream. If the session does not exist, a JSONRPCResponse.error with a code of 400 is output through SSE. The Content-Type is text/event-stream. This operation applies to session context restoration scenarios.
|
|
6904
6898
|
*
|
|
6905
6899
|
* @remarks
|
|
6906
|
-
* ## Request
|
|
6907
|
-
* - This operation
|
|
6908
|
-
* - If the target session does not exist,
|
|
6909
|
-
* - The response
|
|
6910
|
-
* - The
|
|
6911
|
-
* - The returned content
|
|
6900
|
+
* ## Request description
|
|
6901
|
+
* - This operation is used to recover the details of a specified session and return the agent response in a Server-Sent Events (SSE) stream.
|
|
6902
|
+
* - If the target session does not exist, an error frame with an error code of 400 is returned.
|
|
6903
|
+
* - The response contains process information about how the agent handles the request, such as message chunks, reasoning steps, and tool call status updates.
|
|
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 turn limit and being canceled.
|
|
6905
|
+
* - The returned content complies with the open-source Agent Client Protocol (ACP) specification. For more information, see https://agentclientprotocol.com.
|
|
6912
6906
|
*
|
|
6913
6907
|
* @param request - LoadAgentSessionRequest
|
|
6914
6908
|
* @returns LoadAgentSessionResponse
|
|
@@ -6996,18 +6990,18 @@ export default class Client extends OpenApi {
|
|
|
6996
6990
|
*/
|
|
6997
6991
|
previewDatasetVersion(request: $_model.PreviewDatasetVersionRequest): Promise<$_model.PreviewDatasetVersionResponse>;
|
|
6998
6992
|
/**
|
|
6999
|
-
* Sends a user prompt to an existing session and
|
|
6993
|
+
* Sends a user prompt to an existing session and streams the agent response.
|
|
7000
6994
|
*
|
|
7001
6995
|
* @remarks
|
|
7002
|
-
* ##
|
|
7003
|
-
* - This API sends a user prompt to a specified session ID and accepts the
|
|
7004
|
-
* - The response may include message
|
|
7005
|
-
* - If the specified session does not exist, a 400 fault is returned
|
|
7006
|
-
* - The
|
|
7007
|
-
* - Multiple types of content blocks are supported as prompt
|
|
7008
|
-
* - You can optionally provide additional
|
|
7009
|
-
* - The returned content
|
|
7010
|
-
* - **Before
|
|
6996
|
+
* ## Request description
|
|
6997
|
+
* - This API operation sends a user prompt to a specified session ID and accepts the response from the agent in a streaming manner by using Server-Sent Events (SSE).
|
|
6998
|
+
* - The response may include information such as message chunks, thinking procedures, and tool calling status updates.
|
|
6999
|
+
* - If the specified session does not exist, a 400 fault is returned in an SSE fault frame.
|
|
7000
|
+
* - The stopReason field indicates the reason why the agent stopped the current conversation.
|
|
7001
|
+
* - Multiple types of content blocks are supported as prompt inputs, such as text and OSS file download links.
|
|
7002
|
+
* - You can optionally provide additional metadata in the Meta field to pass more context to the server.
|
|
7003
|
+
* - The returned content complies with the open-source Agent Client Protocol (ACP) specification. For more information, see https://agentclientprotocol.com.
|
|
7004
|
+
* - **Before you invoke this operation, make sure that you fully understand the billing methods and pricing of the Data Agent product**: https://www.alibabacloud.com/help/en/dataworks/dataworks-data-agent-agent-billing
|
|
7011
7005
|
*
|
|
7012
7006
|
* @param tmpReq - PromptAgentSessionRequest
|
|
7013
7007
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -7015,18 +7009,18 @@ export default class Client extends OpenApi {
|
|
|
7015
7009
|
*/
|
|
7016
7010
|
promptAgentSessionWithSSE(tmpReq: $_model.PromptAgentSessionRequest, runtime: $dara.RuntimeOptions): AsyncGenerator<$_model.PromptAgentSessionResponse, any, unknown>;
|
|
7017
7011
|
/**
|
|
7018
|
-
* Sends a user prompt to an existing session and
|
|
7012
|
+
* Sends a user prompt to an existing session and streams the agent response.
|
|
7019
7013
|
*
|
|
7020
7014
|
* @remarks
|
|
7021
|
-
* ##
|
|
7022
|
-
* - This API sends a user prompt to a specified session ID and accepts the
|
|
7023
|
-
* - The response may include message
|
|
7024
|
-
* - If the specified session does not exist, a 400 fault is returned
|
|
7025
|
-
* - The
|
|
7026
|
-
* - Multiple types of content blocks are supported as prompt
|
|
7027
|
-
* - You can optionally provide additional
|
|
7028
|
-
* - The returned content
|
|
7029
|
-
* - **Before
|
|
7015
|
+
* ## Request description
|
|
7016
|
+
* - This API operation sends a user prompt to a specified session ID and accepts the response from the agent in a streaming manner by using Server-Sent Events (SSE).
|
|
7017
|
+
* - The response may include information such as message chunks, thinking procedures, and tool calling status updates.
|
|
7018
|
+
* - If the specified session does not exist, a 400 fault is returned in an SSE fault frame.
|
|
7019
|
+
* - The stopReason field indicates the reason why the agent stopped the current conversation.
|
|
7020
|
+
* - Multiple types of content blocks are supported as prompt inputs, such as text and OSS file download links.
|
|
7021
|
+
* - You can optionally provide additional metadata in the Meta field to pass more context to the server.
|
|
7022
|
+
* - The returned content complies with the open-source Agent Client Protocol (ACP) specification. For more information, see https://agentclientprotocol.com.
|
|
7023
|
+
* - **Before you invoke this operation, make sure that you fully understand the billing methods and pricing of the Data Agent product**: https://www.alibabacloud.com/help/en/dataworks/dataworks-data-agent-agent-billing
|
|
7030
7024
|
*
|
|
7031
7025
|
* @param tmpReq - PromptAgentSessionRequest
|
|
7032
7026
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -7034,18 +7028,18 @@ export default class Client extends OpenApi {
|
|
|
7034
7028
|
*/
|
|
7035
7029
|
promptAgentSessionWithOptions(tmpReq: $_model.PromptAgentSessionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.PromptAgentSessionResponse>;
|
|
7036
7030
|
/**
|
|
7037
|
-
* Sends a user prompt to an existing session and
|
|
7031
|
+
* Sends a user prompt to an existing session and streams the agent response.
|
|
7038
7032
|
*
|
|
7039
7033
|
* @remarks
|
|
7040
|
-
* ##
|
|
7041
|
-
* - This API sends a user prompt to a specified session ID and accepts the
|
|
7042
|
-
* - The response may include message
|
|
7043
|
-
* - If the specified session does not exist, a 400 fault is returned
|
|
7044
|
-
* - The
|
|
7045
|
-
* - Multiple types of content blocks are supported as prompt
|
|
7046
|
-
* - You can optionally provide additional
|
|
7047
|
-
* - The returned content
|
|
7048
|
-
* - **Before
|
|
7034
|
+
* ## Request description
|
|
7035
|
+
* - This API operation sends a user prompt to a specified session ID and accepts the response from the agent in a streaming manner by using Server-Sent Events (SSE).
|
|
7036
|
+
* - The response may include information such as message chunks, thinking procedures, and tool calling status updates.
|
|
7037
|
+
* - If the specified session does not exist, a 400 fault is returned in an SSE fault frame.
|
|
7038
|
+
* - The stopReason field indicates the reason why the agent stopped the current conversation.
|
|
7039
|
+
* - Multiple types of content blocks are supported as prompt inputs, such as text and OSS file download links.
|
|
7040
|
+
* - You can optionally provide additional metadata in the Meta field to pass more context to the server.
|
|
7041
|
+
* - The returned content complies with the open-source Agent Client Protocol (ACP) specification. For more information, see https://agentclientprotocol.com.
|
|
7042
|
+
* - **Before you invoke this operation, make sure that you fully understand the billing methods and pricing of the Data Agent product**: https://www.alibabacloud.com/help/en/dataworks/dataworks-data-agent-agent-billing
|
|
7049
7043
|
*
|
|
7050
7044
|
* @param request - PromptAgentSessionRequest
|
|
7051
7045
|
* @returns PromptAgentSessionResponse
|
|
@@ -7281,8 +7275,8 @@ export default class Client extends OpenApi {
|
|
|
7281
7275
|
* Rolls back an image.
|
|
7282
7276
|
*
|
|
7283
7277
|
* @remarks
|
|
7284
|
-
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this
|
|
7285
|
-
* 2. **Before
|
|
7278
|
+
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
|
|
7279
|
+
* 2. **Before you call this operation, make sure that the service-linked role AliyunServiceRoleForDataWorks is created.**
|
|
7286
7280
|
*
|
|
7287
7281
|
* @param request - RollbackImageRequest
|
|
7288
7282
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -7293,8 +7287,8 @@ export default class Client extends OpenApi {
|
|
|
7293
7287
|
* Rolls back an image.
|
|
7294
7288
|
*
|
|
7295
7289
|
* @remarks
|
|
7296
|
-
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this
|
|
7297
|
-
* 2. **Before
|
|
7290
|
+
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
|
|
7291
|
+
* 2. **Before you call this operation, make sure that the service-linked role AliyunServiceRoleForDataWorks is created.**
|
|
7298
7292
|
*
|
|
7299
7293
|
* @param request - RollbackImageRequest
|
|
7300
7294
|
* @returns RollbackImageResponse
|
|
@@ -7617,14 +7611,14 @@ export default class Client extends OpenApi {
|
|
|
7617
7611
|
*/
|
|
7618
7612
|
stopServerIdeInstance(request: $_model.StopServerIdeInstanceRequest): Promise<$_model.StopServerIdeInstanceResponse>;
|
|
7619
7613
|
/**
|
|
7620
|
-
*
|
|
7614
|
+
* Terminates multiple task instances.
|
|
7621
7615
|
*
|
|
7622
7616
|
* @remarks
|
|
7623
|
-
* DataWorks Basic Edition or
|
|
7624
|
-
*
|
|
7625
|
-
* 1.
|
|
7626
|
-
* 2. The
|
|
7627
|
-
* 3. Pay special attention to MaxCompute tasks that use shared
|
|
7617
|
+
* You must purchase DataWorks Basic Edition or a higher edition to use this feature.
|
|
7618
|
+
* Instance termination mechanism and precautions:
|
|
7619
|
+
* 1. Instance termination is an asynchronous operation. A termination request does not immediately stop the instance. Continue to query the instance status after the request to confirm the termination result. If external compute resources are involved, verify the actual status of the remote job.
|
|
7620
|
+
* 2. The DataWorks instance status may differ from the remote job status. For tasks that depend 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 or client compatibility issues, a DataWorks instance may be marked as failed while the remote job is still running. Therefore, do not rely solely on the DataWorks instance status to determine whether the remote job has stopped. Check the corresponding compute platform and manually terminate the job if necessary to prevent it from continuing to run or consuming extra resources.
|
|
7621
|
+
* 3. Pay special attention to MaxCompute tasks that use shared resource groups for scheduling. DataWorks shared resource groups for scheduling will soon be retired. Due to component version and compatibility limits, termination commands for some MaxCompute tasks may not take effect on the remote end. If this occurs, check the actual status of the corresponding instance in MaxCompute. If the instance is still running, run a kill command in MaxCompute and verify that the instance has stopped.
|
|
7628
7622
|
*
|
|
7629
7623
|
* @param tmpReq - StopTaskInstancesRequest
|
|
7630
7624
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -7632,24 +7626,24 @@ export default class Client extends OpenApi {
|
|
|
7632
7626
|
*/
|
|
7633
7627
|
stopTaskInstancesWithOptions(tmpReq: $_model.StopTaskInstancesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.StopTaskInstancesResponse>;
|
|
7634
7628
|
/**
|
|
7635
|
-
*
|
|
7629
|
+
* Terminates multiple task instances.
|
|
7636
7630
|
*
|
|
7637
7631
|
* @remarks
|
|
7638
|
-
* DataWorks Basic Edition or
|
|
7639
|
-
*
|
|
7640
|
-
* 1.
|
|
7641
|
-
* 2. The
|
|
7642
|
-
* 3. Pay special attention to MaxCompute tasks that use shared
|
|
7632
|
+
* You must purchase DataWorks Basic Edition or a higher edition to use this feature.
|
|
7633
|
+
* Instance termination mechanism and precautions:
|
|
7634
|
+
* 1. Instance termination is an asynchronous operation. A termination request does not immediately stop the instance. Continue to query the instance status after the request to confirm the termination result. If external compute resources are involved, verify the actual status of the remote job.
|
|
7635
|
+
* 2. The DataWorks instance status may differ from the remote job status. For tasks that depend 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 or client compatibility issues, a DataWorks instance may be marked as failed while the remote job is still running. Therefore, do not rely solely on the DataWorks instance status to determine whether the remote job has stopped. Check the corresponding compute platform and manually terminate the job if necessary to prevent it from continuing to run or consuming extra resources.
|
|
7636
|
+
* 3. Pay special attention to MaxCompute tasks that use shared resource groups for scheduling. DataWorks shared resource groups for scheduling will soon be retired. Due to component version and compatibility limits, termination commands for some MaxCompute tasks may not take effect on the remote end. If this occurs, check the actual status of the corresponding instance in MaxCompute. If the instance is still running, run a kill command in MaxCompute and verify that the instance has stopped.
|
|
7643
7637
|
*
|
|
7644
7638
|
* @param request - StopTaskInstancesRequest
|
|
7645
7639
|
* @returns StopTaskInstancesResponse
|
|
7646
7640
|
*/
|
|
7647
7641
|
stopTaskInstances(request: $_model.StopTaskInstancesRequest): Promise<$_model.StopTaskInstancesResponse>;
|
|
7648
7642
|
/**
|
|
7649
|
-
* Terminates multiple workflow instances
|
|
7643
|
+
* Terminates multiple workflow instances.
|
|
7650
7644
|
*
|
|
7651
7645
|
* @remarks
|
|
7652
|
-
* You must purchase DataWorks Basic Edition or
|
|
7646
|
+
* You must purchase DataWorks Basic Edition or a higher edition to use this operation.
|
|
7653
7647
|
*
|
|
7654
7648
|
* @param tmpReq - StopWorkflowInstancesRequest
|
|
7655
7649
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -7657,10 +7651,10 @@ export default class Client extends OpenApi {
|
|
|
7657
7651
|
*/
|
|
7658
7652
|
stopWorkflowInstancesWithOptions(tmpReq: $_model.StopWorkflowInstancesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.StopWorkflowInstancesResponse>;
|
|
7659
7653
|
/**
|
|
7660
|
-
* Terminates multiple workflow instances
|
|
7654
|
+
* Terminates multiple workflow instances.
|
|
7661
7655
|
*
|
|
7662
7656
|
* @remarks
|
|
7663
|
-
* You must purchase DataWorks Basic Edition or
|
|
7657
|
+
* You must purchase DataWorks Basic Edition or a higher edition to use this operation.
|
|
7664
7658
|
*
|
|
7665
7659
|
* @param request - StopWorkflowInstancesRequest
|
|
7666
7660
|
* @returns StopWorkflowInstancesResponse
|
|
@@ -7697,7 +7691,7 @@ export default class Client extends OpenApi {
|
|
|
7697
7691
|
*/
|
|
7698
7692
|
submitFile(request: $_model.SubmitFileRequest): Promise<$_model.SubmitFileResponse>;
|
|
7699
7693
|
/**
|
|
7700
|
-
*
|
|
7694
|
+
* Pauses multiple task instances.
|
|
7701
7695
|
*
|
|
7702
7696
|
* @remarks
|
|
7703
7697
|
* You must purchase DataWorks Basic Edition or a higher edition to use this operation.
|
|
@@ -7708,7 +7702,7 @@ export default class Client extends OpenApi {
|
|
|
7708
7702
|
*/
|
|
7709
7703
|
suspendTaskInstancesWithOptions(tmpReq: $_model.SuspendTaskInstancesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.SuspendTaskInstancesResponse>;
|
|
7710
7704
|
/**
|
|
7711
|
-
*
|
|
7705
|
+
* Pauses multiple task instances.
|
|
7712
7706
|
*
|
|
7713
7707
|
* @remarks
|
|
7714
7708
|
* You must purchase DataWorks Basic Edition or a higher edition to use this operation.
|
|
@@ -7805,6 +7799,27 @@ export default class Client extends OpenApi {
|
|
|
7805
7799
|
* @returns UnTagDataAssetsResponse
|
|
7806
7800
|
*/
|
|
7807
7801
|
unTagDataAssets(request: $_model.UnTagDataAssetsRequest): Promise<$_model.UnTagDataAssetsResponse>;
|
|
7802
|
+
/**
|
|
7803
|
+
* Modifies the title of an agent session accessible by the current identity without changing the task execution status.
|
|
7804
|
+
*
|
|
7805
|
+
* @remarks
|
|
7806
|
+
* Modifies the title of an agent session accessible by the current identity without changing the task execution status.
|
|
7807
|
+
*
|
|
7808
|
+
* @param tmpReq - UpdateAgentSessionTitleRequest
|
|
7809
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
7810
|
+
* @returns UpdateAgentSessionTitleResponse
|
|
7811
|
+
*/
|
|
7812
|
+
updateAgentSessionTitleWithOptions(tmpReq: $_model.UpdateAgentSessionTitleRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateAgentSessionTitleResponse>;
|
|
7813
|
+
/**
|
|
7814
|
+
* Modifies the title of an agent session accessible by the current identity without changing the task execution status.
|
|
7815
|
+
*
|
|
7816
|
+
* @remarks
|
|
7817
|
+
* Modifies the title of an agent session accessible by the current identity without changing the task execution status.
|
|
7818
|
+
*
|
|
7819
|
+
* @param request - UpdateAgentSessionTitleRequest
|
|
7820
|
+
* @returns UpdateAgentSessionTitleResponse
|
|
7821
|
+
*/
|
|
7822
|
+
updateAgentSessionTitle(request: $_model.UpdateAgentSessionTitleRequest): Promise<$_model.UpdateAgentSessionTitleResponse>;
|
|
7808
7823
|
/**
|
|
7809
7824
|
* Updates the information about a custom alert monitoring rule.
|
|
7810
7825
|
*
|