@alicloud/dataworks-public20240518 8.8.5 → 9.0.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 +327 -88
- package/dist/client.js +679 -88
- package/dist/client.js.map +1 -1
- package/dist/models/CreateAgentRequest.d.ts +72 -12
- package/dist/models/CreateAgentRequest.js +61 -4
- package/dist/models/CreateAgentRequest.js.map +1 -1
- package/dist/models/CreateAgentResponseBody.d.ts +4 -4
- package/dist/models/CreateAgentSessionRequest.d.ts +32 -10
- package/dist/models/CreateAgentSessionRequest.js.map +1 -1
- package/dist/models/CreateAgentSessionResponseBody.d.ts +4 -4
- package/dist/models/CreateAgentSessionShrinkRequest.d.ts +2 -2
- package/dist/models/CreateAgentShrinkRequest.d.ts +7 -7
- package/dist/models/CreateFileRequest.d.ts +86 -92
- package/dist/models/CreateFileRequest.js +2 -0
- package/dist/models/CreateFileRequest.js.map +1 -1
- package/dist/models/CreateFileResponseBody.d.ts +4 -5
- package/dist/models/CreateFileResponseBody.js.map +1 -1
- package/dist/models/CreateSemanticJobRequest.d.ts +63 -0
- package/dist/models/CreateSemanticJobRequest.js +77 -0
- package/dist/models/CreateSemanticJobRequest.js.map +1 -0
- package/dist/models/CreateSemanticJobResponse.d.ts +19 -0
- package/dist/models/CreateSemanticJobResponse.js +69 -0
- package/dist/models/CreateSemanticJobResponse.js.map +1 -0
- package/dist/models/CreateSemanticJobResponseBody.d.ts +132 -0
- package/dist/models/CreateSemanticJobResponseBody.js +115 -0
- package/dist/models/CreateSemanticJobResponseBody.js.map +1 -0
- package/dist/models/CreateSemanticJobShrinkRequest.d.ts +61 -0
- package/dist/models/CreateSemanticJobShrinkRequest.js +68 -0
- package/dist/models/CreateSemanticJobShrinkRequest.js.map +1 -0
- package/dist/models/CreateSkillRequest.d.ts +35 -0
- package/dist/models/CreateSkillRequest.js.map +1 -1
- package/dist/models/CreateSkillResponseBody.d.ts +41 -0
- package/dist/models/CreateSkillResponseBody.js.map +1 -1
- package/dist/models/CreateSkillShrinkRequest.d.ts +27 -0
- package/dist/models/CreateSkillShrinkRequest.js.map +1 -1
- package/dist/models/DeleteAgentRequest.d.ts +2 -0
- package/dist/models/DeleteAgentRequest.js.map +1 -1
- package/dist/models/DeleteAgentResponseBody.d.ts +3 -0
- package/dist/models/DeleteAgentResponseBody.js.map +1 -1
- package/dist/models/DeleteMetaEntityDefRequest.d.ts +8 -0
- package/dist/models/DeleteMetaEntityDefRequest.js.map +1 -1
- package/dist/models/DeleteMetaEntityDefResponseBody.d.ts +6 -0
- package/dist/models/DeleteMetaEntityDefResponseBody.js.map +1 -1
- package/dist/models/DeleteSemanticJobRequest.d.ts +23 -0
- package/dist/models/DeleteSemanticJobRequest.js +58 -0
- package/dist/models/DeleteSemanticJobRequest.js.map +1 -0
- package/dist/models/DeleteSemanticJobResponse.d.ts +19 -0
- package/dist/models/DeleteSemanticJobResponse.js +69 -0
- package/dist/models/DeleteSemanticJobResponse.js.map +1 -0
- package/dist/models/DeleteSemanticJobResponseBody.d.ts +72 -0
- package/dist/models/DeleteSemanticJobResponseBody.js +90 -0
- package/dist/models/DeleteSemanticJobResponseBody.js.map +1 -0
- package/dist/models/DownloadSemanticResultsRequest.d.ts +31 -0
- package/dist/models/DownloadSemanticResultsRequest.js +60 -0
- package/dist/models/DownloadSemanticResultsRequest.js.map +1 -0
- package/dist/models/DownloadSemanticResultsResponse.d.ts +19 -0
- package/dist/models/DownloadSemanticResultsResponse.js +69 -0
- package/dist/models/DownloadSemanticResultsResponse.js.map +1 -0
- package/dist/models/DownloadSemanticResultsResponseBody.d.ts +84 -0
- package/dist/models/DownloadSemanticResultsResponseBody.js +110 -0
- package/dist/models/DownloadSemanticResultsResponseBody.js.map +1 -0
- package/dist/models/GetSemanticJobDetailRequest.d.ts +33 -0
- package/dist/models/GetSemanticJobDetailRequest.js +60 -0
- package/dist/models/GetSemanticJobDetailRequest.js.map +1 -0
- package/dist/models/GetSemanticJobDetailResponse.d.ts +19 -0
- package/dist/models/GetSemanticJobDetailResponse.js +69 -0
- package/dist/models/GetSemanticJobDetailResponse.js.map +1 -0
- package/dist/models/GetSemanticJobDetailResponseBody.d.ts +139 -0
- package/dist/models/GetSemanticJobDetailResponseBody.js +120 -0
- package/dist/models/GetSemanticJobDetailResponseBody.js.map +1 -0
- package/dist/models/GetSemanticJobLogRequest.d.ts +33 -0
- package/dist/models/GetSemanticJobLogRequest.js +60 -0
- package/dist/models/GetSemanticJobLogRequest.js.map +1 -0
- package/dist/models/GetSemanticJobLogResponse.d.ts +19 -0
- package/dist/models/GetSemanticJobLogResponse.js +69 -0
- package/dist/models/GetSemanticJobLogResponse.js.map +1 -0
- package/dist/models/GetSemanticJobLogResponseBody.d.ts +56 -0
- package/dist/models/GetSemanticJobLogResponseBody.js +86 -0
- package/dist/models/GetSemanticJobLogResponseBody.js.map +1 -0
- package/dist/models/ImportWorkflowDefinitionRequest.d.ts +10 -5
- package/dist/models/ImportWorkflowDefinitionRequest.js.map +1 -1
- package/dist/models/ImportWorkflowDefinitionResponseBody.d.ts +3 -3
- package/dist/models/KillSemanticJobRequest.d.ts +41 -0
- package/dist/models/KillSemanticJobRequest.js +62 -0
- package/dist/models/KillSemanticJobRequest.js.map +1 -0
- package/dist/models/KillSemanticJobResponse.d.ts +19 -0
- package/dist/models/KillSemanticJobResponse.js +69 -0
- package/dist/models/KillSemanticJobResponse.js.map +1 -0
- package/dist/models/KillSemanticJobResponseBody.d.ts +31 -0
- package/dist/models/KillSemanticJobResponseBody.js +62 -0
- package/dist/models/KillSemanticJobResponseBody.js.map +1 -0
- package/dist/models/ListDataQualityTemplatesRequest.d.ts +4 -4
- package/dist/models/ListDataQualityTemplatesResponseBody.d.ts +8 -8
- package/dist/models/ListSemanticJobRunsRequest.d.ts +39 -0
- package/dist/models/ListSemanticJobRunsRequest.js +62 -0
- package/dist/models/ListSemanticJobRunsRequest.js.map +1 -0
- package/dist/models/ListSemanticJobRunsResponse.d.ts +19 -0
- package/dist/models/ListSemanticJobRunsResponse.js +69 -0
- package/dist/models/ListSemanticJobRunsResponse.js.map +1 -0
- package/dist/models/ListSemanticJobRunsResponseBody.d.ts +124 -0
- package/dist/models/ListSemanticJobRunsResponseBody.js +120 -0
- package/dist/models/ListSemanticJobRunsResponseBody.js.map +1 -0
- package/dist/models/ListSemanticJobsRequest.d.ts +29 -0
- package/dist/models/ListSemanticJobsRequest.js +60 -0
- package/dist/models/ListSemanticJobsRequest.js.map +1 -0
- package/dist/models/ListSemanticJobsResponse.d.ts +19 -0
- package/dist/models/ListSemanticJobsResponse.js +69 -0
- package/dist/models/ListSemanticJobsResponse.js.map +1 -0
- package/dist/models/ListSemanticJobsResponseBody.d.ts +173 -0
- package/dist/models/ListSemanticJobsResponseBody.js +143 -0
- package/dist/models/ListSemanticJobsResponseBody.js.map +1 -0
- package/dist/models/PromptAgentSessionRequest.d.ts +17 -16
- package/dist/models/PromptAgentSessionRequest.js.map +1 -1
- package/dist/models/PromptAgentSessionResponseBody.d.ts +5 -5
- package/dist/models/PromptAgentSessionShrinkRequest.d.ts +1 -1
- package/dist/models/RerunTaskInstancesRequest.d.ts +7 -0
- package/dist/models/RerunTaskInstancesRequest.js.map +1 -1
- package/dist/models/RerunTaskInstancesResponseBody.d.ts +1 -1
- package/dist/models/RerunTaskInstancesShrinkRequest.d.ts +7 -0
- package/dist/models/RerunTaskInstancesShrinkRequest.js.map +1 -1
- package/dist/models/RunSemanticJobRequest.d.ts +23 -0
- package/dist/models/RunSemanticJobRequest.js +58 -0
- package/dist/models/RunSemanticJobRequest.js.map +1 -0
- package/dist/models/RunSemanticJobResponse.d.ts +19 -0
- package/dist/models/RunSemanticJobResponse.js +69 -0
- package/dist/models/RunSemanticJobResponse.js.map +1 -0
- package/dist/models/RunSemanticJobResponseBody.d.ts +85 -0
- package/dist/models/RunSemanticJobResponseBody.js +100 -0
- package/dist/models/RunSemanticJobResponseBody.js.map +1 -0
- package/dist/models/UpdateSkillRequest.d.ts +100 -0
- package/dist/models/UpdateSkillRequest.js +105 -0
- package/dist/models/UpdateSkillRequest.js.map +1 -0
- package/dist/models/UpdateSkillResponse.d.ts +19 -0
- package/dist/models/UpdateSkillResponse.js +69 -0
- package/dist/models/UpdateSkillResponse.js.map +1 -0
- package/dist/models/UpdateSkillResponseBody.d.ts +133 -0
- package/dist/models/UpdateSkillResponseBody.js +128 -0
- package/dist/models/UpdateSkillResponseBody.js.map +1 -0
- package/dist/models/UpdateSkillShrinkRequest.d.ts +76 -0
- package/dist/models/UpdateSkillShrinkRequest.js +72 -0
- package/dist/models/UpdateSkillShrinkRequest.js.map +1 -0
- package/dist/models/UploadSemanticFileRequest.d.ts +43 -0
- package/dist/models/UploadSemanticFileRequest.js +62 -0
- package/dist/models/UploadSemanticFileRequest.js.map +1 -0
- package/dist/models/UploadSemanticFileResponse.d.ts +19 -0
- package/dist/models/UploadSemanticFileResponse.js +69 -0
- package/dist/models/UploadSemanticFileResponse.js.map +1 -0
- package/dist/models/UploadSemanticFileResponseBody.d.ts +67 -0
- package/dist/models/UploadSemanticFileResponseBody.js +88 -0
- package/dist/models/UploadSemanticFileResponseBody.js.map +1 -0
- package/dist/models/model.d.ts +53 -0
- package/dist/models/model.js +150 -43
- package/dist/models/model.js.map +1 -1
- package/package.json +2 -2
- package/src/client.ts +740 -88
- package/src/models/CreateAgentRequest.ts +105 -15
- package/src/models/CreateAgentResponseBody.ts +4 -4
- package/src/models/CreateAgentSessionRequest.ts +32 -10
- package/src/models/CreateAgentSessionResponseBody.ts +4 -4
- package/src/models/CreateAgentSessionShrinkRequest.ts +2 -2
- package/src/models/CreateAgentShrinkRequest.ts +7 -7
- package/src/models/CreateFileRequest.ts +88 -92
- package/src/models/CreateFileResponseBody.ts +4 -5
- package/src/models/CreateSemanticJobRequest.ts +93 -0
- package/src/models/CreateSemanticJobResponse.ts +40 -0
- package/src/models/CreateSemanticJobResponseBody.ts +191 -0
- package/src/models/CreateSemanticJobShrinkRequest.ts +84 -0
- package/src/models/CreateSkillRequest.ts +35 -0
- package/src/models/CreateSkillResponseBody.ts +41 -0
- package/src/models/CreateSkillShrinkRequest.ts +27 -0
- package/src/models/DeleteAgentRequest.ts +2 -0
- package/src/models/DeleteAgentResponseBody.ts +3 -0
- package/src/models/DeleteMetaEntityDefRequest.ts +8 -0
- package/src/models/DeleteMetaEntityDefResponseBody.ts +6 -0
- package/src/models/DeleteSemanticJobRequest.ts +36 -0
- package/src/models/DeleteSemanticJobResponse.ts +40 -0
- package/src/models/DeleteSemanticJobResponseBody.ts +108 -0
- package/src/models/DownloadSemanticResultsRequest.ts +46 -0
- package/src/models/DownloadSemanticResultsResponse.ts +40 -0
- package/src/models/DownloadSemanticResultsResponseBody.ts +131 -0
- package/src/models/GetSemanticJobDetailRequest.ts +48 -0
- package/src/models/GetSemanticJobDetailResponse.ts +40 -0
- package/src/models/GetSemanticJobDetailResponseBody.ts +201 -0
- package/src/models/GetSemanticJobLogRequest.ts +48 -0
- package/src/models/GetSemanticJobLogResponse.ts +40 -0
- package/src/models/GetSemanticJobLogResponseBody.ts +88 -0
- package/src/models/ImportWorkflowDefinitionRequest.ts +10 -5
- package/src/models/ImportWorkflowDefinitionResponseBody.ts +3 -3
- package/src/models/KillSemanticJobRequest.ts +58 -0
- package/src/models/KillSemanticJobResponse.ts +40 -0
- package/src/models/KillSemanticJobResponseBody.ts +48 -0
- package/src/models/ListDataQualityTemplatesRequest.ts +4 -4
- package/src/models/ListDataQualityTemplatesResponseBody.ts +8 -8
- package/src/models/ListSemanticJobRunsRequest.ts +56 -0
- package/src/models/ListSemanticJobRunsResponse.ts +40 -0
- package/src/models/ListSemanticJobRunsResponseBody.ts +181 -0
- package/src/models/ListSemanticJobsRequest.ts +44 -0
- package/src/models/ListSemanticJobsResponse.ts +40 -0
- package/src/models/ListSemanticJobsResponseBody.ts +251 -0
- package/src/models/PromptAgentSessionRequest.ts +17 -16
- package/src/models/PromptAgentSessionResponseBody.ts +5 -5
- package/src/models/PromptAgentSessionShrinkRequest.ts +1 -1
- package/src/models/RerunTaskInstancesRequest.ts +7 -0
- package/src/models/RerunTaskInstancesResponseBody.ts +1 -1
- package/src/models/RerunTaskInstancesShrinkRequest.ts +7 -0
- package/src/models/RunSemanticJobRequest.ts +36 -0
- package/src/models/RunSemanticJobResponse.ts +40 -0
- package/src/models/RunSemanticJobResponseBody.ts +131 -0
- package/src/models/UpdateSkillRequest.ts +149 -0
- package/src/models/UpdateSkillResponse.ts +40 -0
- package/src/models/UpdateSkillResponseBody.ts +198 -0
- package/src/models/UpdateSkillShrinkRequest.ts +103 -0
- package/src/models/UploadSemanticFileRequest.ts +60 -0
- package/src/models/UploadSemanticFileResponse.ts +40 -0
- package/src/models/UploadSemanticFileResponseBody.ts +101 -0
- package/src/models/model.ts +53 -0
package/dist/client.d.ts
CHANGED
|
@@ -310,15 +310,15 @@ export default class Client extends OpenApi {
|
|
|
310
310
|
*/
|
|
311
311
|
cloneDataSource(request: $_model.CloneDataSourceRequest): Promise<$_model.CloneDataSourceResponse>;
|
|
312
312
|
/**
|
|
313
|
-
*
|
|
313
|
+
* Creates an Agent.
|
|
314
314
|
*
|
|
315
315
|
* @remarks
|
|
316
|
-
* ##
|
|
317
|
-
* - **Agent
|
|
318
|
-
* - **Model
|
|
319
|
-
* - **Visibility
|
|
320
|
-
* - **Visibility
|
|
321
|
-
* - **Other
|
|
316
|
+
* ## Operation description
|
|
317
|
+
* - **Agent name**: Must be unique within the current account.
|
|
318
|
+
* - **Model configuration**: An optional parameter that specifies the model used by the Agent and its related settings.
|
|
319
|
+
* - **Visibility level**: Defines who can access the Agent. Supported levels include account-wide, project-specific, or user-specific visibility.
|
|
320
|
+
* - **Visibility scope**: When you set the visibility level to `PROJECT` or `USER`, you must specify the list of project IDs or user IDs.
|
|
321
|
+
* - **Other parameters**: Parameters such as display name and description are optional. Set them as needed.
|
|
322
322
|
*
|
|
323
323
|
* @param tmpReq - CreateAgentRequest
|
|
324
324
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -326,29 +326,32 @@ export default class Client extends OpenApi {
|
|
|
326
326
|
*/
|
|
327
327
|
createAgentWithOptions(tmpReq: $_model.CreateAgentRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateAgentResponse>;
|
|
328
328
|
/**
|
|
329
|
-
*
|
|
329
|
+
* Creates an Agent.
|
|
330
330
|
*
|
|
331
331
|
* @remarks
|
|
332
|
-
* ##
|
|
333
|
-
* - **Agent
|
|
334
|
-
* - **Model
|
|
335
|
-
* - **Visibility
|
|
336
|
-
* - **Visibility
|
|
337
|
-
* - **Other
|
|
332
|
+
* ## Operation description
|
|
333
|
+
* - **Agent name**: Must be unique within the current account.
|
|
334
|
+
* - **Model configuration**: An optional parameter that specifies the model used by the Agent and its related settings.
|
|
335
|
+
* - **Visibility level**: Defines who can access the Agent. Supported levels include account-wide, project-specific, or user-specific visibility.
|
|
336
|
+
* - **Visibility scope**: When you set the visibility level to `PROJECT` or `USER`, you must specify the list of project IDs or user IDs.
|
|
337
|
+
* - **Other parameters**: Parameters such as display name and description are optional. Set them as needed.
|
|
338
338
|
*
|
|
339
339
|
* @param request - CreateAgentRequest
|
|
340
340
|
* @returns CreateAgentResponse
|
|
341
341
|
*/
|
|
342
342
|
createAgent(request: $_model.CreateAgentRequest): Promise<$_model.CreateAgentResponse>;
|
|
343
343
|
/**
|
|
344
|
-
* Creates a new agent session and returns
|
|
344
|
+
* Creates a new agent session and returns the session ID.
|
|
345
345
|
*
|
|
346
346
|
* @remarks
|
|
347
|
-
* ##
|
|
348
|
-
* - This
|
|
349
|
-
* -
|
|
350
|
-
* -
|
|
351
|
-
* -
|
|
347
|
+
* ## Request description
|
|
348
|
+
* - This operation creates a new agent session.
|
|
349
|
+
* - Use `_meta.agent.agentName` to specify the bound agent name. This parameter is required.
|
|
350
|
+
* - dataworks_data_agent: DataWorks built-in agent — Data Agent, which provides intelligent data development AI capabilities covering the entire workflow of data integration, development, O&M, governance, and analytics.
|
|
351
|
+
* - dataworks_chatbi_agent: DataWorks built-in agent — ChatBI, which uses natural language processing and intelligent analytics technologies to automate the entire analysis workflow from requirement parsing, data extraction, and automatic code generation to visualization report output through conversational interaction.
|
|
352
|
+
* - dataworks_ai_assistant_agent: DataWorks built-in agent — AI Assistant Service, which is a DataWorks enterprise-grade dedicated AI assistant built on open source frameworks such as OpenClaw and Hermes Agent.
|
|
353
|
+
* - Use `_meta.config.sessionSource` to pass through a session source identifier for subsequent retrieval by source.
|
|
354
|
+
* - Use `_meta.config.sessionTags[].sessionTagCode` to pass in session tags.
|
|
352
355
|
*
|
|
353
356
|
* @param tmpReq - CreateAgentSessionRequest
|
|
354
357
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -356,14 +359,17 @@ export default class Client extends OpenApi {
|
|
|
356
359
|
*/
|
|
357
360
|
createAgentSessionWithOptions(tmpReq: $_model.CreateAgentSessionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateAgentSessionResponse>;
|
|
358
361
|
/**
|
|
359
|
-
* Creates a new agent session and returns
|
|
362
|
+
* Creates a new agent session and returns the session ID.
|
|
360
363
|
*
|
|
361
364
|
* @remarks
|
|
362
|
-
* ##
|
|
363
|
-
* - This
|
|
364
|
-
* -
|
|
365
|
-
* -
|
|
366
|
-
* -
|
|
365
|
+
* ## Request description
|
|
366
|
+
* - This operation creates a new agent session.
|
|
367
|
+
* - Use `_meta.agent.agentName` to specify the bound agent name. This parameter is required.
|
|
368
|
+
* - dataworks_data_agent: DataWorks built-in agent — Data Agent, which provides intelligent data development AI capabilities covering the entire workflow of data integration, development, O&M, governance, and analytics.
|
|
369
|
+
* - dataworks_chatbi_agent: DataWorks built-in agent — ChatBI, which uses natural language processing and intelligent analytics technologies to automate the entire analysis workflow from requirement parsing, data extraction, and automatic code generation to visualization report output through conversational interaction.
|
|
370
|
+
* - dataworks_ai_assistant_agent: DataWorks built-in agent — AI Assistant Service, which is a DataWorks enterprise-grade dedicated AI assistant built on open source frameworks such as OpenClaw and Hermes Agent.
|
|
371
|
+
* - Use `_meta.config.sessionSource` to pass through a session source identifier for subsequent retrieval by source.
|
|
372
|
+
* - Use `_meta.config.sessionTags[].sessionTagCode` to pass in session tags.
|
|
367
373
|
*
|
|
368
374
|
* @param request - CreateAgentSessionRequest
|
|
369
375
|
* @returns CreateAgentSessionResponse
|
|
@@ -776,7 +782,7 @@ export default class Client extends OpenApi {
|
|
|
776
782
|
*/
|
|
777
783
|
createDatasetVersion(request: $_model.CreateDatasetVersionRequest): Promise<$_model.CreateDatasetVersionResponse>;
|
|
778
784
|
/**
|
|
779
|
-
* Creates a file in DataStudio.
|
|
785
|
+
* Creates a file in DataStudio. This operation does not support creating Data Integration nodes.
|
|
780
786
|
*
|
|
781
787
|
* @param request - CreateFileRequest
|
|
782
788
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -784,7 +790,7 @@ export default class Client extends OpenApi {
|
|
|
784
790
|
*/
|
|
785
791
|
createFileWithOptions(request: $_model.CreateFileRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateFileResponse>;
|
|
786
792
|
/**
|
|
787
|
-
* Creates a file in DataStudio.
|
|
793
|
+
* Creates a file in DataStudio. This operation does not support creating Data Integration nodes.
|
|
788
794
|
*
|
|
789
795
|
* @param request - CreateFileRequest
|
|
790
796
|
* @returns CreateFileResponse
|
|
@@ -1235,13 +1241,34 @@ export default class Client extends OpenApi {
|
|
|
1235
1241
|
*/
|
|
1236
1242
|
createSecurityStrategy(request: $_model.CreateSecurityStrategyRequest): Promise<$_model.CreateSecurityStrategyResponse>;
|
|
1237
1243
|
/**
|
|
1238
|
-
*
|
|
1244
|
+
* Saves a reusable semantic task definition. If you use a single-file source, apply for and complete the file upload first. After creation, call RunSemanticJob with the returned Name.
|
|
1245
|
+
*
|
|
1246
|
+
* @remarks
|
|
1247
|
+
* Creates a semantic task definition.
|
|
1248
|
+
*
|
|
1249
|
+
* @param tmpReq - CreateSemanticJobRequest
|
|
1250
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
1251
|
+
* @returns CreateSemanticJobResponse
|
|
1252
|
+
*/
|
|
1253
|
+
createSemanticJobWithOptions(tmpReq: $_model.CreateSemanticJobRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateSemanticJobResponse>;
|
|
1254
|
+
/**
|
|
1255
|
+
* Saves a reusable semantic task definition. If you use a single-file source, apply for and complete the file upload first. After creation, call RunSemanticJob with the returned Name.
|
|
1239
1256
|
*
|
|
1240
1257
|
* @remarks
|
|
1241
|
-
*
|
|
1242
|
-
*
|
|
1243
|
-
*
|
|
1244
|
-
*
|
|
1258
|
+
* Creates a semantic task definition.
|
|
1259
|
+
*
|
|
1260
|
+
* @param request - CreateSemanticJobRequest
|
|
1261
|
+
* @returns CreateSemanticJobResponse
|
|
1262
|
+
*/
|
|
1263
|
+
createSemanticJob(request: $_model.CreateSemanticJobRequest): Promise<$_model.CreateSemanticJobResponse>;
|
|
1264
|
+
/**
|
|
1265
|
+
* Creates a new Skill in DataWorks.
|
|
1266
|
+
*
|
|
1267
|
+
* @remarks
|
|
1268
|
+
* ## Request description
|
|
1269
|
+
* - You must provide either SkillMdOverride or BundleUrl. One of the two parameters is required.
|
|
1270
|
+
* - Visibility can be set to `TENANT`, `PROJECT`, or `USER`, which indicate visibility within the account, visibility to specified projects, or visibility to specified users, respectively.
|
|
1271
|
+
* - When Visibility is set to `PROJECT`, specify the list of visible project IDs by using VisibilityScope.ProjectIds. When Visibility is set to `USER`, specify the list of visible user IDs by using VisibilityScope.UserIds.
|
|
1245
1272
|
*
|
|
1246
1273
|
* @param tmpReq - CreateSkillRequest
|
|
1247
1274
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1249,13 +1276,13 @@ export default class Client extends OpenApi {
|
|
|
1249
1276
|
*/
|
|
1250
1277
|
createSkillWithOptions(tmpReq: $_model.CreateSkillRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateSkillResponse>;
|
|
1251
1278
|
/**
|
|
1252
|
-
*
|
|
1279
|
+
* Creates a new Skill in DataWorks.
|
|
1253
1280
|
*
|
|
1254
1281
|
* @remarks
|
|
1255
|
-
* ##
|
|
1256
|
-
* -
|
|
1257
|
-
* -
|
|
1258
|
-
* -
|
|
1282
|
+
* ## Request description
|
|
1283
|
+
* - You must provide either SkillMdOverride or BundleUrl. One of the two parameters is required.
|
|
1284
|
+
* - Visibility can be set to `TENANT`, `PROJECT`, or `USER`, which indicate visibility within the account, visibility to specified projects, or visibility to specified users, respectively.
|
|
1285
|
+
* - When Visibility is set to `PROJECT`, specify the list of visible project IDs by using VisibilityScope.ProjectIds. When Visibility is set to `USER`, specify the list of visible user IDs by using VisibilityScope.UserIds.
|
|
1259
1286
|
*
|
|
1260
1287
|
* @param request - CreateSkillRequest
|
|
1261
1288
|
* @returns CreateSkillResponse
|
|
@@ -1321,11 +1348,11 @@ export default class Client extends OpenApi {
|
|
|
1321
1348
|
*/
|
|
1322
1349
|
createWorkflowInstances(request: $_model.CreateWorkflowInstancesRequest): Promise<$_model.CreateWorkflowInstancesResponse>;
|
|
1323
1350
|
/**
|
|
1324
|
-
*
|
|
1351
|
+
* Deletes an Agent.
|
|
1325
1352
|
*
|
|
1326
1353
|
* @remarks
|
|
1327
|
-
* ##
|
|
1328
|
-
*
|
|
1354
|
+
* ## Operation description
|
|
1355
|
+
* This API operation deletes an Agent with the specified name from DataWorks. When calling this operation, you must provide the name of the Agent to delete.
|
|
1329
1356
|
*
|
|
1330
1357
|
* @param request - DeleteAgentRequest
|
|
1331
1358
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1333,11 +1360,11 @@ export default class Client extends OpenApi {
|
|
|
1333
1360
|
*/
|
|
1334
1361
|
deleteAgentWithOptions(request: $_model.DeleteAgentRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteAgentResponse>;
|
|
1335
1362
|
/**
|
|
1336
|
-
*
|
|
1363
|
+
* Deletes an Agent.
|
|
1337
1364
|
*
|
|
1338
1365
|
* @remarks
|
|
1339
|
-
* ##
|
|
1340
|
-
*
|
|
1366
|
+
* ## Operation description
|
|
1367
|
+
* This API operation deletes an Agent with the specified name from DataWorks. When calling this operation, you must provide the name of the Agent to delete.
|
|
1341
1368
|
*
|
|
1342
1369
|
* @param request - DeleteAgentRequest
|
|
1343
1370
|
* @returns DeleteAgentResponse
|
|
@@ -1857,10 +1884,10 @@ export default class Client extends OpenApi {
|
|
|
1857
1884
|
*/
|
|
1858
1885
|
deleteMetaCollection(request: $_model.DeleteMetaCollectionRequest): Promise<$_model.DeleteMetaCollectionResponse>;
|
|
1859
1886
|
/**
|
|
1860
|
-
*
|
|
1887
|
+
* Deletes a metadata entity definition, including custom entity types and extension table types.
|
|
1861
1888
|
*
|
|
1862
1889
|
* @remarks
|
|
1863
|
-
*
|
|
1890
|
+
* DataWorks Professional Edition or a more advanced edition is required.
|
|
1864
1891
|
*
|
|
1865
1892
|
* @param request - DeleteMetaEntityDefRequest
|
|
1866
1893
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1868,10 +1895,10 @@ export default class Client extends OpenApi {
|
|
|
1868
1895
|
*/
|
|
1869
1896
|
deleteMetaEntityDefWithOptions(request: $_model.DeleteMetaEntityDefRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteMetaEntityDefResponse>;
|
|
1870
1897
|
/**
|
|
1871
|
-
*
|
|
1898
|
+
* Deletes a metadata entity definition, including custom entity types and extension table types.
|
|
1872
1899
|
*
|
|
1873
1900
|
* @remarks
|
|
1874
|
-
*
|
|
1901
|
+
* DataWorks Professional Edition or a more advanced edition is required.
|
|
1875
1902
|
*
|
|
1876
1903
|
* @param request - DeleteMetaEntityDefRequest
|
|
1877
1904
|
* @returns DeleteMetaEntityDefResponse
|
|
@@ -2122,6 +2149,27 @@ export default class Client extends OpenApi {
|
|
|
2122
2149
|
* @returns DeleteSecurityStrategyResponse
|
|
2123
2150
|
*/
|
|
2124
2151
|
deleteSecurityStrategy(request: $_model.DeleteSecurityStrategyRequest): Promise<$_model.DeleteSecurityStrategyResponse>;
|
|
2152
|
+
/**
|
|
2153
|
+
* Deletes a task definition by the Name of a created task. If the task is running, call KillSemanticJob with the ExecutorJobId of that run and confirm the stop before deletion.
|
|
2154
|
+
*
|
|
2155
|
+
* @remarks
|
|
2156
|
+
* Operation description for deleting a semantic task.
|
|
2157
|
+
*
|
|
2158
|
+
* @param request - DeleteSemanticJobRequest
|
|
2159
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
2160
|
+
* @returns DeleteSemanticJobResponse
|
|
2161
|
+
*/
|
|
2162
|
+
deleteSemanticJobWithOptions(request: $_model.DeleteSemanticJobRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteSemanticJobResponse>;
|
|
2163
|
+
/**
|
|
2164
|
+
* Deletes a task definition by the Name of a created task. If the task is running, call KillSemanticJob with the ExecutorJobId of that run and confirm the stop before deletion.
|
|
2165
|
+
*
|
|
2166
|
+
* @remarks
|
|
2167
|
+
* Operation description for deleting a semantic task.
|
|
2168
|
+
*
|
|
2169
|
+
* @param request - DeleteSemanticJobRequest
|
|
2170
|
+
* @returns DeleteSemanticJobResponse
|
|
2171
|
+
*/
|
|
2172
|
+
deleteSemanticJob(request: $_model.DeleteSemanticJobRequest): Promise<$_model.DeleteSemanticJobResponse>;
|
|
2125
2173
|
/**
|
|
2126
2174
|
* Delete Skill
|
|
2127
2175
|
*
|
|
@@ -2331,6 +2379,27 @@ export default class Client extends OpenApi {
|
|
|
2331
2379
|
* @returns DissociateProjectFromResourceGroupResponse
|
|
2332
2380
|
*/
|
|
2333
2381
|
dissociateProjectFromResourceGroup(request: $_model.DissociateProjectFromResourceGroupRequest): Promise<$_model.DissociateProjectFromResourceGroupResponse>;
|
|
2382
|
+
/**
|
|
2383
|
+
* Returns the download URL of artifacts by node name and an optional run ID after execution completes. If JobRunId is not specified, the result of the latest run of the node is returned.
|
|
2384
|
+
*
|
|
2385
|
+
* @remarks
|
|
2386
|
+
* Operation description for retrieving the download URL of semantic task results.
|
|
2387
|
+
*
|
|
2388
|
+
* @param request - DownloadSemanticResultsRequest
|
|
2389
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
2390
|
+
* @returns DownloadSemanticResultsResponse
|
|
2391
|
+
*/
|
|
2392
|
+
downloadSemanticResultsWithOptions(request: $_model.DownloadSemanticResultsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DownloadSemanticResultsResponse>;
|
|
2393
|
+
/**
|
|
2394
|
+
* Returns the download URL of artifacts by node name and an optional run ID after execution completes. If JobRunId is not specified, the result of the latest run of the node is returned.
|
|
2395
|
+
*
|
|
2396
|
+
* @remarks
|
|
2397
|
+
* Operation description for retrieving the download URL of semantic task results.
|
|
2398
|
+
*
|
|
2399
|
+
* @param request - DownloadSemanticResultsRequest
|
|
2400
|
+
* @returns DownloadSemanticResultsResponse
|
|
2401
|
+
*/
|
|
2402
|
+
downloadSemanticResults(request: $_model.DownloadSemanticResultsRequest): Promise<$_model.DownloadSemanticResultsResponse>;
|
|
2334
2403
|
/**
|
|
2335
2404
|
* Enables a process definition with the specified ID.
|
|
2336
2405
|
*
|
|
@@ -3607,6 +3676,48 @@ export default class Client extends OpenApi {
|
|
|
3607
3676
|
* @returns GetSecurityStrategyResponse
|
|
3608
3677
|
*/
|
|
3609
3678
|
getSecurityStrategy(request: $_model.GetSecurityStrategyRequest): Promise<$_model.GetSecurityStrategyResponse>;
|
|
3679
|
+
/**
|
|
3680
|
+
* Queries the executor status and runtime configuration by using the ExecutorJobId returned by RunSemanticJob or ListSemanticJobRuns.
|
|
3681
|
+
*
|
|
3682
|
+
* @remarks
|
|
3683
|
+
* Operation description for querying semantic job run details.
|
|
3684
|
+
*
|
|
3685
|
+
* @param request - GetSemanticJobDetailRequest
|
|
3686
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
3687
|
+
* @returns GetSemanticJobDetailResponse
|
|
3688
|
+
*/
|
|
3689
|
+
getSemanticJobDetailWithOptions(request: $_model.GetSemanticJobDetailRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetSemanticJobDetailResponse>;
|
|
3690
|
+
/**
|
|
3691
|
+
* Queries the executor status and runtime configuration by using the ExecutorJobId returned by RunSemanticJob or ListSemanticJobRuns.
|
|
3692
|
+
*
|
|
3693
|
+
* @remarks
|
|
3694
|
+
* Operation description for querying semantic job run details.
|
|
3695
|
+
*
|
|
3696
|
+
* @param request - GetSemanticJobDetailRequest
|
|
3697
|
+
* @returns GetSemanticJobDetailResponse
|
|
3698
|
+
*/
|
|
3699
|
+
getSemanticJobDetail(request: $_model.GetSemanticJobDetailRequest): Promise<$_model.GetSemanticJobDetailResponse>;
|
|
3700
|
+
/**
|
|
3701
|
+
* Queries execution logs by using the ExecutorJobId returned by RunSemanticJob or ListSemanticJobRuns. The current POP contract exposes only the task and workspace identifiers and returns default log segments.
|
|
3702
|
+
*
|
|
3703
|
+
* @remarks
|
|
3704
|
+
* Operation description for querying semantic job run logs.
|
|
3705
|
+
*
|
|
3706
|
+
* @param request - GetSemanticJobLogRequest
|
|
3707
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
3708
|
+
* @returns GetSemanticJobLogResponse
|
|
3709
|
+
*/
|
|
3710
|
+
getSemanticJobLogWithOptions(request: $_model.GetSemanticJobLogRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetSemanticJobLogResponse>;
|
|
3711
|
+
/**
|
|
3712
|
+
* Queries execution logs by using the ExecutorJobId returned by RunSemanticJob or ListSemanticJobRuns. The current POP contract exposes only the task and workspace identifiers and returns default log segments.
|
|
3713
|
+
*
|
|
3714
|
+
* @remarks
|
|
3715
|
+
* Operation description for querying semantic job run logs.
|
|
3716
|
+
*
|
|
3717
|
+
* @param request - GetSemanticJobLogRequest
|
|
3718
|
+
* @returns GetSemanticJobLogResponse
|
|
3719
|
+
*/
|
|
3720
|
+
getSemanticJobLog(request: $_model.GetSemanticJobLogRequest): Promise<$_model.GetSemanticJobLogResponse>;
|
|
3610
3721
|
/**
|
|
3611
3722
|
* Retrieves the details of a specified Skill by name, including the body of the SKILL.md file and the bundle\\"s download link.
|
|
3612
3723
|
*
|
|
@@ -3815,12 +3926,12 @@ export default class Client extends OpenApi {
|
|
|
3815
3926
|
importCertificate(request: $_model.ImportCertificateRequest): Promise<$_model.ImportCertificateResponse>;
|
|
3816
3927
|
importCertificateAdvance(request: $_model.ImportCertificateAdvanceRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ImportCertificateResponse>;
|
|
3817
3928
|
/**
|
|
3818
|
-
* Imports a workflow node defined by FlowSpec and its child nodes into DataStudio.
|
|
3929
|
+
* Imports a workflow node defined by FlowSpec and its internal child nodes into DataStudio.
|
|
3819
3930
|
*
|
|
3820
3931
|
* @remarks
|
|
3821
3932
|
* >Notice:
|
|
3822
|
-
* - This operation does not support importing multiple workflows. If more than one workflow is defined in the FlowSpec, all workflows
|
|
3823
|
-
* - This is an asynchronous operation.
|
|
3933
|
+
* - This operation does not support importing multiple workflows. If more than one workflow is defined in the FlowSpec, all workflows after the first one are ignored.
|
|
3934
|
+
* - This is an asynchronous operation. Calling this operation returns an asynchronous task object. To query the execution status of the task, call GetJobStatus.
|
|
3824
3935
|
*
|
|
3825
3936
|
* @param request - ImportWorkflowDefinitionRequest
|
|
3826
3937
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3828,17 +3939,38 @@ export default class Client extends OpenApi {
|
|
|
3828
3939
|
*/
|
|
3829
3940
|
importWorkflowDefinitionWithOptions(request: $_model.ImportWorkflowDefinitionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ImportWorkflowDefinitionResponse>;
|
|
3830
3941
|
/**
|
|
3831
|
-
* Imports a workflow node defined by FlowSpec and its child nodes into DataStudio.
|
|
3942
|
+
* Imports a workflow node defined by FlowSpec and its internal child nodes into DataStudio.
|
|
3832
3943
|
*
|
|
3833
3944
|
* @remarks
|
|
3834
3945
|
* >Notice:
|
|
3835
|
-
* - This operation does not support importing multiple workflows. If more than one workflow is defined in the FlowSpec, all workflows
|
|
3836
|
-
* - This is an asynchronous operation.
|
|
3946
|
+
* - This operation does not support importing multiple workflows. If more than one workflow is defined in the FlowSpec, all workflows after the first one are ignored.
|
|
3947
|
+
* - This is an asynchronous operation. Calling this operation returns an asynchronous task object. To query the execution status of the task, call GetJobStatus.
|
|
3837
3948
|
*
|
|
3838
3949
|
* @param request - ImportWorkflowDefinitionRequest
|
|
3839
3950
|
* @returns ImportWorkflowDefinitionResponse
|
|
3840
3951
|
*/
|
|
3841
3952
|
importWorkflowDefinition(request: $_model.ImportWorkflowDefinitionRequest): Promise<$_model.ImportWorkflowDefinitionResponse>;
|
|
3953
|
+
/**
|
|
3954
|
+
* Stops a specified run by using the ExecutorJobId returned by RunSemanticJob or ListSemanticJobRuns. A successful call only indicates that the stop request has been accepted. Query the final status by calling GetSemanticJobDetail.
|
|
3955
|
+
*
|
|
3956
|
+
* @remarks
|
|
3957
|
+
* Operation description for stopping a semantic job run.
|
|
3958
|
+
*
|
|
3959
|
+
* @param request - KillSemanticJobRequest
|
|
3960
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
3961
|
+
* @returns KillSemanticJobResponse
|
|
3962
|
+
*/
|
|
3963
|
+
killSemanticJobWithOptions(request: $_model.KillSemanticJobRequest, runtime: $dara.RuntimeOptions): Promise<$_model.KillSemanticJobResponse>;
|
|
3964
|
+
/**
|
|
3965
|
+
* Stops a specified run by using the ExecutorJobId returned by RunSemanticJob or ListSemanticJobRuns. A successful call only indicates that the stop request has been accepted. Query the final status by calling GetSemanticJobDetail.
|
|
3966
|
+
*
|
|
3967
|
+
* @remarks
|
|
3968
|
+
* Operation description for stopping a semantic job run.
|
|
3969
|
+
*
|
|
3970
|
+
* @param request - KillSemanticJobRequest
|
|
3971
|
+
* @returns KillSemanticJobResponse
|
|
3972
|
+
*/
|
|
3973
|
+
killSemanticJob(request: $_model.KillSemanticJobRequest): Promise<$_model.KillSemanticJobResponse>;
|
|
3842
3974
|
/**
|
|
3843
3975
|
* Retrieves a list of artifacts from a specified session.
|
|
3844
3976
|
*
|
|
@@ -4453,10 +4585,10 @@ export default class Client extends OpenApi {
|
|
|
4453
4585
|
*/
|
|
4454
4586
|
listDataQualityScans(request: $_model.ListDataQualityScansRequest): Promise<$_model.ListDataQualityScansResponse>;
|
|
4455
4587
|
/**
|
|
4456
|
-
* Queries the list of data quality rule templates in a project.
|
|
4588
|
+
* Queries the list of data quality rule templates in a specified project.
|
|
4457
4589
|
*
|
|
4458
4590
|
* @remarks
|
|
4459
|
-
* DataWorks Basic Edition or a higher edition
|
|
4591
|
+
* You must purchase DataWorks Basic Edition or a higher edition to use this feature.
|
|
4460
4592
|
*
|
|
4461
4593
|
* @param request - ListDataQualityTemplatesRequest
|
|
4462
4594
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4464,10 +4596,10 @@ export default class Client extends OpenApi {
|
|
|
4464
4596
|
*/
|
|
4465
4597
|
listDataQualityTemplatesWithOptions(request: $_model.ListDataQualityTemplatesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListDataQualityTemplatesResponse>;
|
|
4466
4598
|
/**
|
|
4467
|
-
* Queries the list of data quality rule templates in a project.
|
|
4599
|
+
* Queries the list of data quality rule templates in a specified project.
|
|
4468
4600
|
*
|
|
4469
4601
|
* @remarks
|
|
4470
|
-
* DataWorks Basic Edition or a higher edition
|
|
4602
|
+
* You must purchase DataWorks Basic Edition or a higher edition to use this feature.
|
|
4471
4603
|
*
|
|
4472
4604
|
* @param request - ListDataQualityTemplatesRequest
|
|
4473
4605
|
* @returns ListDataQualityTemplatesResponse
|
|
@@ -5438,6 +5570,48 @@ export default class Client extends OpenApi {
|
|
|
5438
5570
|
* @returns ListSecurityStrategiesResponse
|
|
5439
5571
|
*/
|
|
5440
5572
|
listSecurityStrategies(request: $_model.ListSecurityStrategiesRequest): Promise<$_model.ListSecurityStrategiesResponse>;
|
|
5573
|
+
/**
|
|
5574
|
+
* Queries the run records of a created node by its Name with paging. The JobRunId in each record is active for retrieving the results of a specific run, and the ExecutorJobId is active for getting details, logs, or stopping the run.
|
|
5575
|
+
*
|
|
5576
|
+
* @remarks
|
|
5577
|
+
* Queries the run records of a semantic job.
|
|
5578
|
+
*
|
|
5579
|
+
* @param request - ListSemanticJobRunsRequest
|
|
5580
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
5581
|
+
* @returns ListSemanticJobRunsResponse
|
|
5582
|
+
*/
|
|
5583
|
+
listSemanticJobRunsWithOptions(request: $_model.ListSemanticJobRunsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListSemanticJobRunsResponse>;
|
|
5584
|
+
/**
|
|
5585
|
+
* Queries the run records of a created node by its Name with paging. The JobRunId in each record is active for retrieving the results of a specific run, and the ExecutorJobId is active for getting details, logs, or stopping the run.
|
|
5586
|
+
*
|
|
5587
|
+
* @remarks
|
|
5588
|
+
* Queries the run records of a semantic job.
|
|
5589
|
+
*
|
|
5590
|
+
* @param request - ListSemanticJobRunsRequest
|
|
5591
|
+
* @returns ListSemanticJobRunsResponse
|
|
5592
|
+
*/
|
|
5593
|
+
listSemanticJobRuns(request: $_model.ListSemanticJobRunsRequest): Promise<$_model.ListSemanticJobRunsResponse>;
|
|
5594
|
+
/**
|
|
5595
|
+
* Queries semantics node definitions of the current tenant by paging. The Name, ProjectId, and Source fields in the list items can be used for running/deleting nodes, querying run details, and verifying input scope, respectively.
|
|
5596
|
+
*
|
|
5597
|
+
* @remarks
|
|
5598
|
+
* Queries the list of semantic task definitions.
|
|
5599
|
+
*
|
|
5600
|
+
* @param request - ListSemanticJobsRequest
|
|
5601
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
5602
|
+
* @returns ListSemanticJobsResponse
|
|
5603
|
+
*/
|
|
5604
|
+
listSemanticJobsWithOptions(request: $_model.ListSemanticJobsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListSemanticJobsResponse>;
|
|
5605
|
+
/**
|
|
5606
|
+
* Queries semantics node definitions of the current tenant by paging. The Name, ProjectId, and Source fields in the list items can be used for running/deleting nodes, querying run details, and verifying input scope, respectively.
|
|
5607
|
+
*
|
|
5608
|
+
* @remarks
|
|
5609
|
+
* Queries the list of semantic task definitions.
|
|
5610
|
+
*
|
|
5611
|
+
* @param request - ListSemanticJobsRequest
|
|
5612
|
+
* @returns ListSemanticJobsResponse
|
|
5613
|
+
*/
|
|
5614
|
+
listSemanticJobs(request: $_model.ListSemanticJobsRequest): Promise<$_model.ListSemanticJobsResponse>;
|
|
5441
5615
|
/**
|
|
5442
5616
|
* Lists the Skills in your account.
|
|
5443
5617
|
*
|
|
@@ -5794,18 +5968,18 @@ export default class Client extends OpenApi {
|
|
|
5794
5968
|
*/
|
|
5795
5969
|
previewDatasetVersion(request: $_model.PreviewDatasetVersionRequest): Promise<$_model.PreviewDatasetVersionResponse>;
|
|
5796
5970
|
/**
|
|
5797
|
-
* Sends a prompt to an existing session and
|
|
5971
|
+
* Sends a user prompt to an existing session and returns the Agent response in streaming mode.
|
|
5798
5972
|
*
|
|
5799
5973
|
* @remarks
|
|
5800
|
-
* ##
|
|
5801
|
-
* - This API sends a user prompt to a specified session ID and
|
|
5802
|
-
* - The response may include message
|
|
5803
|
-
* - If the specified session does not exist,
|
|
5804
|
-
* - The `stopReason` field indicates why the
|
|
5805
|
-
* -
|
|
5806
|
-
* - You can provide additional
|
|
5807
|
-
* - The
|
|
5808
|
-
* -
|
|
5974
|
+
* ## Operation description
|
|
5975
|
+
* - This API sends a user prompt to a specified session ID and accepts the Agent response in SSE (Server-Sent Events) streaming mode.
|
|
5976
|
+
* - The response may include message fragments, thinking procedures, tool calling status updates, and other information.
|
|
5977
|
+
* - If the specified session does not exist, a 400 fault is returned through an SSE error frame.
|
|
5978
|
+
* - The `stopReason` field indicates why the Agent stopped the current conversation turn.
|
|
5979
|
+
* - Multiple types of content blocks are supported as prompt input, such as text and OSS file download links.
|
|
5980
|
+
* - You can optionally provide additional meta information `Meta` to pass more context to the server.
|
|
5981
|
+
* - The returned content conforms to the open-source Agent Client Protocol (ACP) specification. For more information, visit: https://agentclientprotocol.com
|
|
5982
|
+
* - **Before invoking this API, make sure 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
|
|
5809
5983
|
*
|
|
5810
5984
|
* @param tmpReq - PromptAgentSessionRequest
|
|
5811
5985
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5813,18 +5987,18 @@ export default class Client extends OpenApi {
|
|
|
5813
5987
|
*/
|
|
5814
5988
|
promptAgentSessionWithSSE(tmpReq: $_model.PromptAgentSessionRequest, runtime: $dara.RuntimeOptions): AsyncGenerator<$_model.PromptAgentSessionResponse, any, unknown>;
|
|
5815
5989
|
/**
|
|
5816
|
-
* Sends a prompt to an existing session and
|
|
5990
|
+
* Sends a user prompt to an existing session and returns the Agent response in streaming mode.
|
|
5817
5991
|
*
|
|
5818
5992
|
* @remarks
|
|
5819
|
-
* ##
|
|
5820
|
-
* - This API sends a user prompt to a specified session ID and
|
|
5821
|
-
* - The response may include message
|
|
5822
|
-
* - If the specified session does not exist,
|
|
5823
|
-
* - The `stopReason` field indicates why the
|
|
5824
|
-
* -
|
|
5825
|
-
* - You can provide additional
|
|
5826
|
-
* - The
|
|
5827
|
-
* -
|
|
5993
|
+
* ## Operation description
|
|
5994
|
+
* - This API sends a user prompt to a specified session ID and accepts the Agent response in SSE (Server-Sent Events) streaming mode.
|
|
5995
|
+
* - The response may include message fragments, thinking procedures, tool calling status updates, and other information.
|
|
5996
|
+
* - If the specified session does not exist, a 400 fault is returned through an SSE error frame.
|
|
5997
|
+
* - The `stopReason` field indicates why the Agent stopped the current conversation turn.
|
|
5998
|
+
* - Multiple types of content blocks are supported as prompt input, such as text and OSS file download links.
|
|
5999
|
+
* - You can optionally provide additional meta information `Meta` to pass more context to the server.
|
|
6000
|
+
* - The returned content conforms to the open-source Agent Client Protocol (ACP) specification. For more information, visit: https://agentclientprotocol.com
|
|
6001
|
+
* - **Before invoking this API, make sure 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
|
|
5828
6002
|
*
|
|
5829
6003
|
* @param tmpReq - PromptAgentSessionRequest
|
|
5830
6004
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5832,18 +6006,18 @@ export default class Client extends OpenApi {
|
|
|
5832
6006
|
*/
|
|
5833
6007
|
promptAgentSessionWithOptions(tmpReq: $_model.PromptAgentSessionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.PromptAgentSessionResponse>;
|
|
5834
6008
|
/**
|
|
5835
|
-
* Sends a prompt to an existing session and
|
|
6009
|
+
* Sends a user prompt to an existing session and returns the Agent response in streaming mode.
|
|
5836
6010
|
*
|
|
5837
6011
|
* @remarks
|
|
5838
|
-
* ##
|
|
5839
|
-
* - This API sends a user prompt to a specified session ID and
|
|
5840
|
-
* - The response may include message
|
|
5841
|
-
* - If the specified session does not exist,
|
|
5842
|
-
* - The `stopReason` field indicates why the
|
|
5843
|
-
* -
|
|
5844
|
-
* - You can provide additional
|
|
5845
|
-
* - The
|
|
5846
|
-
* -
|
|
6012
|
+
* ## Operation description
|
|
6013
|
+
* - This API sends a user prompt to a specified session ID and accepts the Agent response in SSE (Server-Sent Events) streaming mode.
|
|
6014
|
+
* - The response may include message fragments, thinking procedures, tool calling status updates, and other information.
|
|
6015
|
+
* - If the specified session does not exist, a 400 fault is returned through an SSE error frame.
|
|
6016
|
+
* - The `stopReason` field indicates why the Agent stopped the current conversation turn.
|
|
6017
|
+
* - Multiple types of content blocks are supported as prompt input, such as text and OSS file download links.
|
|
6018
|
+
* - You can optionally provide additional meta information `Meta` to pass more context to the server.
|
|
6019
|
+
* - The returned content conforms to the open-source Agent Client Protocol (ACP) specification. For more information, visit: https://agentclientprotocol.com
|
|
6020
|
+
* - **Before invoking this API, make sure 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
|
|
5847
6021
|
*
|
|
5848
6022
|
* @param request - PromptAgentSessionRequest
|
|
5849
6023
|
* @returns PromptAgentSessionResponse
|
|
@@ -6052,6 +6226,27 @@ export default class Client extends OpenApi {
|
|
|
6052
6226
|
* @returns RollbackParameterResponse
|
|
6053
6227
|
*/
|
|
6054
6228
|
rollbackParameter(request: $_model.RollbackParameterRequest): Promise<$_model.RollbackParameterResponse>;
|
|
6229
|
+
/**
|
|
6230
|
+
* Submits a semantic job for execution by its Name and returns the run identifier and executor identifier. A successful call indicates that the job has been submitted, not that the semantic model results have been generated.
|
|
6231
|
+
*
|
|
6232
|
+
* @remarks
|
|
6233
|
+
* *Before using this operation, make sure that you fully understand the [billing method and pricing](https://www.alibabacloud.com/help/en/dataworks/dataworks-data-agent-agent-billing) of model calls used by semantic building.**
|
|
6234
|
+
*
|
|
6235
|
+
* @param request - RunSemanticJobRequest
|
|
6236
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
6237
|
+
* @returns RunSemanticJobResponse
|
|
6238
|
+
*/
|
|
6239
|
+
runSemanticJobWithOptions(request: $_model.RunSemanticJobRequest, runtime: $dara.RuntimeOptions): Promise<$_model.RunSemanticJobResponse>;
|
|
6240
|
+
/**
|
|
6241
|
+
* Submits a semantic job for execution by its Name and returns the run identifier and executor identifier. A successful call indicates that the job has been submitted, not that the semantic model results have been generated.
|
|
6242
|
+
*
|
|
6243
|
+
* @remarks
|
|
6244
|
+
* *Before using this operation, make sure that you fully understand the [billing method and pricing](https://www.alibabacloud.com/help/en/dataworks/dataworks-data-agent-agent-billing) of model calls used by semantic building.**
|
|
6245
|
+
*
|
|
6246
|
+
* @param request - RunSemanticJobRequest
|
|
6247
|
+
* @returns RunSemanticJobResponse
|
|
6248
|
+
*/
|
|
6249
|
+
runSemanticJob(request: $_model.RunSemanticJobRequest): Promise<$_model.RunSemanticJobResponse>;
|
|
6055
6250
|
/**
|
|
6056
6251
|
* Sets the statuses of multiple instances to successful at a time.
|
|
6057
6252
|
*
|
|
@@ -7023,6 +7218,29 @@ export default class Client extends OpenApi {
|
|
|
7023
7218
|
* @returns UpdateSecurityStrategyResponse
|
|
7024
7219
|
*/
|
|
7025
7220
|
updateSecurityStrategy(request: $_model.UpdateSecurityStrategyRequest): Promise<$_model.UpdateSecurityStrategyResponse>;
|
|
7221
|
+
/**
|
|
7222
|
+
* Updates a specified Skill and generates a new version.
|
|
7223
|
+
*
|
|
7224
|
+
* @remarks
|
|
7225
|
+
* ## Request description
|
|
7226
|
+
* This API allows you to update an existing Skill and create a new version based on the current highest version or a specified version. Fields not provided in the request retain their original values. You can update the Skill content by providing either `SkillMdOverride` or `BundleUrl`. You can also set additional information such as the visibility scope.
|
|
7227
|
+
*
|
|
7228
|
+
* @param tmpReq - UpdateSkillRequest
|
|
7229
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
7230
|
+
* @returns UpdateSkillResponse
|
|
7231
|
+
*/
|
|
7232
|
+
updateSkillWithOptions(tmpReq: $_model.UpdateSkillRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateSkillResponse>;
|
|
7233
|
+
/**
|
|
7234
|
+
* Updates a specified Skill and generates a new version.
|
|
7235
|
+
*
|
|
7236
|
+
* @remarks
|
|
7237
|
+
* ## Request description
|
|
7238
|
+
* This API allows you to update an existing Skill and create a new version based on the current highest version or a specified version. Fields not provided in the request retain their original values. You can update the Skill content by providing either `SkillMdOverride` or `BundleUrl`. You can also set additional information such as the visibility scope.
|
|
7239
|
+
*
|
|
7240
|
+
* @param request - UpdateSkillRequest
|
|
7241
|
+
* @returns UpdateSkillResponse
|
|
7242
|
+
*/
|
|
7243
|
+
updateSkill(request: $_model.UpdateSkillRequest): Promise<$_model.UpdateSkillResponse>;
|
|
7026
7244
|
/**
|
|
7027
7245
|
* Updates the business metadata for a data table in the data map. You can update only the table\\"s Readme and custom attributes.
|
|
7028
7246
|
*
|
|
@@ -7139,4 +7357,25 @@ export default class Client extends OpenApi {
|
|
|
7139
7357
|
* @returns UpdateWorkflowDefinitionResponse
|
|
7140
7358
|
*/
|
|
7141
7359
|
updateWorkflowDefinition(request: $_model.UpdateWorkflowDefinitionRequest): Promise<$_model.UpdateWorkflowDefinitionResponse>;
|
|
7360
|
+
/**
|
|
7361
|
+
* Requests a temporary OSS PUT upload URL. Complete the PUT upload before the URL expires, and then pass the returned FileId to the ReferenceFileIds parameter of CreateSemanticJob.
|
|
7362
|
+
*
|
|
7363
|
+
* @remarks
|
|
7364
|
+
* Requests an upload URL for semantic job attachments.
|
|
7365
|
+
*
|
|
7366
|
+
* @param request - UploadSemanticFileRequest
|
|
7367
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
7368
|
+
* @returns UploadSemanticFileResponse
|
|
7369
|
+
*/
|
|
7370
|
+
uploadSemanticFileWithOptions(request: $_model.UploadSemanticFileRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UploadSemanticFileResponse>;
|
|
7371
|
+
/**
|
|
7372
|
+
* Requests a temporary OSS PUT upload URL. Complete the PUT upload before the URL expires, and then pass the returned FileId to the ReferenceFileIds parameter of CreateSemanticJob.
|
|
7373
|
+
*
|
|
7374
|
+
* @remarks
|
|
7375
|
+
* Requests an upload URL for semantic job attachments.
|
|
7376
|
+
*
|
|
7377
|
+
* @param request - UploadSemanticFileRequest
|
|
7378
|
+
* @returns UploadSemanticFileResponse
|
|
7379
|
+
*/
|
|
7380
|
+
uploadSemanticFile(request: $_model.UploadSemanticFileRequest): Promise<$_model.UploadSemanticFileResponse>;
|
|
7142
7381
|
}
|