@alicloud/bailian20231229 2.8.0 → 2.8.2

package/src/client.ts

@@ -261,7 +261,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 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.
@@ -316,7 +316,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 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.
@@ -649,10 +649,18 @@ export default class Client extends OpenApi {
       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;
     }
@@ -665,6 +673,10 @@ export default class Client extends OpenApi {
       query["enableHeaders"] = request.enableHeaders;
     }
 
+    if (!$dara.isNull(request.knowledgeScene)) {
+      query["knowledgeScene"] = request.knowledgeScene;
+    }
+
     if (!$dara.isNull(request.metaExtractColumnsShrink)) {
       query["metaExtractColumns"] = request.metaExtractColumnsShrink;
     }
@@ -900,7 +912,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 删除类目
+   * Deletes a specified category permanently.
    * 
    * @param headers - map
    * @param runtime - runtime options for this request RuntimeOptions
@@ -925,7 +937,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 删除类目
+   * Deletes a specified category permanently.
    * @returns DeleteCategoryResponse
    */
   async deleteCategory(CategoryId: string, WorkspaceId: string): Promise<$_model.DeleteCategoryResponse> {
@@ -1012,7 +1024,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 删除文档
+   * 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
@@ -1037,7 +1049,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 删除文档
+   * 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: string, WorkspaceId: string): Promise<$_model.DeleteFileResponse> {
@@ -1106,7 +1118,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 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.
@@ -1156,7 +1168,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 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.
@@ -1280,7 +1292,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 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.
@@ -1311,7 +1323,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 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.
@@ -1537,7 +1549,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 获取索引监控情况
+   * \\<props="intl">Currently, this API is not supported.\\
    * 
    * @param request - GetIndexMonitorRequest
    * @param headers - map
@@ -1578,7 +1590,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 获取索引监控情况
+   * \\<props="intl">Currently, this API is not supported.\\
    * 
    * @param request - GetIndexMonitorRequest
    * @returns GetIndexMonitorResponse
@@ -1840,7 +1852,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * ListCategory
+   * Lists the details about the next or multiple categories in a specified workspace.
    * 
    * @param request - ListCategoryRequest
    * @param headers - map
@@ -1889,7 +1901,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * ListCategory
+   * Lists the details about the next or multiple categories in a specified workspace.
    * 
    * @param request - ListCategoryRequest
    * @returns ListCategoryResponse
@@ -2181,7 +2193,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 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.
@@ -2225,7 +2237,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 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.
@@ -2573,7 +2585,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 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).
@@ -2654,7 +2666,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 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).
@@ -2956,7 +2968,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 更新文档Tag
+   * Updates the tags of a specified document.
    * 
    * @param tmpReq - UpdateFileTagRequest
    * @param headers - map
@@ -2995,7 +3007,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 更新文档Tag
+   * Updates the tags of a specified document.
    * 
    * @param request - UpdateFileTagRequest
    * @returns UpdateFileTagResponse
@@ -3007,7 +3019,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 更新索引任务
+   * \\<props="intl">Currently, this API is not supported.\\
    * 
    * @param request - UpdateIndexRequest
    * @param headers - map
@@ -3068,7 +3080,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * 更新索引任务
+   * \\<props="intl">Currently, this API is not supported.\\
    * 
    * @param request - UpdateIndexRequest
    * @returns UpdateIndexResponse

package/src/models/CreateIndexRequest.ts

@@ -3,10 +3,45 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class CreateIndexRequestColumns extends $dara.Model {
+  /**
+   * @remarks
+   * > This parameter is not available. Do not specify this parameter.
+   * 
+   * @example
+   * source_column_name1
+   */
   column?: string;
+  /**
+   * @remarks
+   * > This parameter is not available. Do not specify this parameter.
+   * 
+   * @example
+   * true
+   */
   isRecall?: boolean;
+  /**
+   * @remarks
+   * > This parameter is not available. Do not specify this parameter.
+   * 
+   * @example
+   * true
+   */
   isSearch?: boolean;
+  /**
+   * @remarks
+   * > This parameter is not available. Do not specify this parameter.
+   * 
+   * @example
+   * index_column_name1
+   */
   name?: string;
+  /**
+   * @remarks
+   * > This parameter is not available. Do not specify this parameter.
+   * 
+   * @example
+   * string
+   */
   type?: string;
   static names(): { [key: string]: string } {
     return {
@@ -249,6 +284,10 @@ export class CreateIndexRequest extends $dara.Model {
    * 128
    */
   chunkSize?: number;
+  /**
+   * @remarks
+   * > This parameter is not available. Do not specify this parameter.
+   */
   columns?: CreateIndexRequestColumns[];
   /**
    * @remarks
@@ -417,6 +456,11 @@ export class CreateIndexRequest extends $dara.Model {
    * > This parameter is not available. Do not specify this parameter.
    */
   tableIds?: string[];
+  /**
+   * @example
+   * connector
+   */
+  channelType?: string;
   /**
    * @remarks
    * > This parameter is not available. Do not specify this parameter.
@@ -425,6 +469,11 @@ export class CreateIndexRequest extends $dara.Model {
    * regex
    */
   chunkMode?: string;
+  /**
+   * @example
+   * conn_mysql_xxx_xxx
+   */
+  connectId?: string;
   database?: string;
   datasourceCode?: string;
   /**
@@ -444,6 +493,7 @@ export class CreateIndexRequest extends $dara.Model {
    * false
    */
   enableHeaders?: boolean;
+  knowledgeScene?: string;
   /**
    * @remarks
    * The metadata extraction configurations. Metadata refers to a set of additional attributes associated with unstructured data, which are integrated into text chunks in key-value pairs. For more information, see [Knowledge base](https://help.aliyun.com/document_detail/2807740.html).
@@ -487,10 +537,13 @@ export class CreateIndexRequest extends $dara.Model {
       sourceType: 'SourceType',
       structureType: 'StructureType',
       tableIds: 'TableIds',
+      channelType: 'channelType',
       chunkMode: 'chunkMode',
+      connectId: 'connectId',
       database: 'database',
       datasourceCode: 'datasourceCode',
       enableHeaders: 'enableHeaders',
+      knowledgeScene: 'knowledgeScene',
       metaExtractColumns: 'metaExtractColumns',
       pipelineCommercialCu: 'pipelineCommercialCu',
       pipelineCommercialType: 'pipelineCommercialType',
@@ -521,10 +574,13 @@ export class CreateIndexRequest extends $dara.Model {
       sourceType: 'string',
       structureType: 'string',
       tableIds: { 'type': 'array', 'itemType': 'string' },
+      channelType: 'string',
       chunkMode: 'string',
+      connectId: 'string',
       database: 'string',
       datasourceCode: 'string',
       enableHeaders: 'boolean',
+      knowledgeScene: 'string',
       metaExtractColumns: { 'type': 'array', 'itemType': CreateIndexRequestMetaExtractColumns },
       pipelineCommercialCu: 'number',
       pipelineCommercialType: 'string',

package/src/models/CreateIndexShrinkRequest.ts

@@ -20,6 +20,10 @@ export class CreateIndexShrinkRequest extends $dara.Model {
    * 128
    */
   chunkSize?: number;
+  /**
+   * @remarks
+   * > This parameter is not available. Do not specify this parameter.
+   */
   columnsShrink?: string;
   /**
    * @remarks
@@ -188,6 +192,11 @@ export class CreateIndexShrinkRequest extends $dara.Model {
    * > This parameter is not available. Do not specify this parameter.
    */
   tableIdsShrink?: string;
+  /**
+   * @example
+   * connector
+   */
+  channelType?: string;
   /**
    * @remarks
    * > This parameter is not available. Do not specify this parameter.
@@ -196,6 +205,11 @@ export class CreateIndexShrinkRequest extends $dara.Model {
    * regex
    */
   chunkMode?: string;
+  /**
+   * @example
+   * conn_mysql_xxx_xxx
+   */
+  connectId?: string;
   database?: string;
   datasourceCode?: string;
   /**
@@ -215,6 +229,7 @@ export class CreateIndexShrinkRequest extends $dara.Model {
    * false
    */
   enableHeaders?: boolean;
+  knowledgeScene?: string;
   /**
    * @remarks
    * The metadata extraction configurations. Metadata refers to a set of additional attributes associated with unstructured data, which are integrated into text chunks in key-value pairs. For more information, see [Knowledge base](https://help.aliyun.com/document_detail/2807740.html).
@@ -258,10 +273,13 @@ export class CreateIndexShrinkRequest extends $dara.Model {
       sourceType: 'SourceType',
       structureType: 'StructureType',
       tableIdsShrink: 'TableIds',
+      channelType: 'channelType',
       chunkMode: 'chunkMode',
+      connectId: 'connectId',
       database: 'database',
       datasourceCode: 'datasourceCode',
       enableHeaders: 'enableHeaders',
+      knowledgeScene: 'knowledgeScene',
       metaExtractColumnsShrink: 'metaExtractColumns',
       pipelineCommercialCu: 'pipelineCommercialCu',
       pipelineCommercialType: 'pipelineCommercialType',
@@ -292,10 +310,13 @@ export class CreateIndexShrinkRequest extends $dara.Model {
       sourceType: 'string',
       structureType: 'string',
       tableIdsShrink: 'string',
+      channelType: 'string',
       chunkMode: 'string',
+      connectId: 'string',
       database: 'string',
       datasourceCode: 'string',
       enableHeaders: 'boolean',
+      knowledgeScene: 'string',
       metaExtractColumnsShrink: 'string',
       pipelineCommercialCu: 'number',
       pipelineCommercialType: 'string',

package/src/models/HighCodeDeployResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class HighCodeDeployResponseBody extends $dara.Model {
   /**
    * @example
-   * {\"key\": \"value\"}
+   * {\\"key\\": \\"value\\"}
    */
   data?: string;
   /**