@alicloud/dataworks-public20240518 8.1.0 → 8.3.0

package/dist/client.d.ts

@@ -49,6 +49,21 @@ export default class Client extends OpenApi {
      * @returns AddEntityIntoMetaCollectionResponse
      */
     addEntityIntoMetaCollection(request: $_model.AddEntityIntoMetaCollectionRequest): Promise<$_model.AddEntityIntoMetaCollectionResponse>;
+    /**
+     * Adds a custom image to a workspace.
+     *
+     * @param request - AssociateProjectToImageRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns AssociateProjectToImageResponse
+     */
+    associateProjectToImageWithOptions(request: $_model.AssociateProjectToImageRequest, runtime: $dara.RuntimeOptions): Promise<$_model.AssociateProjectToImageResponse>;
+    /**
+     * Adds a custom image to a workspace.
+     *
+     * @param request - AssociateProjectToImageRequest
+     * @returns AssociateProjectToImageResponse
+     */
+    associateProjectToImage(request: $_model.AssociateProjectToImageRequest): Promise<$_model.AssociateProjectToImageResponse>;
     /**
      * Associates a resource group with a workspace.
      *
@@ -114,6 +129,21 @@ export default class Client extends OpenApi {
      * @returns BatchUpdateTasksResponse
      */
     batchUpdateTasks(request: $_model.BatchUpdateTasksRequest): Promise<$_model.BatchUpdateTasksResponse>;
+    /**
+     * Interrupts an agent call for a specified session. Streaming response interruption is supported.
+     *
+     * @param tmpReq - CancelAgentSessionRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns CancelAgentSessionResponse
+     */
+    cancelAgentSessionWithOptions(tmpReq: $_model.CancelAgentSessionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CancelAgentSessionResponse>;
+    /**
+     * Interrupts an agent call for a specified session. Streaming response interruption is supported.
+     *
+     * @param request - CancelAgentSessionRequest
+     * @returns CancelAgentSessionResponse
+     */
+    cancelAgentSession(request: $_model.CancelAgentSessionRequest): Promise<$_model.CancelAgentSessionResponse>;
     /**
      * Clones an existing data source.
      *
@@ -139,6 +169,21 @@ export default class Client extends OpenApi {
      * @returns CloneDataSourceResponse
      */
     cloneDataSource(request: $_model.CloneDataSourceRequest): Promise<$_model.CloneDataSourceResponse>;
+    /**
+     * Creates a new Agent session and returns the session ID.
+     *
+     * @param tmpReq - CreateAgentSessionRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns CreateAgentSessionResponse
+     */
+    createAgentSessionWithOptions(tmpReq: $_model.CreateAgentSessionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateAgentSessionResponse>;
+    /**
+     * Creates a new Agent session and returns the session ID.
+     *
+     * @param request - CreateAgentSessionRequest
+     * @returns CreateAgentSessionResponse
+     */
+    createAgentSession(request: $_model.CreateAgentSessionRequest): Promise<$_model.CreateAgentSessionResponse>;
     /**
      * Creates a custom monitoring alert rule.
      *
@@ -649,7 +694,7 @@ export default class Client extends OpenApi {
      */
     createNode(request: $_model.CreateNodeRequest): Promise<$_model.CreateNodeResponse>;
     /**
-     * 创建参数。
+     * Creates a parameter.
      *
      * @param tmpReq - CreateParameterRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -657,7 +702,7 @@ export default class Client extends OpenApi {
      */
     createParameterWithOptions(tmpReq: $_model.CreateParameterRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateParameterResponse>;
     /**
-     * 创建参数。
+     * Creates a parameter.
      *
      * @param request - CreateParameterRequest
      * @returns CreateParameterResponse
@@ -1333,7 +1378,7 @@ export default class Client extends OpenApi {
      */
     deleteNode(request: $_model.DeleteNodeRequest): Promise<$_model.DeleteNodeResponse>;
     /**
-     * 删除参数。
+     * Remove specified parameters.
      *
      * @param request - DeleteParameterRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1341,7 +1386,7 @@ export default class Client extends OpenApi {
      */
     deleteParameterWithOptions(request: $_model.DeleteParameterRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteParameterResponse>;
     /**
-     * 删除参数。
+     * Remove specified parameters.
      *
      * @param request - DeleteParameterRequest
      * @returns DeleteParameterResponse
@@ -1547,6 +1592,21 @@ export default class Client extends OpenApi {
      * @returns DetachDataQualityRulesFromEvaluationTaskResponse
      */
     detachDataQualityRulesFromEvaluationTask(request: $_model.DetachDataQualityRulesFromEvaluationTaskRequest): Promise<$_model.DetachDataQualityRulesFromEvaluationTaskResponse>;
+    /**
+     * Disassociates an image from a workspace.
+     *
+     * @param request - DissociateProjectFromImageRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns DissociateProjectFromImageResponse
+     */
+    dissociateProjectFromImageWithOptions(request: $_model.DissociateProjectFromImageRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DissociateProjectFromImageResponse>;
+    /**
+     * Disassociates an image from a workspace.
+     *
+     * @param request - DissociateProjectFromImageRequest
+     * @returns DissociateProjectFromImageResponse
+     */
+    dissociateProjectFromImage(request: $_model.DissociateProjectFromImageRequest): Promise<$_model.DissociateProjectFromImageResponse>;
     /**
      * Disassociates a resource group from a workspace.
      *
@@ -1631,6 +1691,36 @@ export default class Client extends OpenApi {
      * @returns ExecuteAdhocWorkflowInstanceResponse
      */
     executeAdhocWorkflowInstance(request: $_model.ExecuteAdhocWorkflowInstanceRequest): Promise<$_model.ExecuteAdhocWorkflowInstanceResponse>;
+    /**
+     * Obtains the metadata and body content of an Artifact based on the session ID and file path.
+     *
+     * @param tmpReq - GetAgentSessionArtifactMetaRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns GetAgentSessionArtifactMetaResponse
+     */
+    getAgentSessionArtifactMetaWithOptions(tmpReq: $_model.GetAgentSessionArtifactMetaRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetAgentSessionArtifactMetaResponse>;
+    /**
+     * Obtains the metadata and body content of an Artifact based on the session ID and file path.
+     *
+     * @param request - GetAgentSessionArtifactMetaRequest
+     * @returns GetAgentSessionArtifactMetaResponse
+     */
+    getAgentSessionArtifactMeta(request: $_model.GetAgentSessionArtifactMetaRequest): Promise<$_model.GetAgentSessionArtifactMetaResponse>;
+    /**
+     * Queries the cumulative AI token usage of a session aggregated by session ID.
+     *
+     * @param tmpReq - GetAgentSessionTokenUsageRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns GetAgentSessionTokenUsageResponse
+     */
+    getAgentSessionTokenUsageWithOptions(tmpReq: $_model.GetAgentSessionTokenUsageRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetAgentSessionTokenUsageResponse>;
+    /**
+     * Queries the cumulative AI token usage of a session aggregated by session ID.
+     *
+     * @param request - GetAgentSessionTokenUsageRequest
+     * @returns GetAgentSessionTokenUsageResponse
+     */
+    getAgentSessionTokenUsage(request: $_model.GetAgentSessionTokenUsageRequest): Promise<$_model.GetAgentSessionTokenUsageResponse>;
     /**
      * Queries a custom alert monitoring rule.
      *
@@ -2166,6 +2256,21 @@ export default class Client extends OpenApi {
      * @returns GetIDEEventDetailResponse
      */
     getIDEEventDetail(request: $_model.GetIDEEventDetailRequest): Promise<$_model.GetIDEEventDetailResponse>;
+    /**
+     * Obtains the details of a specified image by image ID.
+     *
+     * @param request - GetImageRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns GetImageResponse
+     */
+    getImageWithOptions(request: $_model.GetImageRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetImageResponse>;
+    /**
+     * Obtains the details of a specified image by image ID.
+     *
+     * @param request - GetImageRequest
+     * @returns GetImageResponse
+     */
+    getImage(request: $_model.GetImageRequest): Promise<$_model.GetImageResponse>;
     /**
      * Queries the status information of an asynchronous task. After you call an asynchronous operation, an asynchronous task is generated. You can call the GetJobStatus operation to query the status of the asynchronous task.
      *
@@ -2248,7 +2353,7 @@ export default class Client extends OpenApi {
      */
     getNode(request: $_model.GetNodeRequest): Promise<$_model.GetNodeResponse>;
     /**
-     * 根据参数ID获取参数的详细信息。
+     * Obtains the details of a parameter by parameter ID.
      *
      * @param request - GetParameterRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -2256,7 +2361,7 @@ export default class Client extends OpenApi {
      */
     getParameterWithOptions(request: $_model.GetParameterRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetParameterResponse>;
     /**
-     * 根据参数ID获取参数的详细信息。
+     * Obtains the details of a parameter by parameter ID.
      *
      * @param request - GetParameterRequest
      * @returns GetParameterResponse
@@ -2649,6 +2754,51 @@ export default class Client extends OpenApi {
      * @returns ImportWorkflowDefinitionResponse
      */
     importWorkflowDefinition(request: $_model.ImportWorkflowDefinitionRequest): Promise<$_model.ImportWorkflowDefinitionResponse>;
+    /**
+     * Queries the Artifact files that are produced by a specified session.
+     *
+     * @param tmpReq - ListAgentSessionArtifactsRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns ListAgentSessionArtifactsResponse
+     */
+    listAgentSessionArtifactsWithOptions(tmpReq: $_model.ListAgentSessionArtifactsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListAgentSessionArtifactsResponse>;
+    /**
+     * Queries the Artifact files that are produced by a specified session.
+     *
+     * @param request - ListAgentSessionArtifactsRequest
+     * @returns ListAgentSessionArtifactsResponse
+     */
+    listAgentSessionArtifacts(request: $_model.ListAgentSessionArtifactsRequest): Promise<$_model.ListAgentSessionArtifactsResponse>;
+    /**
+     * Loads the conversation history list of an 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>;
+    /**
+     * Loads the conversation history list of an Agent Session.
+     *
+     * @param request - ListAgentSessionsRequest
+     * @returns ListAgentSessionsResponse
+     */
+    listAgentSessions(request: $_model.ListAgentSessionsRequest): Promise<$_model.ListAgentSessionsResponse>;
+    /**
+     * Queries the list of agents available for the current tenant. Supports filtering by name and pagination.
+     *
+     * @param tmpReq - ListAgentsRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns ListAgentsResponse
+     */
+    listAgentsWithOptions(tmpReq: $_model.ListAgentsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListAgentsResponse>;
+    /**
+     * Queries the list of agents available for the current tenant. Supports filtering by name and pagination.
+     *
+     * @param request - ListAgentsRequest
+     * @returns ListAgentsResponse
+     */
+    listAgents(request: $_model.ListAgentsRequest): Promise<$_model.ListAgentsResponse>;
     /**
      * Queries a list of custom monitoring alert rules.
      *
@@ -3360,6 +3510,51 @@ export default class Client extends OpenApi {
      * @returns ListFunctionsResponse
      */
     listFunctions(request: $_model.ListFunctionsRequest): Promise<$_model.ListFunctionsResponse>;
+    /**
+     * Queries the workspaces associated with an image.
+     *
+     * @param request - ListImageAssociatedProjectsRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns ListImageAssociatedProjectsResponse
+     */
+    listImageAssociatedProjectsWithOptions(request: $_model.ListImageAssociatedProjectsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListImageAssociatedProjectsResponse>;
+    /**
+     * Queries the workspaces associated with an image.
+     *
+     * @param request - ListImageAssociatedProjectsRequest
+     * @returns ListImageAssociatedProjectsResponse
+     */
+    listImageAssociatedProjects(request: $_model.ListImageAssociatedProjectsRequest): Promise<$_model.ListImageAssociatedProjectsResponse>;
+    /**
+     * Queries the details of a specified image version.
+     *
+     * @param request - ListImageVersionsRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns ListImageVersionsResponse
+     */
+    listImageVersionsWithOptions(request: $_model.ListImageVersionsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListImageVersionsResponse>;
+    /**
+     * Queries the details of a specified image version.
+     *
+     * @param request - ListImageVersionsRequest
+     * @returns ListImageVersionsResponse
+     */
+    listImageVersions(request: $_model.ListImageVersionsRequest): Promise<$_model.ListImageVersionsResponse>;
+    /**
+     * Queries a list of images.
+     *
+     * @param tmpReq - ListImagesRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns ListImagesResponse
+     */
+    listImagesWithOptions(tmpReq: $_model.ListImagesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListImagesResponse>;
+    /**
+     * Queries a list of images.
+     *
+     * @param request - ListImagesRequest
+     * @returns ListImagesResponse
+     */
+    listImages(request: $_model.ListImagesRequest): Promise<$_model.ListImagesResponse>;
     /**
      * Queries the lineage between two entities, such as tables, fields, and Object Storage Service (OSS) files, in Data Map.
      *
@@ -3457,7 +3652,7 @@ export default class Client extends OpenApi {
      */
     listNodes(request: $_model.ListNodesRequest): Promise<$_model.ListNodesResponse>;
     /**
-     * 查询参数版本列表。
+     * Queries the list of parameter versions.
      *
      * @param request - ListParameterVersionsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -3465,14 +3660,14 @@ export default class Client extends OpenApi {
      */
     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
@@ -3480,7 +3675,7 @@ export default class Client extends OpenApi {
      */
     listParametersWithOptions(tmpReq: $_model.ListParametersRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListParametersResponse>;
     /**
-     * 查询参数列表。
+     * Queries a list of parameters.
      *
      * @param request - ListParametersRequest
      * @returns ListParametersResponse
@@ -3882,6 +4077,29 @@ export default class Client extends OpenApi {
      * @returns ListWorkflowsResponse
      */
     listWorkflows(request: $_model.ListWorkflowsRequest): Promise<$_model.ListWorkflowsResponse>;
+    /**
+     * Loads historical messages of an existing session and returns them in SSE streaming mode. If the session does not exist, a JSONRPCResponse.error with code 400 is output through SSE. Content-Type is text/event-stream. Applicable to scenarios where the session context needs to be restored.
+     *
+     * @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>;
+    /**
+     * Loads historical messages of an existing session and returns them in SSE streaming mode. If the session does not exist, a JSONRPCResponse.error with code 400 is output through SSE. Content-Type is text/event-stream. Applicable to scenarios where the session context needs to be restored.
+     *
+     * @param tmpReq - LoadAgentSessionRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns LoadAgentSessionResponse
+     */
+    loadAgentSessionWithOptions(tmpReq: $_model.LoadAgentSessionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.LoadAgentSessionResponse>;
+    /**
+     * Loads historical messages of an existing session and returns them in SSE streaming mode. If the session does not exist, a JSONRPCResponse.error with code 400 is output through SSE. Content-Type is text/event-stream. Applicable to scenarios where the session context needs to be restored.
+     *
+     * @param request - LoadAgentSessionRequest
+     * @returns LoadAgentSessionResponse
+     */
+    loadAgentSession(request: $_model.LoadAgentSessionRequest): Promise<$_model.LoadAgentSessionResponse>;
     /**
      * Moves a user-defined function (UDF) to a path in DataStudio.
      *
@@ -3957,6 +4175,29 @@ export default class Client extends OpenApi {
      * @returns PreviewDatasetVersionResponse
      */
     previewDatasetVersion(request: $_model.PreviewDatasetVersionRequest): Promise<$_model.PreviewDatasetVersionResponse>;
+    /**
+     * Sends a user prompt to an existing session and streams back the agent response.
+     *
+     * @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>;
+    /**
+     * Sends a user prompt to an existing session and streams back the agent response.
+     *
+     * @param tmpReq - PromptAgentSessionRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns PromptAgentSessionResponse
+     */
+    promptAgentSessionWithOptions(tmpReq: $_model.PromptAgentSessionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.PromptAgentSessionResponse>;
+    /**
+     * Sends a user prompt to an existing session and streams back the agent response.
+     *
+     * @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.
      *
@@ -4132,7 +4373,7 @@ export default class Client extends OpenApi {
      */
     revokeMemberProjectRoles(request: $_model.RevokeMemberProjectRolesRequest): Promise<$_model.RevokeMemberProjectRolesResponse>;
     /**
-     * 回滚参数版本。
+     * Rolls back the specified parameter.
      *
      * @param request - RollbackParameterRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -4140,7 +4381,7 @@ export default class Client extends OpenApi {
      */
     rollbackParameterWithOptions(request: $_model.RollbackParameterRequest, runtime: $dara.RuntimeOptions): Promise<$_model.RollbackParameterResponse>;
     /**
-     * 回滚参数版本。
+     * Rolls back the specified parameter.
      *
      * @param request - RollbackParameterRequest
      * @returns RollbackParameterResponse
@@ -4800,7 +5041,7 @@ export default class Client extends OpenApi {
      */
     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
@@ -4808,7 +5049,7 @@ export default class Client extends OpenApi {
      */
     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