@alicloud/bailian20231229 2.8.0 → 2.8.2

package/dist/client.d.ts

@@ -91,7 +91,7 @@ export default class Client extends OpenApi {
      */
     addFilesFromAuthorizedOss(WorkspaceId: string, request: $_model.AddFilesFromAuthorizedOssRequest): Promise<$_model.AddFilesFromAuthorizedOssResponse>;
     /**
-     * Applies for a document upload lease to upload a document.
+     * Applies for a document upload lease to upload a document. You cannot use the API to upload structured documents. Use the console instead.
      *
      * @remarks
      *   This operation returns an HTTP URL that can be used to upload an unstructured document (the lease) and parameters required for the upload. Structured documents are not supported.
@@ -108,7 +108,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ApplyFileUploadLeaseResponse>;
     /**
-     * Applies for a document upload lease to upload a document.
+     * Applies for a document upload lease to upload a document. You cannot use the API to upload structured documents. Use the console instead.
      *
      * @remarks
      *   This operation returns an HTTP URL that can be used to upload an unstructured document (the lease) and parameters required for the upload. Structured documents are not supported.
@@ -288,7 +288,7 @@ export default class Client extends OpenApi {
      */
     deleteAgent(workspaceId: string, appCode: string): Promise<$_model.DeleteAgentResponse>;
     /**
-     * 删除类目
+     * Deletes a specified category permanently.
      *
      * @param headers - map
      * @param runtime - runtime options for this request RuntimeOptions
@@ -298,7 +298,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteCategoryResponse>;
     /**
-     * 删除类目
+     * Deletes a specified category permanently.
      * @returns DeleteCategoryResponse
      */
     deleteCategory(CategoryId: string, WorkspaceId: string): Promise<$_model.DeleteCategoryResponse>;
@@ -343,7 +343,7 @@ export default class Client extends OpenApi {
      */
     deleteChunk(WorkspaceId: string, request: $_model.DeleteChunkRequest): Promise<$_model.DeleteChunkResponse>;
     /**
-     * 删除文档
+     * Deletes a specified unstructured document permanently. You cannot use the API to delete structured documents, see the Usage notes section of this topic.
      *
      * @param headers - map
      * @param runtime - runtime options for this request RuntimeOptions
@@ -353,7 +353,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteFileResponse>;
     /**
-     * 删除文档
+     * Deletes a specified unstructured document permanently. You cannot use the API to delete structured documents, see the Usage notes section of this topic.
      * @returns DeleteFileResponse
      */
     deleteFile(FileId: string, WorkspaceId: string): Promise<$_model.DeleteFileResponse>;
@@ -390,7 +390,7 @@ export default class Client extends OpenApi {
      */
     deleteIndex(WorkspaceId: string, request: $_model.DeleteIndexRequest): Promise<$_model.DeleteIndexResponse>;
     /**
-     * Deletes one or more documents from a specified unstructured knowledge base permanently.
+     * Deletes one or more documents from a specified unstructured knowledge base permanently. You cannot use the API to delete structured documents, see the Usage notes section of this topic.
      *
      * @remarks
      *   Before you call this operation, make sure that your knowledge base is created and is not deleted. That is, the primary key ID of the knowledge base `IndexId` is valid.
@@ -408,7 +408,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteIndexDocumentResponse>;
     /**
-     * Deletes one or more documents from a specified unstructured knowledge base permanently.
+     * Deletes one or more documents from a specified unstructured knowledge base permanently. You cannot use the API to delete structured documents, see the Usage notes section of this topic.
      *
      * @remarks
      *   Before you call this operation, make sure that your knowledge base is created and is not deleted. That is, the primary key ID of the knowledge base `IndexId` is valid.
@@ -467,7 +467,7 @@ export default class Client extends OpenApi {
      */
     deletePromptTemplate(workspaceId: string, promptTemplateId: string): Promise<$_model.DeletePromptTemplateResponse>;
     /**
-     * Queries the details of an unstructured document.
+     * Obtains the basic information of a document, including the document name, type, and status.
      *
      * @remarks
      * Before you call this API, make sure that your document is uploaded to the [Data Management](https://bailian.console.aliyun.com/knowledge-base#/data-center) page of Alibaba Cloud Model Studio.
@@ -483,7 +483,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeFileResponse>;
     /**
-     * Queries the details of an unstructured document.
+     * Obtains the basic information of a document, including the document name, type, and status.
      *
      * @remarks
      * Before you call this API, make sure that your document is uploaded to the [Data Management](https://bailian.console.aliyun.com/knowledge-base#/data-center) page of Alibaba Cloud Model Studio.
@@ -576,7 +576,7 @@ export default class Client extends OpenApi {
      */
     getIndexJobStatus(WorkspaceId: string, request: $_model.GetIndexJobStatusRequest): Promise<$_model.GetIndexJobStatusResponse>;
     /**
-     * 获取索引监控情况
+     * \\<props="intl">Currently, this API is not supported.\\
      *
      * @param request - GetIndexMonitorRequest
      * @param headers - map
@@ -587,7 +587,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.GetIndexMonitorResponse>;
     /**
-     * 获取索引监控情况
+     * \\<props="intl">Currently, this API is not supported.\\
      *
      * @param request - GetIndexMonitorRequest
      * @returns GetIndexMonitorResponse
@@ -690,7 +690,7 @@ export default class Client extends OpenApi {
      */
     highCodeDeploy(workspaceId: string, request: $_model.HighCodeDeployRequest): Promise<$_model.HighCodeDeployResponse>;
     /**
-     * ListCategory
+     * Lists the details about the next or multiple categories in a specified workspace.
      *
      * @param request - ListCategoryRequest
      * @param headers - map
@@ -701,7 +701,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ListCategoryResponse>;
     /**
-     * ListCategory
+     * Lists the details about the next or multiple categories in a specified workspace.
      *
      * @param request - ListCategoryRequest
      * @returns ListCategoryResponse
@@ -808,7 +808,7 @@ export default class Client extends OpenApi {
      */
     listIndexFileDetails(WorkspaceId: string, request: $_model.ListIndexFileDetailsRequest): Promise<$_model.ListIndexFileDetailsResponse>;
     /**
-     * Lists knowledge bases in a specified workspace.
+     * Lists the details about the next or multiple knowledge bases in a specified workspace.
      *
      * @remarks
      * This interface is idempotent.
@@ -822,7 +822,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ListIndicesResponse>;
     /**
-     * Lists knowledge bases in a specified workspace.
+     * Lists the details about the next or multiple knowledge bases in a specified workspace.
      *
      * @remarks
      * This interface is idempotent.
@@ -932,7 +932,7 @@ export default class Client extends OpenApi {
      */
     retrieve(WorkspaceId: string, request: $_model.RetrieveRequest): Promise<$_model.RetrieveResponse>;
     /**
-     * Adds parsed documents to an unstructured knowledge base.
+     * Adds parsed documents to an unstructured knowledge base. You cannot use the API to add knowledge to structured knowledge bases, see the Usage notes section of this topic.
      *
      * @remarks
      *   You must first upload documents to [Data Management](https://bailian.console.aliyun.com/#/data-center) and obtain the `FileId`. The documents are the knowledge source of the knowledge base. For more information, see [Import Data](https://www.alibabacloud.com/help/en/model-studio/user-guide/data-import-instructions).
@@ -949,7 +949,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.SubmitIndexAddDocumentsJobResponse>;
     /**
-     * Adds parsed documents to an unstructured knowledge base.
+     * Adds parsed documents to an unstructured knowledge base. You cannot use the API to add knowledge to structured knowledge bases, see the Usage notes section of this topic.
      *
      * @remarks
      *   You must first upload documents to [Data Management](https://bailian.console.aliyun.com/#/data-center) and obtain the `FileId`. The documents are the knowledge source of the knowledge base. For more information, see [Import Data](https://www.alibabacloud.com/help/en/model-studio/user-guide/data-import-instructions).
@@ -1066,7 +1066,7 @@ export default class Client extends OpenApi {
      */
     updateChunk(WorkspaceId: string, request: $_model.UpdateChunkRequest): Promise<$_model.UpdateChunkResponse>;
     /**
-     * 更新文档Tag
+     * Updates the tags of a specified document.
      *
      * @param tmpReq - UpdateFileTagRequest
      * @param headers - map
@@ -1077,14 +1077,14 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateFileTagResponse>;
     /**
-     * 更新文档Tag
+     * Updates the tags of a specified document.
      *
      * @param request - UpdateFileTagRequest
      * @returns UpdateFileTagResponse
      */
     updateFileTag(WorkspaceId: string, FileId: string, request: $_model.UpdateFileTagRequest): Promise<$_model.UpdateFileTagResponse>;
     /**
-     * 更新索引任务
+     * \\<props="intl">Currently, this API is not supported.\\
      *
      * @param request - UpdateIndexRequest
      * @param headers - map
@@ -1095,7 +1095,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateIndexResponse>;
     /**
-     * 更新索引任务
+     * \\<props="intl">Currently, this API is not supported.\\
      *
      * @param request - UpdateIndexRequest
      * @returns UpdateIndexResponse

package/dist/client.js

@@ -268,7 +268,7 @@ class Client extends openapi_core_1.default {
         return await this.addFilesFromAuthorizedOssWithOptions(WorkspaceId, request, headers, runtime);
     }
     /**
-     * Applies for a document upload lease to upload a document.
+     * Applies for a document upload lease to upload a document. You cannot use the API to upload structured documents. Use the console instead.
      *
      * @remarks
      *   This operation returns an HTTP URL that can be used to upload an unstructured document (the lease) and parameters required for the upload. Structured documents are not supported.
@@ -317,7 +317,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ApplyFileUploadLeaseResponse({}));
     }
     /**
-     * Applies for a document upload lease to upload a document.
+     * Applies for a document upload lease to upload a document. You cannot use the API to upload structured documents. Use the console instead.
      *
      * @remarks
      *   This operation returns an HTTP URL that can be used to upload an unstructured document (the lease) and parameters required for the upload. Structured documents are not supported.
@@ -603,9 +603,15 @@ class Client extends openapi_core_1.default {
         if (!$dara.isNull(request.tableIdsShrink)) {
             query["TableIds"] = request.tableIdsShrink;
         }
+        if (!$dara.isNull(request.channelType)) {
+            query["channelType"] = request.channelType;
+        }
         if (!$dara.isNull(request.chunkMode)) {
             query["chunkMode"] = request.chunkMode;
         }
+        if (!$dara.isNull(request.connectId)) {
+            query["connectId"] = request.connectId;
+        }
         if (!$dara.isNull(request.database)) {
             query["database"] = request.database;
         }
@@ -615,6 +621,9 @@ class Client extends openapi_core_1.default {
         if (!$dara.isNull(request.enableHeaders)) {
             query["enableHeaders"] = request.enableHeaders;
         }
+        if (!$dara.isNull(request.knowledgeScene)) {
+            query["knowledgeScene"] = request.knowledgeScene;
+        }
         if (!$dara.isNull(request.metaExtractColumnsShrink)) {
             query["metaExtractColumns"] = request.metaExtractColumnsShrink;
         }
@@ -831,7 +840,7 @@ class Client extends openapi_core_1.default {
         return await this.deleteAgentWithOptions(workspaceId, appCode, headers, runtime);
     }
     /**
-     * 删除类目
+     * Deletes a specified category permanently.
      *
      * @param headers - map
      * @param runtime - runtime options for this request RuntimeOptions
@@ -855,7 +864,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteCategoryResponse({}));
     }
     /**
-     * 删除类目
+     * Deletes a specified category permanently.
      * @returns DeleteCategoryResponse
      */
     async deleteCategory(CategoryId, WorkspaceId) {
@@ -936,7 +945,7 @@ class Client extends openapi_core_1.default {
         return await this.deleteChunkWithOptions(WorkspaceId, request, headers, runtime);
     }
     /**
-     * 删除文档
+     * Deletes a specified unstructured document permanently. You cannot use the API to delete structured documents, see the Usage notes section of this topic.
      *
      * @param headers - map
      * @param runtime - runtime options for this request RuntimeOptions
@@ -960,7 +969,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteFileResponse({}));
     }
     /**
-     * 删除文档
+     * Deletes a specified unstructured document permanently. You cannot use the API to delete structured documents, see the Usage notes section of this topic.
      * @returns DeleteFileResponse
      */
     async deleteFile(FileId, WorkspaceId) {
@@ -1025,7 +1034,7 @@ class Client extends openapi_core_1.default {
         return await this.deleteIndexWithOptions(WorkspaceId, request, headers, runtime);
     }
     /**
-     * Deletes one or more documents from a specified unstructured knowledge base permanently.
+     * Deletes one or more documents from a specified unstructured knowledge base permanently. You cannot use the API to delete structured documents, see the Usage notes section of this topic.
      *
      * @remarks
      *   Before you call this operation, make sure that your knowledge base is created and is not deleted. That is, the primary key ID of the knowledge base `IndexId` is valid.
@@ -1071,7 +1080,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteIndexDocumentResponse({}));
     }
     /**
-     * Deletes one or more documents from a specified unstructured knowledge base permanently.
+     * Deletes one or more documents from a specified unstructured knowledge base permanently. You cannot use the API to delete structured documents, see the Usage notes section of this topic.
      *
      * @remarks
      *   Before you call this operation, make sure that your knowledge base is created and is not deleted. That is, the primary key ID of the knowledge base `IndexId` is valid.
@@ -1188,7 +1197,7 @@ class Client extends openapi_core_1.default {
         return await this.deletePromptTemplateWithOptions(workspaceId, promptTemplateId, headers, runtime);
     }
     /**
-     * Queries the details of an unstructured document.
+     * Obtains the basic information of a document, including the document name, type, and status.
      *
      * @remarks
      * Before you call this API, make sure that your document is uploaded to the [Data Management](https://bailian.console.aliyun.com/knowledge-base#/data-center) page of Alibaba Cloud Model Studio.
@@ -1218,7 +1227,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeFileResponse({}));
     }
     /**
-     * Queries the details of an unstructured document.
+     * Obtains the basic information of a document, including the document name, type, and status.
      *
      * @remarks
      * Before you call this API, make sure that your document is uploaded to the [Data Management](https://bailian.console.aliyun.com/knowledge-base#/data-center) page of Alibaba Cloud Model Studio.
@@ -1426,7 +1435,7 @@ class Client extends openapi_core_1.default {
         return await this.getIndexJobStatusWithOptions(WorkspaceId, request, headers, runtime);
     }
     /**
-     * 获取索引监控情况
+     * \\<props="intl">Currently, this API is not supported.\\
      *
      * @param request - GetIndexMonitorRequest
      * @param headers - map
@@ -1463,7 +1472,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetIndexMonitorResponse({}));
     }
     /**
-     * 获取索引监控情况
+     * \\<props="intl">Currently, this API is not supported.\\
      *
      * @param request - GetIndexMonitorRequest
      * @returns GetIndexMonitorResponse
@@ -1705,7 +1714,7 @@ class Client extends openapi_core_1.default {
         return await this.highCodeDeployWithOptions(workspaceId, request, headers, runtime);
     }
     /**
-     * ListCategory
+     * Lists the details about the next or multiple categories in a specified workspace.
      *
      * @param request - ListCategoryRequest
      * @param headers - map
@@ -1748,7 +1757,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListCategoryResponse({}));
     }
     /**
-     * ListCategory
+     * Lists the details about the next or multiple categories in a specified workspace.
      *
      * @param request - ListCategoryRequest
      * @returns ListCategoryResponse
@@ -2009,7 +2018,7 @@ class Client extends openapi_core_1.default {
         return await this.listIndexFileDetailsWithOptions(WorkspaceId, request, headers, runtime);
     }
     /**
-     * Lists knowledge bases in a specified workspace.
+     * Lists the details about the next or multiple knowledge bases in a specified workspace.
      *
      * @remarks
      * This interface is idempotent.
@@ -2049,7 +2058,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListIndicesResponse({}));
     }
     /**
-     * Lists knowledge bases in a specified workspace.
+     * Lists the details about the next or multiple knowledge bases in a specified workspace.
      *
      * @remarks
      * This interface is idempotent.
@@ -2357,7 +2366,7 @@ class Client extends openapi_core_1.default {
         return await this.retrieveWithOptions(WorkspaceId, request, headers, runtime);
     }
     /**
-     * Adds parsed documents to an unstructured knowledge base.
+     * Adds parsed documents to an unstructured knowledge base. You cannot use the API to add knowledge to structured knowledge bases, see the Usage notes section of this topic.
      *
      * @remarks
      *   You must first upload documents to [Data Management](https://bailian.console.aliyun.com/#/data-center) and obtain the `FileId`. The documents are the knowledge source of the knowledge base. For more information, see [Import Data](https://www.alibabacloud.com/help/en/model-studio/user-guide/data-import-instructions).
@@ -2426,7 +2435,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.SubmitIndexAddDocumentsJobResponse({}));
     }
     /**
-     * Adds parsed documents to an unstructured knowledge base.
+     * Adds parsed documents to an unstructured knowledge base. You cannot use the API to add knowledge to structured knowledge bases, see the Usage notes section of this topic.
      *
      * @remarks
      *   You must first upload documents to [Data Management](https://bailian.console.aliyun.com/#/data-center) and obtain the `FileId`. The documents are the knowledge source of the knowledge base. For more information, see [Import Data](https://www.alibabacloud.com/help/en/model-studio/user-guide/data-import-instructions).
@@ -2698,7 +2707,7 @@ class Client extends openapi_core_1.default {
         return await this.updateChunkWithOptions(WorkspaceId, request, headers, runtime);
     }
     /**
-     * 更新文档Tag
+     * Updates the tags of a specified document.
      *
      * @param tmpReq - UpdateFileTagRequest
      * @param headers - map
@@ -2734,7 +2743,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.UpdateFileTagResponse({}));
     }
     /**
-     * 更新文档Tag
+     * Updates the tags of a specified document.
      *
      * @param request - UpdateFileTagRequest
      * @returns UpdateFileTagResponse
@@ -2745,7 +2754,7 @@ class Client extends openapi_core_1.default {
         return await this.updateFileTagWithOptions(WorkspaceId, FileId, request, headers, runtime);
     }
     /**
-     * 更新索引任务
+     * \\<props="intl">Currently, this API is not supported.\\
      *
      * @param request - UpdateIndexRequest
      * @param headers - map
@@ -2797,7 +2806,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.UpdateIndexResponse({}));
     }
     /**
-     * 更新索引任务
+     * \\<props="intl">Currently, this API is not supported.\\
      *
      * @param request - UpdateIndexRequest
      * @returns UpdateIndexResponse