@alicloud/dataworks-public20240518 8.2.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.
      *
@@ -115,7 +130,7 @@ export default class Client extends OpenApi {
      */
     batchUpdateTasks(request: $_model.BatchUpdateTasksRequest): Promise<$_model.BatchUpdateTasksResponse>;
     /**
-     * 取消并停止Agent当前正在进行中的Session会话
+     * Interrupts an agent call for a specified session. Streaming response interruption is supported.
      *
      * @param tmpReq - CancelAgentSessionRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -123,7 +138,7 @@ export default class Client extends OpenApi {
      */
     cancelAgentSessionWithOptions(tmpReq: $_model.CancelAgentSessionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CancelAgentSessionResponse>;
     /**
-     * 取消并停止Agent当前正在进行中的Session会话
+     * Interrupts an agent call for a specified session. Streaming response interruption is supported.
      *
      * @param request - CancelAgentSessionRequest
      * @returns CancelAgentSessionResponse
@@ -155,7 +170,7 @@ export default class Client extends OpenApi {
      */
     cloneDataSource(request: $_model.CloneDataSourceRequest): Promise<$_model.CloneDataSourceResponse>;
     /**
-     * 创建一个Agent Session会话
+     * Creates a new Agent session and returns the session ID.
      *
      * @param tmpReq - CreateAgentSessionRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -163,7 +178,7 @@ export default class Client extends OpenApi {
      */
     createAgentSessionWithOptions(tmpReq: $_model.CreateAgentSessionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateAgentSessionResponse>;
     /**
-     * 创建一个Agent Session会话
+     * Creates a new Agent session and returns the session ID.
      *
      * @param request - CreateAgentSessionRequest
      * @returns CreateAgentSessionResponse
@@ -1577,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.
      *
@@ -1662,7 +1692,7 @@ export default class Client extends OpenApi {
      */
     executeAdhocWorkflowInstance(request: $_model.ExecuteAdhocWorkflowInstanceRequest): Promise<$_model.ExecuteAdhocWorkflowInstanceResponse>;
     /**
-     * 获取Agent指定Session下的模型产出物详情
+     * 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
@@ -1670,14 +1700,14 @@ export default class Client extends OpenApi {
      */
     getAgentSessionArtifactMetaWithOptions(tmpReq: $_model.GetAgentSessionArtifactMetaRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetAgentSessionArtifactMetaResponse>;
     /**
-     * 获取Agent指定Session下的模型产出物详情
+     * 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>;
     /**
-     * 获取Agent指定Session下的Token用量
+     * Queries the cumulative AI token usage of a session aggregated by session ID.
      *
      * @param tmpReq - GetAgentSessionTokenUsageRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1685,7 +1715,7 @@ export default class Client extends OpenApi {
      */
     getAgentSessionTokenUsageWithOptions(tmpReq: $_model.GetAgentSessionTokenUsageRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetAgentSessionTokenUsageResponse>;
     /**
-     * 获取Agent指定Session下的Token用量
+     * Queries the cumulative AI token usage of a session aggregated by session ID.
      *
      * @param request - GetAgentSessionTokenUsageRequest
      * @returns GetAgentSessionTokenUsageResponse
@@ -2226,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.
      *
@@ -2710,7 +2755,7 @@ export default class Client extends OpenApi {
      */
     importWorkflowDefinition(request: $_model.ImportWorkflowDefinitionRequest): Promise<$_model.ImportWorkflowDefinitionResponse>;
     /**
-     * 获取Agent指定Session下的模型产出物清单列表
+     * Queries the Artifact files that are produced by a specified session.
      *
      * @param tmpReq - ListAgentSessionArtifactsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -2718,14 +2763,14 @@ export default class Client extends OpenApi {
      */
     listAgentSessionArtifactsWithOptions(tmpReq: $_model.ListAgentSessionArtifactsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListAgentSessionArtifactsResponse>;
     /**
-     * 获取Agent指定Session下的模型产出物清单列表
+     * Queries the Artifact files that are produced by a specified session.
      *
      * @param request - ListAgentSessionArtifactsRequest
      * @returns ListAgentSessionArtifactsResponse
      */
     listAgentSessionArtifacts(request: $_model.ListAgentSessionArtifactsRequest): Promise<$_model.ListAgentSessionArtifactsResponse>;
     /**
-     * 加载Agent Session对话历史列表
+     * Loads the conversation history list of an Agent Session.
      *
      * @param tmpReq - ListAgentSessionsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -2733,14 +2778,14 @@ export default class Client extends OpenApi {
      */
     listAgentSessionsWithOptions(tmpReq: $_model.ListAgentSessionsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListAgentSessionsResponse>;
     /**
-     * 加载Agent Session对话历史列表
+     * Loads the conversation history list of an Agent Session.
      *
      * @param request - ListAgentSessionsRequest
      * @returns ListAgentSessionsResponse
      */
     listAgentSessions(request: $_model.ListAgentSessionsRequest): Promise<$_model.ListAgentSessionsResponse>;
     /**
-     * 获取DataAgent的Agent定义列表
+     * 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
@@ -2748,7 +2793,7 @@ export default class Client extends OpenApi {
      */
     listAgentsWithOptions(tmpReq: $_model.ListAgentsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListAgentsResponse>;
     /**
-     * 获取DataAgent的Agent定义列表
+     * Queries the list of agents available for the current tenant. Supports filtering by name and pagination.
      *
      * @param request - ListAgentsRequest
      * @returns ListAgentsResponse
@@ -3465,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.
      *
@@ -3988,7 +4078,7 @@ export default class Client extends OpenApi {
      */
     listWorkflows(request: $_model.ListWorkflowsRequest): Promise<$_model.ListWorkflowsResponse>;
     /**
-     * 加载Agent Session对话历史
+     * 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
@@ -3996,7 +4086,7 @@ export default class Client extends OpenApi {
      */
     loadAgentSessionWithSSE(tmpReq: $_model.LoadAgentSessionRequest, runtime: $dara.RuntimeOptions): AsyncGenerator<$_model.LoadAgentSessionResponse, any, unknown>;
     /**
-     * 加载Agent Session对话历史
+     * 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
@@ -4004,7 +4094,7 @@ export default class Client extends OpenApi {
      */
     loadAgentSessionWithOptions(tmpReq: $_model.LoadAgentSessionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.LoadAgentSessionResponse>;
     /**
-     * 加载Agent Session对话历史
+     * 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
@@ -4086,7 +4176,7 @@ export default class Client extends OpenApi {
      */
     previewDatasetVersion(request: $_model.PreviewDatasetVersionRequest): Promise<$_model.PreviewDatasetVersionResponse>;
     /**
-     * 在当前的Agent Session中发起一轮新的对话
+     * 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
@@ -4094,7 +4184,7 @@ export default class Client extends OpenApi {
      */
     promptAgentSessionWithSSE(tmpReq: $_model.PromptAgentSessionRequest, runtime: $dara.RuntimeOptions): AsyncGenerator<$_model.PromptAgentSessionResponse, any, unknown>;
     /**
-     * 在当前的Agent Session中发起一轮新的对话
+     * 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
@@ -4102,7 +4192,7 @@ export default class Client extends OpenApi {
      */
     promptAgentSessionWithOptions(tmpReq: $_model.PromptAgentSessionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.PromptAgentSessionResponse>;
     /**
-     * 在当前的Agent Session中发起一轮新的对话
+     * Sends a user prompt to an existing session and streams back the agent response.
      *
      * @param request - PromptAgentSessionRequest
      * @returns PromptAgentSessionResponse