@alicloud/dataworks-public20240518 8.0.6 → 8.2.0

package/dist/client.d.ts

@@ -114,6 +114,21 @@ export default class Client extends OpenApi {
      * @returns BatchUpdateTasksResponse
      */
     batchUpdateTasks(request: $_model.BatchUpdateTasksRequest): Promise<$_model.BatchUpdateTasksResponse>;
+    /**
+     * 取消并停止Agent当前正在进行中的Session会话
+     *
+     * @param tmpReq - CancelAgentSessionRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns CancelAgentSessionResponse
+     */
+    cancelAgentSessionWithOptions(tmpReq: $_model.CancelAgentSessionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CancelAgentSessionResponse>;
+    /**
+     * 取消并停止Agent当前正在进行中的Session会话
+     *
+     * @param request - CancelAgentSessionRequest
+     * @returns CancelAgentSessionResponse
+     */
+    cancelAgentSession(request: $_model.CancelAgentSessionRequest): Promise<$_model.CancelAgentSessionResponse>;
     /**
      * Clones an existing data source.
      *
@@ -139,6 +154,21 @@ export default class Client extends OpenApi {
      * @returns CloneDataSourceResponse
      */
     cloneDataSource(request: $_model.CloneDataSourceRequest): Promise<$_model.CloneDataSourceResponse>;
+    /**
+     * 创建一个Agent Session会话
+     *
+     * @param tmpReq - CreateAgentSessionRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns CreateAgentSessionResponse
+     */
+    createAgentSessionWithOptions(tmpReq: $_model.CreateAgentSessionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateAgentSessionResponse>;
+    /**
+     * 创建一个Agent Session会话
+     *
+     * @param request - CreateAgentSessionRequest
+     * @returns CreateAgentSessionResponse
+     */
+    createAgentSession(request: $_model.CreateAgentSessionRequest): Promise<$_model.CreateAgentSessionResponse>;
     /**
      * Creates a custom monitoring alert rule.
      *
@@ -648,6 +678,21 @@ export default class Client extends OpenApi {
      * @returns CreateNodeResponse
      */
     createNode(request: $_model.CreateNodeRequest): Promise<$_model.CreateNodeResponse>;
+    /**
+     * Creates a parameter.
+     *
+     * @param tmpReq - CreateParameterRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns CreateParameterResponse
+     */
+    createParameterWithOptions(tmpReq: $_model.CreateParameterRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateParameterResponse>;
+    /**
+     * Creates a parameter.
+     *
+     * @param request - CreateParameterRequest
+     * @returns CreateParameterResponse
+     */
+    createParameter(request: $_model.CreateParameterRequest): Promise<$_model.CreateParameterResponse>;
     /**
      * Creates a deployment process for entities in the Data Studio (new version).
      *
@@ -1317,6 +1362,21 @@ export default class Client extends OpenApi {
      * @returns DeleteNodeResponse
      */
     deleteNode(request: $_model.DeleteNodeRequest): Promise<$_model.DeleteNodeResponse>;
+    /**
+     * Remove specified parameters.
+     *
+     * @param request - DeleteParameterRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns DeleteParameterResponse
+     */
+    deleteParameterWithOptions(request: $_model.DeleteParameterRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteParameterResponse>;
+    /**
+     * Remove specified parameters.
+     *
+     * @param request - DeleteParameterRequest
+     * @returns DeleteParameterResponse
+     */
+    deleteParameter(request: $_model.DeleteParameterRequest): Promise<$_model.DeleteParameterResponse>;
     /**
      * Deletes a DataWorks workspace.
      *
@@ -1601,6 +1661,36 @@ export default class Client extends OpenApi {
      * @returns ExecuteAdhocWorkflowInstanceResponse
      */
     executeAdhocWorkflowInstance(request: $_model.ExecuteAdhocWorkflowInstanceRequest): Promise<$_model.ExecuteAdhocWorkflowInstanceResponse>;
+    /**
+     * 获取Agent指定Session下的模型产出物详情
+     *
+     * @param tmpReq - GetAgentSessionArtifactMetaRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns GetAgentSessionArtifactMetaResponse
+     */
+    getAgentSessionArtifactMetaWithOptions(tmpReq: $_model.GetAgentSessionArtifactMetaRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetAgentSessionArtifactMetaResponse>;
+    /**
+     * 获取Agent指定Session下的模型产出物详情
+     *
+     * @param request - GetAgentSessionArtifactMetaRequest
+     * @returns GetAgentSessionArtifactMetaResponse
+     */
+    getAgentSessionArtifactMeta(request: $_model.GetAgentSessionArtifactMetaRequest): Promise<$_model.GetAgentSessionArtifactMetaResponse>;
+    /**
+     * 获取Agent指定Session下的Token用量
+     *
+     * @param tmpReq - GetAgentSessionTokenUsageRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns GetAgentSessionTokenUsageResponse
+     */
+    getAgentSessionTokenUsageWithOptions(tmpReq: $_model.GetAgentSessionTokenUsageRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetAgentSessionTokenUsageResponse>;
+    /**
+     * 获取Agent指定Session下的Token用量
+     *
+     * @param request - GetAgentSessionTokenUsageRequest
+     * @returns GetAgentSessionTokenUsageResponse
+     */
+    getAgentSessionTokenUsage(request: $_model.GetAgentSessionTokenUsageRequest): Promise<$_model.GetAgentSessionTokenUsageResponse>;
     /**
      * Queries a custom alert monitoring rule.
      *
@@ -2217,6 +2307,21 @@ export default class Client extends OpenApi {
      * @returns GetNodeResponse
      */
     getNode(request: $_model.GetNodeRequest): Promise<$_model.GetNodeResponse>;
+    /**
+     * Obtains the details of a parameter by parameter ID.
+     *
+     * @param request - GetParameterRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns GetParameterResponse
+     */
+    getParameterWithOptions(request: $_model.GetParameterRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetParameterResponse>;
+    /**
+     * Obtains the details of a parameter by parameter ID.
+     *
+     * @param request - GetParameterRequest
+     * @returns GetParameterResponse
+     */
+    getParameter(request: $_model.GetParameterRequest): Promise<$_model.GetParameterResponse>;
     /**
      * Retrieves partition details for a data map table. Currently supports MaxCompute and HMS (EMR cluster) types only.
      *
@@ -2604,6 +2709,51 @@ export default class Client extends OpenApi {
      * @returns ImportWorkflowDefinitionResponse
      */
     importWorkflowDefinition(request: $_model.ImportWorkflowDefinitionRequest): Promise<$_model.ImportWorkflowDefinitionResponse>;
+    /**
+     * 获取Agent指定Session下的模型产出物清单列表
+     *
+     * @param tmpReq - ListAgentSessionArtifactsRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns ListAgentSessionArtifactsResponse
+     */
+    listAgentSessionArtifactsWithOptions(tmpReq: $_model.ListAgentSessionArtifactsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListAgentSessionArtifactsResponse>;
+    /**
+     * 获取Agent指定Session下的模型产出物清单列表
+     *
+     * @param request - ListAgentSessionArtifactsRequest
+     * @returns ListAgentSessionArtifactsResponse
+     */
+    listAgentSessionArtifacts(request: $_model.ListAgentSessionArtifactsRequest): Promise<$_model.ListAgentSessionArtifactsResponse>;
+    /**
+     * 加载Agent Session对话历史列表
+     *
+     * @param tmpReq - ListAgentSessionsRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns ListAgentSessionsResponse
+     */
+    listAgentSessionsWithOptions(tmpReq: $_model.ListAgentSessionsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListAgentSessionsResponse>;
+    /**
+     * 加载Agent Session对话历史列表
+     *
+     * @param request - ListAgentSessionsRequest
+     * @returns ListAgentSessionsResponse
+     */
+    listAgentSessions(request: $_model.ListAgentSessionsRequest): Promise<$_model.ListAgentSessionsResponse>;
+    /**
+     * 获取DataAgent的Agent定义列表
+     *
+     * @param tmpReq - ListAgentsRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns ListAgentsResponse
+     */
+    listAgentsWithOptions(tmpReq: $_model.ListAgentsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListAgentsResponse>;
+    /**
+     * 获取DataAgent的Agent定义列表
+     *
+     * @param request - ListAgentsRequest
+     * @returns ListAgentsResponse
+     */
+    listAgents(request: $_model.ListAgentsRequest): Promise<$_model.ListAgentsResponse>;
     /**
      * Queries a list of custom monitoring alert rules.
      *
@@ -2726,7 +2876,6 @@ export default class Client extends OpenApi {
     /**
      * Queries a list of metadata crawler types supported in Data Map. The subtypes of the types and the hierarchical relationship between the subtypes are also returned.
      *
-     * @param request - ListCrawlerTypesRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns ListCrawlerTypesResponse
      */
@@ -3412,6 +3561,36 @@ export default class Client extends OpenApi {
      * @returns ListNodesResponse
      */
     listNodes(request: $_model.ListNodesRequest): Promise<$_model.ListNodesResponse>;
+    /**
+     * Queries the list of parameter versions.
+     *
+     * @param request - ListParameterVersionsRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns ListParameterVersionsResponse
+     */
+    listParameterVersionsWithOptions(request: $_model.ListParameterVersionsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListParameterVersionsResponse>;
+    /**
+     * Queries the list of parameter versions.
+     *
+     * @param request - ListParameterVersionsRequest
+     * @returns ListParameterVersionsResponse
+     */
+    listParameterVersions(request: $_model.ListParameterVersionsRequest): Promise<$_model.ListParameterVersionsResponse>;
+    /**
+     * Queries a list of parameters.
+     *
+     * @param tmpReq - ListParametersRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns ListParametersResponse
+     */
+    listParametersWithOptions(tmpReq: $_model.ListParametersRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListParametersResponse>;
+    /**
+     * Queries a list of parameters.
+     *
+     * @param request - ListParametersRequest
+     * @returns ListParametersResponse
+     */
+    listParameters(request: $_model.ListParametersRequest): Promise<$_model.ListParametersResponse>;
     /**
      * Queries a list of partitions in a table in Data Map. Only tables of the MaxCompute and E-MapReduce (EMR)-type Hive Metastore Service (HMS) metadata crawlers are supported.
      *
@@ -3808,6 +3987,29 @@ export default class Client extends OpenApi {
      * @returns ListWorkflowsResponse
      */
     listWorkflows(request: $_model.ListWorkflowsRequest): Promise<$_model.ListWorkflowsResponse>;
+    /**
+     * 加载Agent Session对话历史
+     *
+     * @param tmpReq - LoadAgentSessionRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns LoadAgentSessionResponse
+     */
+    loadAgentSessionWithSSE(tmpReq: $_model.LoadAgentSessionRequest, runtime: $dara.RuntimeOptions): AsyncGenerator<$_model.LoadAgentSessionResponse, any, unknown>;
+    /**
+     * 加载Agent Session对话历史
+     *
+     * @param tmpReq - LoadAgentSessionRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns LoadAgentSessionResponse
+     */
+    loadAgentSessionWithOptions(tmpReq: $_model.LoadAgentSessionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.LoadAgentSessionResponse>;
+    /**
+     * 加载Agent Session对话历史
+     *
+     * @param request - LoadAgentSessionRequest
+     * @returns LoadAgentSessionResponse
+     */
+    loadAgentSession(request: $_model.LoadAgentSessionRequest): Promise<$_model.LoadAgentSessionResponse>;
     /**
      * Moves a user-defined function (UDF) to a path in DataStudio.
      *
@@ -3883,6 +4085,29 @@ export default class Client extends OpenApi {
      * @returns PreviewDatasetVersionResponse
      */
     previewDatasetVersion(request: $_model.PreviewDatasetVersionRequest): Promise<$_model.PreviewDatasetVersionResponse>;
+    /**
+     * 在当前的Agent Session中发起一轮新的对话
+     *
+     * @param tmpReq - PromptAgentSessionRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns PromptAgentSessionResponse
+     */
+    promptAgentSessionWithSSE(tmpReq: $_model.PromptAgentSessionRequest, runtime: $dara.RuntimeOptions): AsyncGenerator<$_model.PromptAgentSessionResponse, any, unknown>;
+    /**
+     * 在当前的Agent Session中发起一轮新的对话
+     *
+     * @param tmpReq - PromptAgentSessionRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns PromptAgentSessionResponse
+     */
+    promptAgentSessionWithOptions(tmpReq: $_model.PromptAgentSessionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.PromptAgentSessionResponse>;
+    /**
+     * 在当前的Agent Session中发起一轮新的对话
+     *
+     * @param request - PromptAgentSessionRequest
+     * @returns PromptAgentSessionResponse
+     */
+    promptAgentSession(request: $_model.PromptAgentSessionRequest): Promise<$_model.PromptAgentSessionResponse>;
     /**
      * Removes an entity from a collection in Data Map. Collections include categories and data albums. Entities can be only tables. If you want to remove an entity from a data album, the account that you use must be attached the AliyunDataWorksFullAccess policy, or you are the data album creator or administrator.
      *
@@ -4057,6 +4282,21 @@ export default class Client extends OpenApi {
      * @returns RevokeMemberProjectRolesResponse
      */
     revokeMemberProjectRoles(request: $_model.RevokeMemberProjectRolesRequest): Promise<$_model.RevokeMemberProjectRolesResponse>;
+    /**
+     * Rolls back the specified parameter.
+     *
+     * @param request - RollbackParameterRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns RollbackParameterResponse
+     */
+    rollbackParameterWithOptions(request: $_model.RollbackParameterRequest, runtime: $dara.RuntimeOptions): Promise<$_model.RollbackParameterResponse>;
+    /**
+     * Rolls back the specified parameter.
+     *
+     * @param request - RollbackParameterRequest
+     * @returns RollbackParameterResponse
+     */
+    rollbackParameter(request: $_model.RollbackParameterRequest): Promise<$_model.RollbackParameterResponse>;
     /**
      * Sets the statuses of multiple instances to successful at a time.
      *
@@ -4710,6 +4950,21 @@ export default class Client extends OpenApi {
      * @returns UpdateNodeResponse
      */
     updateNode(request: $_model.UpdateNodeRequest): Promise<$_model.UpdateNodeResponse>;
+    /**
+     * Updates a parameter. Incremental modification. Only the specified columns are modified.
+     *
+     * @param tmpReq - UpdateParameterRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns UpdateParameterResponse
+     */
+    updateParameterWithOptions(tmpReq: $_model.UpdateParameterRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateParameterResponse>;
+    /**
+     * Updates a parameter. Incremental modification. Only the specified columns are modified.
+     *
+     * @param request - UpdateParameterRequest
+     * @returns UpdateParameterResponse
+     */
+    updateParameter(request: $_model.UpdateParameterRequest): Promise<$_model.UpdateParameterResponse>;
     /**
      * Updates a DataWorks workspace.
      *