@alicloud/bailian20231229 2.5.0 → 2.6.0

package/src/models/DeleteChunkResponseBody.ts

@@ -4,34 +4,52 @@ import * as $dara from '@darabonba/typescript';
 
 export class DeleteChunkResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The status code.
+   * 
    * @example
    * InvalidParameter
    */
   code?: string;
   /**
+   * @remarks
+   * The data returned if the request is successful.
+   * 
    * @example
    * true
    */
   data?: boolean;
   /**
+   * @remarks
+   * The error message.
+   * 
    * @example
    * Required parameter(%s) missing or invalid, please check the request parameters.
    */
   message?: string;
   /**
    * @remarks
-   * Id of the request
+   * The request ID.
    * 
    * @example
    * 35A267BF-xxxx-54DB-8394-AA3B0742D833
    */
   requestId?: string;
   /**
+   * @remarks
+   * The HTTP status code returned.
+   * 
    * @example
    * 200
    */
   status?: string;
   /**
+   * @remarks
+   * Indications whether the API call is successful. Valid values:
+   * 
+   * *   true
+   * *   false
+   * 
    * @example
    * true
    */

package/src/models/DeleteChunkShrinkRequest.ts

@@ -5,11 +5,15 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteChunkShrinkRequest extends $dara.Model {
   /**
    * @remarks
+   * The list of text chunks to be deleted. You can specify up to 10 chunk IDs at a time.
+   * 
    * This parameter is required.
    */
   chunkIdsShrink?: string;
   /**
    * @remarks
+   * The knowledge base ID, which is the `Data.Id` parameter returned by **CreateIndex**.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/GetAvailableParserTypesRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class GetAvailableParserTypesRequest extends $dara.Model {
   /**
    * @remarks
+   * The file type. Valid values: pdf, docx, and doc.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/GetAvailableParserTypesResponseBody.ts

@@ -3,8 +3,20 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class GetAvailableParserTypesResponseBodyDataParserList extends $dara.Model {
+  /**
+   * @remarks
+   * The display name of the parsing method.
+   */
   displayName?: string;
   /**
+   * @remarks
+   * The parser code. Valid values:
+   * 
+   * *   DOCMIND (Intelligent parsing)
+   * *   DOCMIND_DIGITAL (Digital parsing)
+   * *   DOCMIND_LLM_VERSION (LLM parsing)
+   * *   DASH_QWEN_VL_PARSER (Qwen VL parsing)
+   * 
    * @example
    * DOCMIND
    */
@@ -34,10 +46,17 @@ export class GetAvailableParserTypesResponseBodyDataParserList extends $dara.Mod
 
 export class GetAvailableParserTypesResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The file type, which is the same as the FileType in the input parameter.
+   * 
    * @example
    * pdf
    */
   fileType?: string;
+  /**
+   * @remarks
+   * The list of supported parsers
+   */
   parserList?: GetAvailableParserTypesResponseBodyDataParserList[];
   static names(): { [key: string]: string } {
     return {
@@ -67,27 +86,49 @@ export class GetAvailableParserTypesResponseBodyData extends $dara.Model {
 
 export class GetAvailableParserTypesResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The error code returned.
+   * 
    * @example
    * DataCenter.Throttling
    */
   code?: string;
+  /**
+   * @remarks
+   * The data returned.
+   */
   data?: GetAvailableParserTypesResponseBodyData;
   /**
+   * @remarks
+   * The error message that is returned if the request failed.
+   * 
    * @example
    * User not authorized to operate on the specified resource
    */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 17204B98-7734-4F9A-8464-2446XXXXXXX
    */
   requestId?: string;
   /**
+   * @remarks
+   * The HTTP status code returned.
+   * 
    * @example
    * 200
    */
   status?: string;
   /**
+   * @remarks
+   * Indicates whether the call is successful. Valid values:
+   * 
+   * *   true
+   * *   false
+   * 
    * @example
    * true
    */

package/src/models/GetParseSettingsRequest.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetParseSettingsRequest extends $dara.Model {
   /**
+   * @remarks
+   * The category ID, which is the `CategoryId` returned by **AddCategory**. To view the category ID, click the ID icon next to the category name on the Unstructured Data tab of the [Application Data](https://bailian.console.alibabacloud.com/?tab=app#/data-center) page.
+   * 
    * @example
    * cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx
    */

package/src/models/GetParseSettingsResponseBody.ts

@@ -4,11 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetParseSettingsResponseBodyDataParserConfig extends $dara.Model {
   /**
+   * @remarks
+   * The model name.
+   * 
    * @example
    * - qwen-vl-max
    * - qwen-vl-plus
    */
   modelName?: string;
+  /**
+   * @remarks
+   * The prompt used for parsing.
+   * 
+   * @example
+   * # Role  
+   * You are a professional image content annotator, skilled in identifying and describing the contents of images.  
+   * 
+   * # Task Objective  
+   * Based on the input image, provide a detailed description of its contents.
+   */
   modelPrompt?: string;
   static names(): { [key: string]: string } {
     return {
@@ -35,16 +49,38 @@ export class GetParseSettingsResponseBodyDataParserConfig extends $dara.Model {
 
 export class GetParseSettingsResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The file type. Valid values are: pdf, docx, doc, etc. All supported file types in the category are listed here.
+   * 
    * @example
    * pdf
    */
   fileType?: string;
   /**
+   * @remarks
+   * The parser used for files of the current type. Valid values:
+   * 
+   * *   DOCMIND (Intelligent parsing)
+   * *   DOCMIND_DIGITAL (Digital parsing)
+   * *   DOCMIND_LLM_VERSION (LLM parsing)
+   * *   DASH_QWEN_VL_PARSER (Qwen VL parsing)
+   * 
    * @example
    * DOCMIND
    */
   parser?: string;
+  /**
+   * @remarks
+   * The parser configuration. Currently, this is available only for Qwen VL parsing.
+   */
   parserConfig?: GetParseSettingsResponseBodyDataParserConfig;
+  /**
+   * @remarks
+   * The display name of the parsing method.
+   * 
+   * @example
+   * Digital parsing
+   */
   parserDisplayName?: string;
   static names(): { [key: string]: string } {
     return {
@@ -78,27 +114,49 @@ export class GetParseSettingsResponseBodyData extends $dara.Model {
 
 export class GetParseSettingsResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The status code.
+   * 
    * @example
    * success
    */
   code?: string;
+  /**
+   * @remarks
+   * The returned data fields.
+   */
   data?: GetParseSettingsResponseBodyData[];
   /**
+   * @remarks
+   * The error message.
+   * 
    * @example
    * workspace id is null or invalid.
    */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 35A267BF-xxxx-54DB-8394-AA3B0742D833
    */
   requestId?: string;
   /**
+   * @remarks
+   * The HTTP status code returned.
+   * 
    * @example
    * 200
    */
   status?: string;
   /**
+   * @remarks
+   * Indicates whether the call is successful. Valid values:
+   * 
+   * *   true
+   * *   false
+   * 
    * @example
    * True
    */

package/src/models/ListFileRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class ListFileRequest extends $dara.Model {
   /**
    * @remarks
+   * The category ID, which is the `CategoryId` returned by the [AddCategory](~~AddCategory~~) operation. To view the category ID, click the ID icon next to the category name on the Unstructured Data tab of the [Data Management](https://bailian.console.alibabacloud.com/#/data-center) page.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ListFileResponseBody.ts

@@ -14,6 +14,9 @@ export class ListFileResponseBodyDataFileList extends $dara.Model {
    */
   createTime?: string;
   /**
+   * @remarks
+   * The document ID, which is the `FileId` parameter returned by the [AddFile](~~AddFile~~) operation. To view the ID, click the icon next to the file name on the [Data Management](https://bailian.console.alibabacloud.com/#/data-center) page.
+   * 
    * @example
    * file_5ff599b3455a45db8c41b0054b361518_10098576
    */
@@ -85,6 +88,10 @@ export class ListFileResponseBodyDataFileList extends $dara.Model {
 }
 
 export class ListFileResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The list of documents in the category.
+   */
   fileList?: ListFileResponseBodyDataFileList[];
   /**
    * @example
@@ -144,6 +151,10 @@ export class ListFileResponseBody extends $dara.Model {
    * success
    */
   code?: string;
+  /**
+   * @remarks
+   * The returned data.
+   */
   data?: ListFileResponseBodyData;
   /**
    * @example

package/src/models/ListIndexFileDetailsResponseBody.ts

@@ -3,19 +3,71 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ListIndexFileDetailsResponseBodyDataDocuments extends $dara.Model {
+  /**
+   * @example
+   * DashSplitter
+   */
   chunkMode?: string;
+  /**
+   * @example
+   * 600
+   */
   chunkSize?: string;
+  /**
+   * @example
+   * 110002
+   */
   code?: string;
+  /**
+   * @example
+   * pdf
+   */
   documentType?: string;
+  /**
+   * @example
+   * true
+   */
   enableHeaders?: string;
+  /**
+   * @example
+   * 1744856423000
+   */
   gmtModified?: number;
+  /**
+   * @example
+   * doc_c134aa2073204a5d936d870bf960f56axxxxxxxx
+   */
   id?: string;
+  /**
+   * @example
+   * check fileUrlKey[file_path] / fileNameKey[null] / fileExtensionKey[file_extension] is invalid
+   */
   message?: string;
   name?: string;
+  /**
+   * @example
+   * 100
+   */
   overlapSize?: string;
+  /**
+   * @example
+   * 996764
+   */
   size?: number;
+  /**
+   * @example
+   * cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx
+   */
   sourceId?: string;
+  /**
+   * @example
+   * RUNNING
+   */
   status?: string;
+  /**
+   * @example
+   * " "
+   */
   separator?: string;
   static names(): { [key: string]: string } {
     return {
@@ -66,9 +118,25 @@ export class ListIndexFileDetailsResponseBodyDataDocuments extends $dara.Model {
 
 export class ListIndexFileDetailsResponseBodyData extends $dara.Model {
   documents?: ListIndexFileDetailsResponseBodyDataDocuments[];
+  /**
+   * @example
+   * 79c0alxxxx
+   */
   indexId?: string;
+  /**
+   * @example
+   * 1
+   */
   pageNumber?: number;
+  /**
+   * @example
+   * 10
+   */
   pageSize?: number;
+  /**
+   * @example
+   * 100
+   */
   totalCount?: number;
   static names(): { [key: string]: string } {
     return {
@@ -122,6 +190,10 @@ export class ListIndexFileDetailsResponseBody extends $dara.Model {
    * 35A267BF-xxxx-54DB-8394-AA3B0742D833
    */
   requestId?: string;
+  /**
+   * @example
+   * RUNNING
+   */
   status?: string;
   /**
    * @example

package/src/models/UpdateChunkRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateChunkRequest extends $dara.Model {
   /**
    * @remarks
+   * The ID of the text chunk to be modified. You can find it in the Node.Metadata._id field returned by **ListChunks**.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class UpdateChunkRequest extends $dara.Model {
   chunkId?: string;
   /**
    * @remarks
+   * The file ID, which is the `FileId` returned by **AddFile**. You can also go to the [Application Data](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center) page. Click the ID icon next to your file to get its ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,6 +25,13 @@ export class UpdateChunkRequest extends $dara.Model {
   dataId?: string;
   /**
    * @remarks
+   * Specifies whether this text chunk participates in knowledge base retrieval. Valid values:
+   * 
+   * *   true
+   * *   false
+   * 
+   * Default value: true.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -29,6 +40,8 @@ export class UpdateChunkRequest extends $dara.Model {
   isDisplayedChunkContent?: boolean;
   /**
    * @remarks
+   * The knowledge base ID, which is the `Data.Id` returned by **CreateIndex**. You can also get it on the [Knowledge Base](https://modelstudio.console.alibabacloud.com/?tab=app#/knowledge-base) page.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -37,9 +50,15 @@ export class UpdateChunkRequest extends $dara.Model {
   pipelineId?: string;
   /**
    * @remarks
+   * The new content of the chunk. The content must be between 10 and 6,000 characters in length and cannot exceed the maximum chunk length set when the knowledge base was created.
+   * 
    * This parameter is required.
    */
   content?: string;
+  /**
+   * @remarks
+   * The new title of the chunk. The title must be 0 to 50 characters in length and can be an empty string. If you specify an empty string, the existing title is cleared. If you do not pass this parameter, the original title remains unchanged.
+   */
   title?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/UpdateChunkResponseBody.ts

@@ -4,34 +4,52 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateChunkResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The status code.
+   * 
    * @example
    * InvalidParameter
    */
   code?: string;
   /**
+   * @remarks
+   * The data returned if the request is successful.
+   * 
    * @example
    * true
    */
   data?: boolean;
   /**
+   * @remarks
+   * The error message.
+   * 
    * @example
    * Required parameter(%s) missing or invalid, please check the request parameters.
    */
   message?: string;
   /**
    * @remarks
-   * Id of the request
+   * The request ID.
    * 
    * @example
    * 35A267BF-xxxx-54DB-8394-AA3B0742D833
    */
   requestId?: string;
   /**
+   * @remarks
+   * The HTTP status code returned.
+   * 
    * @example
    * 200
    */
   status?: string;
   /**
+   * @remarks
+   * Indications whether the API call is successful. Valid values:
+   * 
+   * *   true
+   * *   false
+   * 
    * @example
    * true
    */

package/src/models/model.ts

@@ -5,6 +5,8 @@ export { AddFilesFromAuthorizedOssResponseBodyDataAddFileResultList } from './Ad
 export { AddFilesFromAuthorizedOssResponseBodyData } from './AddFilesFromAuthorizedOssResponseBody';
 export { ApplyFileUploadLeaseResponseBodyDataParam } from './ApplyFileUploadLeaseResponseBody';
 export { ApplyFileUploadLeaseResponseBodyData } from './ApplyFileUploadLeaseResponseBody';
+export { ApplyTempStorageLeaseResponseBodyDataParam } from './ApplyTempStorageLeaseResponseBody';
+export { ApplyTempStorageLeaseResponseBodyData } from './ApplyTempStorageLeaseResponseBody';
 export { ChangeParseSettingRequestParserConfig } from './ChangeParseSettingRequest';
 export { ChangeParseSettingResponseBodyData } from './ChangeParseSettingResponseBody';
 export { CreateAndPulishAgentRequestApplicationConfigHistoryConfig } from './CreateAndPulishAgentRequest';
@@ -106,6 +108,9 @@ export { AddFilesFromAuthorizedOssResponse } from './AddFilesFromAuthorizedOssRe
 export { ApplyFileUploadLeaseRequest } from './ApplyFileUploadLeaseRequest';
 export { ApplyFileUploadLeaseResponseBody } from './ApplyFileUploadLeaseResponseBody';
 export { ApplyFileUploadLeaseResponse } from './ApplyFileUploadLeaseResponse';
+export { ApplyTempStorageLeaseRequest } from './ApplyTempStorageLeaseRequest';
+export { ApplyTempStorageLeaseResponseBody } from './ApplyTempStorageLeaseResponseBody';
+export { ApplyTempStorageLeaseResponse } from './ApplyTempStorageLeaseResponse';
 export { ChangeParseSettingRequest } from './ChangeParseSettingRequest';
 export { ChangeParseSettingShrinkRequest } from './ChangeParseSettingShrinkRequest';
 export { ChangeParseSettingResponseBody } from './ChangeParseSettingResponseBody';