@alicloud/dms20250414 1.22.0 → 1.23.0

package/dist/client.js

@@ -956,6 +956,60 @@ class Client extends openapi_core_1.default {
         let runtime = new $dara.RuntimeOptions({});
         return await this.createDataAgentSessionWithOptions(request, runtime);
     }
+    /**
+     * Creates a DataAgent theme.
+     *
+     * @param request - CreateDataAgentThemeRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns CreateDataAgentThemeResponse
+     */
+    async createDataAgentThemeWithOptions(request, runtime) {
+        request.validate();
+        let query = {};
+        if (!$dara.isNull(request.category)) {
+            query["Category"] = request.category;
+        }
+        if (!$dara.isNull(request.description)) {
+            query["Description"] = request.description;
+        }
+        if (!$dara.isNull(request.fileFrom)) {
+            query["FileFrom"] = request.fileFrom;
+        }
+        if (!$dara.isNull(request.themeId)) {
+            query["ThemeId"] = request.themeId;
+        }
+        if (!$dara.isNull(request.themeName)) {
+            query["ThemeName"] = request.themeName;
+        }
+        if (!$dara.isNull(request.themeType)) {
+            query["ThemeType"] = request.themeType;
+        }
+        let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
+            query: openapi_core_2.OpenApiUtil.query(query),
+        });
+        let params = new openapi_core_2.$OpenApiUtil.Params({
+            action: "CreateDataAgentTheme",
+            version: "2025-04-14",
+            protocol: "HTTPS",
+            pathname: "/",
+            method: "POST",
+            authType: "AK",
+            style: "RPC",
+            reqBodyType: "formData",
+            bodyType: "json",
+        });
+        return $dara.cast(await this.callApi(params, req, runtime), new $_model.CreateDataAgentThemeResponse({}));
+    }
+    /**
+     * Creates a DataAgent theme.
+     *
+     * @param request - CreateDataAgentThemeRequest
+     * @returns CreateDataAgentThemeResponse
+     */
+    async createDataAgentTheme(request) {
+        let runtime = new $dara.RuntimeOptions({});
+        return await this.createDataAgentThemeWithOptions(request, runtime);
+    }
     /**
      * Creates a DataAgent workspace.
      *
@@ -1250,7 +1304,7 @@ class Client extends openapi_core_1.default {
         return await this.createDataLakeTableWithOptions(request, runtime);
     }
     /**
-     * 创建sql模版
+     * Creates an SQL template.
      *
      * @param request - CreateOneMetaSqlTemplateRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1300,7 +1354,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.CreateOneMetaSqlTemplateResponse({}));
     }
     /**
-     * 创建sql模版
+     * Creates an SQL template.
      *
      * @param request - CreateOneMetaSqlTemplateRequest
      * @returns CreateOneMetaSqlTemplateResponse
@@ -2015,7 +2069,7 @@ class Client extends openapi_core_1.default {
         return await this.deleteFileUploadWithOptions(request, runtime);
     }
     /**
-     * 删除onemeta3.0的Ossie模型
+     * Deletes an Ossie model from onemeta 3.0.
      *
      * @param request - DeleteOneMetaOssieModelRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -2044,7 +2098,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteOneMetaOssieModelResponse({}));
     }
     /**
-     * 删除onemeta3.0的Ossie模型
+     * Deletes an Ossie model from onemeta 3.0.
      *
      * @param request - DeleteOneMetaOssieModelRequest
      * @returns DeleteOneMetaOssieModelResponse
@@ -2054,7 +2108,7 @@ class Client extends openapi_core_1.default {
         return await this.deleteOneMetaOssieModelWithOptions(request, runtime);
     }
     /**
-     * 删除sql模版
+     * Deletes a knowledge base in OneMeta 3.0.
      *
      * @param request - DeleteOneMetaSqlTemplateRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -2083,7 +2137,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteOneMetaSqlTemplateResponse({}));
     }
     /**
-     * 删除sql模版
+     * Deletes a knowledge base in OneMeta 3.0.
      *
      * @param request - DeleteOneMetaSqlTemplateRequest
      * @returns DeleteOneMetaSqlTemplateResponse
@@ -2281,6 +2335,45 @@ class Client extends openapi_core_1.default {
         let runtime = new $dara.RuntimeOptions({});
         return await this.describeDataAgentSessionWithOptions(request, runtime);
     }
+    /**
+     * Invokes the DescribeDataAgentTheme operation to query the details of a single DataAgent theme, including the theme name, stage, source, common scenarios, description, and creation and modification time.
+     *
+     * @param request - DescribeDataAgentThemeRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns DescribeDataAgentThemeResponse
+     */
+    async describeDataAgentThemeWithOptions(request, runtime) {
+        request.validate();
+        let query = {};
+        if (!$dara.isNull(request.themeId)) {
+            query["ThemeId"] = request.themeId;
+        }
+        let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
+            query: openapi_core_2.OpenApiUtil.query(query),
+        });
+        let params = new openapi_core_2.$OpenApiUtil.Params({
+            action: "DescribeDataAgentTheme",
+            version: "2025-04-14",
+            protocol: "HTTPS",
+            pathname: "/",
+            method: "POST",
+            authType: "AK",
+            style: "RPC",
+            reqBodyType: "formData",
+            bodyType: "json",
+        });
+        return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeDataAgentThemeResponse({}));
+    }
+    /**
+     * Invokes the DescribeDataAgentTheme operation to query the details of a single DataAgent theme, including the theme name, stage, source, common scenarios, description, and creation and modification time.
+     *
+     * @param request - DescribeDataAgentThemeRequest
+     * @returns DescribeDataAgentThemeResponse
+     */
+    async describeDataAgentTheme(request) {
+        let runtime = new $dara.RuntimeOptions({});
+        return await this.describeDataAgentThemeWithOptions(request, runtime);
+    }
     /**
      * Retrieves the details of a specific document.
      *
@@ -2910,6 +3003,47 @@ class Client extends openapi_core_1.default {
         let runtime = new $dara.RuntimeOptions({});
         return await this.getDataAgentTaskModelUsageMetricsWithOptions(request, runtime);
     }
+    /**
+     * Calls the GetDataAgentThemeUploadSignature operation to obtain OSS direct upload credentials for uploading a DataAgent theme file. After obtaining the credentials, use the PostObject method to upload the theme file directly to OSS. After the upload is complete, call the CreateDataAgentTheme operation with the returned ThemeId to complete theme creation.
+     * Refer to https://www.alibabacloud.com/help/en/oss/user-guide/client-direct-transmission/ for instructions on uploading the theme file.
+     *
+     * @param request - GetDataAgentThemeUploadSignatureRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns GetDataAgentThemeUploadSignatureResponse
+     */
+    async getDataAgentThemeUploadSignatureWithOptions(request, runtime) {
+        request.validate();
+        let query = {};
+        if (!$dara.isNull(request.themeId)) {
+            query["ThemeId"] = request.themeId;
+        }
+        let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
+            query: openapi_core_2.OpenApiUtil.query(query),
+        });
+        let params = new openapi_core_2.$OpenApiUtil.Params({
+            action: "GetDataAgentThemeUploadSignature",
+            version: "2025-04-14",
+            protocol: "HTTPS",
+            pathname: "/",
+            method: "POST",
+            authType: "AK",
+            style: "RPC",
+            reqBodyType: "formData",
+            bodyType: "json",
+        });
+        return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetDataAgentThemeUploadSignatureResponse({}));
+    }
+    /**
+     * Calls the GetDataAgentThemeUploadSignature operation to obtain OSS direct upload credentials for uploading a DataAgent theme file. After obtaining the credentials, use the PostObject method to upload the theme file directly to OSS. After the upload is complete, call the CreateDataAgentTheme operation with the returned ThemeId to complete theme creation.
+     * Refer to https://www.alibabacloud.com/help/en/oss/user-guide/client-direct-transmission/ for instructions on uploading the theme file.
+     *
+     * @param request - GetDataAgentThemeUploadSignatureRequest
+     * @returns GetDataAgentThemeUploadSignatureResponse
+     */
+    async getDataAgentThemeUploadSignature(request) {
+        let runtime = new $dara.RuntimeOptions({});
+        return await this.getDataAgentThemeUploadSignatureWithOptions(request, runtime);
+    }
     /**
      * Retrieves the details of a collaborative workspace.
      *
@@ -3350,7 +3484,7 @@ class Client extends openapi_core_1.default {
         return await this.getNotebookTaskStatusWithOptions(request, runtime);
     }
     /**
-     * 获取onemeta3.0的Ossie模型
+     * Retrieves the Ossie model of onemeta 3.0.
      *
      * @param request - GetOneMetaOssieModelRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -3382,7 +3516,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetOneMetaOssieModelResponse({}));
     }
     /**
-     * 获取onemeta3.0的Ossie模型
+     * Retrieves the Ossie model of onemeta 3.0.
      *
      * @param request - GetOneMetaOssieModelRequest
      * @returns GetOneMetaOssieModelResponse
@@ -3593,7 +3727,7 @@ class Client extends openapi_core_1.default {
         return await this.getWorkspaceQuotaWithOptions(request, runtime);
     }
     /**
-     * 导入Ossie模型
+     * Creates an SQL template.
      *
      * @param request - ImportOneMetaOssieModelRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -3643,7 +3777,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ImportOneMetaOssieModelResponse({}));
     }
     /**
-     * 导入Ossie模型
+     * Creates an SQL template.
      *
      * @param request - ImportOneMetaOssieModelRequest
      * @returns ImportOneMetaOssieModelResponse
@@ -4306,6 +4440,63 @@ class Client extends openapi_core_1.default {
         let runtime = new $dara.RuntimeOptions({});
         return await this.listDataAgentSessionWithOptions(request, runtime);
     }
+    /**
+     * Invokes the ListDataAgentTheme operation to query the DataAgent theme list by paging. You can filter themes by theme stage, source, and common scenarios.
+     *
+     * @param request - ListDataAgentThemeRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns ListDataAgentThemeResponse
+     */
+    async listDataAgentThemeWithOptions(request, runtime) {
+        request.validate();
+        let query = {};
+        if (!$dara.isNull(request.category)) {
+            query["Category"] = request.category;
+        }
+        if (!$dara.isNull(request.maxResults)) {
+            query["MaxResults"] = request.maxResults;
+        }
+        if (!$dara.isNull(request.nextToken)) {
+            query["NextToken"] = request.nextToken;
+        }
+        if (!$dara.isNull(request.pageNumber)) {
+            query["PageNumber"] = request.pageNumber;
+        }
+        if (!$dara.isNull(request.pageSize)) {
+            query["PageSize"] = request.pageSize;
+        }
+        if (!$dara.isNull(request.themeFrom)) {
+            query["ThemeFrom"] = request.themeFrom;
+        }
+        if (!$dara.isNull(request.themeType)) {
+            query["ThemeType"] = request.themeType;
+        }
+        let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
+            query: openapi_core_2.OpenApiUtil.query(query),
+        });
+        let params = new openapi_core_2.$OpenApiUtil.Params({
+            action: "ListDataAgentTheme",
+            version: "2025-04-14",
+            protocol: "HTTPS",
+            pathname: "/",
+            method: "POST",
+            authType: "AK",
+            style: "RPC",
+            reqBodyType: "formData",
+            bodyType: "json",
+        });
+        return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListDataAgentThemeResponse({}));
+    }
+    /**
+     * Invokes the ListDataAgentTheme operation to query the DataAgent theme list by paging. You can filter themes by theme stage, source, and common scenarios.
+     *
+     * @param request - ListDataAgentThemeRequest
+     * @returns ListDataAgentThemeResponse
+     */
+    async listDataAgentTheme(request) {
+        let runtime = new $dara.RuntimeOptions({});
+        return await this.listDataAgentThemeWithOptions(request, runtime);
+    }
     /**
      * Retrieves the workspaces under the primary account with pagination.
      *
@@ -5366,7 +5557,7 @@ class Client extends openapi_core_1.default {
         return await this.listKnowledgeBasesWithOptions(request, runtime);
     }
     /**
-     * 获取ossie模型列表
+     * Retrieves a list of OSSIE models.
      *
      * @param request - ListOneMetaOssieModelsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -5413,7 +5604,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListOneMetaOssieModelsResponse({}));
     }
     /**
-     * 获取ossie模型列表
+     * Retrieves a list of OSSIE models.
      *
      * @param request - ListOneMetaOssieModelsRequest
      * @returns ListOneMetaOssieModelsResponse
@@ -5423,7 +5614,7 @@ class Client extends openapi_core_1.default {
         return await this.listOneMetaOssieModelsWithOptions(request, runtime);
     }
     /**
-     * 获取sql模版
+     * Retrieves SQL templates.
      *
      * @param request - ListOneMetaSqlTemplatesRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -5473,7 +5664,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListOneMetaSqlTemplatesResponse({}));
     }
     /**
-     * 获取sql模版
+     * Retrieves SQL templates.
      *
      * @param request - ListOneMetaSqlTemplatesRequest
      * @returns ListOneMetaSqlTemplatesResponse
@@ -5709,6 +5900,51 @@ class Client extends openapi_core_1.default {
         let runtime = new $dara.RuntimeOptions({});
         return await this.modifyDataAgentMcpWithOptions(request, runtime);
     }
+    /**
+     * ModifyDataAgentTheme
+     *
+     * @param request - ModifyDataAgentThemeRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns ModifyDataAgentThemeResponse
+     */
+    async modifyDataAgentThemeWithOptions(request, runtime) {
+        request.validate();
+        let query = {};
+        if (!$dara.isNull(request.description)) {
+            query["Description"] = request.description;
+        }
+        if (!$dara.isNull(request.themeId)) {
+            query["ThemeId"] = request.themeId;
+        }
+        if (!$dara.isNull(request.themeName)) {
+            query["ThemeName"] = request.themeName;
+        }
+        let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
+            query: openapi_core_2.OpenApiUtil.query(query),
+        });
+        let params = new openapi_core_2.$OpenApiUtil.Params({
+            action: "ModifyDataAgentTheme",
+            version: "2025-04-14",
+            protocol: "HTTPS",
+            pathname: "/",
+            method: "POST",
+            authType: "AK",
+            style: "RPC",
+            reqBodyType: "formData",
+            bodyType: "json",
+        });
+        return $dara.cast(await this.callApi(params, req, runtime), new $_model.ModifyDataAgentThemeResponse({}));
+    }
+    /**
+     * ModifyDataAgentTheme
+     *
+     * @param request - ModifyDataAgentThemeRequest
+     * @returns ModifyDataAgentThemeResponse
+     */
+    async modifyDataAgentTheme(request) {
+        let runtime = new $dara.RuntimeOptions({});
+        return await this.modifyDataAgentThemeWithOptions(request, runtime);
+    }
     /**
      * Operate custom agents in personal spaces and workspaces.
      *
@@ -5992,12 +6228,10 @@ class Client extends openapi_core_1.default {
      *
      * @remarks
      * ## Request description
-     * - `agent_id` and `session_id` are required fields.
      * - `message_type` defaults to `primary`. Set it to `additional` or `cancel` when you need to append information or cancel a session.
      * - The `reply_to` field indicates which Agent message this message is responding to. The default value is `0`.
      * - When `message_type` is `additional`, the `question` field is required.
-     * - `quoted_message` can be used to quote the user\\"s previous message content.
-     * - Fields such as `data_source`, `dms_user`, `db_metadata`, and `session_config` are optional but provide more detailed context information.
+     * - `quoted_message` can be used to quote the content of a previous user message.
      *
      * @param tmpReq - SendChatMessageRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -6086,12 +6320,10 @@ class Client extends openapi_core_1.default {
      *
      * @remarks
      * ## Request description
-     * - `agent_id` and `session_id` are required fields.
      * - `message_type` defaults to `primary`. Set it to `additional` or `cancel` when you need to append information or cancel a session.
      * - The `reply_to` field indicates which Agent message this message is responding to. The default value is `0`.
      * - When `message_type` is `additional`, the `question` field is required.
-     * - `quoted_message` can be used to quote the user\\"s previous message content.
-     * - Fields such as `data_source`, `dms_user`, `db_metadata`, and `session_config` are optional but provide more detailed context information.
+     * - `quoted_message` can be used to quote the content of a previous user message.
      *
      * @param request - SendChatMessageRequest
      * @returns SendChatMessageResponse
@@ -7013,7 +7245,7 @@ class Client extends openapi_core_1.default {
         return await this.updateKnowledgeBaseWithOptions(request, runtime);
     }
     /**
-     * 更新Ossie模型
+     * Updates an SQL template.
      *
      * @param request - UpdateOneMetaOssieModelRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -7063,7 +7295,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.UpdateOneMetaOssieModelResponse({}));
     }
     /**
-     * 更新Ossie模型
+     * Updates an SQL template.
      *
      * @param request - UpdateOneMetaOssieModelRequest
      * @returns UpdateOneMetaOssieModelResponse
@@ -7073,7 +7305,7 @@ class Client extends openapi_core_1.default {
         return await this.updateOneMetaOssieModelWithOptions(request, runtime);
     }
     /**
-     * 更新sql模版
+     * Updates an SQL template.
      *
      * @param request - UpdateOneMetaSqlTemplateRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -7123,7 +7355,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.UpdateOneMetaSqlTemplateResponse({}));
     }
     /**
-     * 更新sql模版
+     * Updates an SQL template.
      *
      * @param request - UpdateOneMetaSqlTemplateRequest
      * @returns UpdateOneMetaSqlTemplateResponse