@alicloud/bailian20231229 1.4.0 → 1.4.1

package/dist/client.d.ts

@@ -1,12 +1,32 @@
 /**
- *
  */
 import * as $Util from '@alicloud/tea-util';
 import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
 import * as $tea from '@alicloud/tea-typescript';
 export declare class AddFileRequest extends $tea.Model {
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * cate_cdd11b1b79a74e8bbd675c356a91ee3510024405
+     */
     categoryId?: string;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * 68abd1dea7b6404d8f7d7b9f7fbd332d.1716698936847
+     */
     leaseId?: string;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * DASHSCOPE_DOCMIND
+     */
     parser?: string;
     static names(): {
         [key: string]: string;
@@ -19,11 +39,31 @@ export declare class AddFileRequest extends $tea.Model {
     });
 }
 export declare class AddFileResponseBody extends $tea.Model {
+    /**
+     * @example
+     * DataCenter.FileTooLarge
+     */
     code?: string;
     data?: AddFileResponseBodyData;
+    /**
+     * @example
+     * User not authorized to operate on the specified resource.
+     */
     message?: string;
+    /**
+     * @example
+     * 778C0B3B-xxxx-5FC1-A947-36EDD13606AB
+     */
     requestId?: string;
+    /**
+     * @example
+     * 200
+     */
     status?: string;
+    /**
+     * @example
+     * true
+     */
     success?: string;
     static names(): {
         [key: string]: string;
@@ -52,8 +92,26 @@ export declare class AddFileResponse extends $tea.Model {
     });
 }
 export declare class ApplyFileUploadLeaseRequest extends $tea.Model {
+    /**
+     * @remarks
+     * This parameter is required.
+     */
     fileName?: string;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * 19657c391f6c70bcea63c154d8606bb3
+     */
     md5?: string;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * 1000
+     */
     sizeInBytes?: string;
     static names(): {
         [key: string]: string;
@@ -66,11 +124,31 @@ export declare class ApplyFileUploadLeaseRequest extends $tea.Model {
     });
 }
 export declare class ApplyFileUploadLeaseResponseBody extends $tea.Model {
+    /**
+     * @example
+     * DataCenter.FileTooLarge
+     */
     code?: string;
     data?: ApplyFileUploadLeaseResponseBodyData;
+    /**
+     * @example
+     * User not authorized to operate on the specified resource
+     */
     message?: string;
+    /**
+     * @example
+     * 778C0B3B-xxxx-5FC1-A947-36EDD13606AB
+     */
     requestId?: string;
+    /**
+     * @example
+     * 200
+     */
     status?: string;
+    /**
+     * @example
+     * true
+     */
     success?: boolean;
     static names(): {
         [key: string]: string;
@@ -100,20 +178,80 @@ export declare class ApplyFileUploadLeaseResponse extends $tea.Model {
 }
 export declare class CreateIndexRequest extends $tea.Model {
     categoryIds?: string[];
+    /**
+     * @example
+     * 128
+     */
     chunkSize?: number;
     columns?: CreateIndexRequestColumns[];
     description?: string;
     documentIds?: string[];
+    /**
+     * @example
+     * text-embedding-v2
+     */
     embeddingModelName?: string;
+    /**
+     * @remarks
+     * This parameter is required.
+     */
     name?: string;
+    /**
+     * @example
+     * 16
+     */
     overlapSize?: number;
+    /**
+     * @example
+     * 0.20
+     */
     rerankMinScore?: number;
+    /**
+     * @example
+     * gte-rerank-hybrid
+     */
     rerankModelName?: string;
+    /**
+     * @example
+     * ,
+     */
     separator?: string;
+    /**
+     * @example
+     * gp-bp321093j84
+     */
     sinkInstanceId?: string;
+    /**
+     * @example
+     * cn-hangzhou
+     */
     sinkRegion?: string;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * DEFAULT
+     */
     sinkType?: string;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * DATA_CENTER_FILE
+     *
+     * **if can be null:**
+     * false
+     */
     sourceType?: string;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * structured
+     */
     structureType?: string;
     static names(): {
         [key: string]: string;
@@ -127,20 +265,80 @@ export declare class CreateIndexRequest extends $tea.Model {
 }
 export declare class CreateIndexShrinkRequest extends $tea.Model {
     categoryIdsShrink?: string;
+    /**
+     * @example
+     * 128
+     */
     chunkSize?: number;
     columnsShrink?: string;
     description?: string;
     documentIdsShrink?: string;
+    /**
+     * @example
+     * text-embedding-v2
+     */
     embeddingModelName?: string;
+    /**
+     * @remarks
+     * This parameter is required.
+     */
     name?: string;
+    /**
+     * @example
+     * 16
+     */
     overlapSize?: number;
+    /**
+     * @example
+     * 0.20
+     */
     rerankMinScore?: number;
+    /**
+     * @example
+     * gte-rerank-hybrid
+     */
     rerankModelName?: string;
+    /**
+     * @example
+     * ,
+     */
     separator?: string;
+    /**
+     * @example
+     * gp-bp321093j84
+     */
     sinkInstanceId?: string;
+    /**
+     * @example
+     * cn-hangzhou
+     */
     sinkRegion?: string;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * DEFAULT
+     */
     sinkType?: string;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * DATA_CENTER_FILE
+     *
+     * **if can be null:**
+     * false
+     */
     sourceType?: string;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * structured
+     */
     structureType?: string;
     static names(): {
         [key: string]: string;
@@ -153,11 +351,34 @@ export declare class CreateIndexShrinkRequest extends $tea.Model {
     });
 }
 export declare class CreateIndexResponseBody extends $tea.Model {
+    /**
+     * @example
+     * Forbidden
+     */
     code?: string;
     data?: CreateIndexResponseBodyData;
+    /**
+     * @example
+     * Invalid input, variable name is missing
+     */
     message?: string;
+    /**
+     * @remarks
+     * Id of the request
+     *
+     * @example
+     * 17204B98-7734-4F9A-8464-2446A84821CA
+     */
     requestId?: string;
+    /**
+     * @example
+     * 200
+     */
     status?: string;
+    /**
+     * @example
+     * true
+     */
     success?: boolean;
     static names(): {
         [key: string]: string;
@@ -186,11 +407,34 @@ export declare class CreateIndexResponse extends $tea.Model {
     });
 }
 export declare class DeleteFileResponseBody extends $tea.Model {
+    /**
+     * @example
+     * InvalidParameter
+     */
     code?: string;
     data?: DeleteFileResponseBodyData;
+    /**
+     * @example
+     * Current file status does not support delete.
+     */
     message?: string;
+    /**
+     * @remarks
+     * Id of the request
+     *
+     * @example
+     * 17204B98-xxxx-4F9A-8464-2446A84821CA
+     */
     requestId?: string;
+    /**
+     * @example
+     * 200
+     */
     status?: string;
+    /**
+     * @example
+     * true
+     */
     success?: boolean;
     static names(): {
         [key: string]: string;
@@ -219,6 +463,13 @@ export declare class DeleteFileResponse extends $tea.Model {
     });
 }
 export declare class DeleteIndexRequest extends $tea.Model {
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * f89ie0fj5a
+     */
     indexId?: string;
     static names(): {
         [key: string]: string;
@@ -231,10 +482,33 @@ export declare class DeleteIndexRequest extends $tea.Model {
     });
 }
 export declare class DeleteIndexResponseBody extends $tea.Model {
+    /**
+     * @example
+     * Index.InvalidParameter
+     */
     code?: string;
+    /**
+     * @example
+     * Required parameter(%s) missing or invalid, please check the request parameters.
+     */
     message?: string;
+    /**
+     * @remarks
+     * Id of the request
+     *
+     * @example
+     * 17204B98-xxxx-4F9A-8464-2446A84821CA
+     */
     requestId?: string;
+    /**
+     * @example
+     * 200
+     */
     status?: string;
+    /**
+     * @example
+     * true
+     */
     success?: boolean;
     static names(): {
         [key: string]: string;
@@ -263,7 +537,18 @@ export declare class DeleteIndexResponse extends $tea.Model {
     });
 }
 export declare class DeleteIndexDocumentRequest extends $tea.Model {
+    /**
+     * @remarks
+     * This parameter is required.
+     */
     documentIds?: string[];
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * 79c0aly8zw
+     */
     indexId?: string;
     static names(): {
         [key: string]: string;
@@ -276,7 +561,18 @@ export declare class DeleteIndexDocumentRequest extends $tea.Model {
     });
 }
 export declare class DeleteIndexDocumentShrinkRequest extends $tea.Model {
+    /**
+     * @remarks
+     * This parameter is required.
+     */
     documentIdsShrink?: string;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * 79c0aly8zw
+     */
     indexId?: string;
     static names(): {
         [key: string]: string;
@@ -289,11 +585,34 @@ export declare class DeleteIndexDocumentShrinkRequest extends $tea.Model {
     });
 }
 export declare class DeleteIndexDocumentResponseBody extends $tea.Model {
+    /**
+     * @example
+     * Index.InvalidParameter
+     */
     code?: string;
     data?: DeleteIndexDocumentResponseBodyData;
+    /**
+     * @example
+     * Required parameter(%s) missing or invalid, please check the request parameters.
+     */
     message?: string;
+    /**
+     * @remarks
+     * Id of the request
+     *
+     * @example
+     * 17204B98-xxxx-4F9A-8464-2446A84821CA
+     */
     requestId?: string;
+    /**
+     * @example
+     * 200
+     */
     status?: string;
+    /**
+     * @example
+     * true
+     */
     success?: boolean;
     static names(): {
         [key: string]: string;
@@ -322,11 +641,31 @@ export declare class DeleteIndexDocumentResponse extends $tea.Model {
     });
 }
 export declare class DescribeFileResponseBody extends $tea.Model {
+    /**
+     * @example
+     * Success
+     */
     code?: string;
     data?: DescribeFileResponseBodyData;
+    /**
+     * @example
+     * Requests throttling triggered.
+     */
     message?: string;
+    /**
+     * @example
+     * 17204B98-xxxx-4F9A-8464-2446A84821CA
+     */
     requestId?: string;
+    /**
+     * @example
+     * 200
+     */
     status?: string;
+    /**
+     * @example
+     * true
+     */
     success?: boolean;
     static names(): {
         [key: string]: string;
@@ -355,7 +694,21 @@ export declare class DescribeFileResponse extends $tea.Model {
     });
 }
 export declare class GetIndexJobStatusRequest extends $tea.Model {
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * 79c0aly8zw
+     */
     indexId?: string;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * 20230718xxxx-146c93bf
+     */
     jobId?: string;
     static names(): {
         [key: string]: string;
@@ -368,11 +721,31 @@ export declare class GetIndexJobStatusRequest extends $tea.Model {
     });
 }
 export declare class GetIndexJobStatusResponseBody extends $tea.Model {
+    /**
+     * @example
+     * Index.Forbidden
+     */
     code?: string;
     data?: GetIndexJobStatusResponseBodyData;
+    /**
+     * @example
+     * User not authorized to operate on the specified resource.
+     */
     message?: string;
+    /**
+     * @example
+     * 17204B98-xxxx-4F9A-8464-2446A84821CA
+     */
     requestId?: string;
+    /**
+     * @example
+     * 200
+     */
     status?: string;
+    /**
+     * @example
+     * true
+     */
     success?: boolean;
     static names(): {
         [key: string]: string;
@@ -402,9 +775,28 @@ export declare class GetIndexJobStatusResponse extends $tea.Model {
 }
 export declare class ListChunksRequest extends $tea.Model {
     fields?: string[];
+    /**
+     * @example
+     * file_5f03dfea56da4050ab68d61871fc4cb3_10151493
+     */
     filed?: string;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * otoru9en4v
+     */
     indexId?: string;
+    /**
+     * @example
+     * 1
+     */
     pageNum?: number;
+    /**
+     * @example
+     * 10
+     */
     pageSize?: number;
     static names(): {
         [key: string]: string;
@@ -417,11 +809,34 @@ export declare class ListChunksRequest extends $tea.Model {
     });
 }
 export declare class ListChunksResponseBody extends $tea.Model {
+    /**
+     * @example
+     * Index.InvalidParameter
+     */
     code?: string;
     data?: ListChunksResponseBodyData;
+    /**
+     * @example
+     * Required parameter(%s) missing or invalid, please check the request parameters.
+     */
     message?: string;
+    /**
+     * @remarks
+     * Id of the request
+     *
+     * @example
+     * 8F97A63B-55F1-527F-9D6E-467B6A7E8CF1
+     */
     requestId?: string;
+    /**
+     * @example
+     * 200
+     */
     status?: string;
+    /**
+     * @example
+     * true
+     */
     success?: boolean;
     static names(): {
         [key: string]: string;
@@ -451,9 +866,28 @@ export declare class ListChunksResponse extends $tea.Model {
 }
 export declare class ListIndexDocumentsRequest extends $tea.Model {
     documentName?: string;
+    /**
+     * @example
+     * FINISH
+     */
     documentStatus?: string;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * 79c0aly8zw
+     */
     indexId?: string;
+    /**
+     * @example
+     * 1
+     */
     pageNumber?: number;
+    /**
+     * @example
+     * 10
+     */
     pageSize?: number;
     static names(): {
         [key: string]: string;
@@ -466,11 +900,34 @@ export declare class ListIndexDocumentsRequest extends $tea.Model {
     });
 }
 export declare class ListIndexDocumentsResponseBody extends $tea.Model {
+    /**
+     * @example
+     * InvalidParameter
+     */
     code?: string;
     data?: ListIndexDocumentsResponseBodyData;
+    /**
+     * @example
+     * Required parameter(%s) missing or invalid, please check the request parameters.
+     */
     message?: string;
+    /**
+     * @remarks
+     * Id of the request
+     *
+     * @example
+     * 35A267BF-xxxx-54DB-8394-AA3B0742D833
+     */
     requestId?: string;
+    /**
+     * @example
+     * 200
+     */
     status?: string;
+    /**
+     * @example
+     * true
+     */
     success?: boolean;
     static names(): {
         [key: string]: string;
@@ -499,8 +956,20 @@ export declare class ListIndexDocumentsResponse extends $tea.Model {
     });
 }
 export declare class ListIndicesRequest extends $tea.Model {
+    /**
+     * @example
+     * idx_status_score
+     */
     indexName?: string;
+    /**
+     * @example
+     * 1
+     */
     pageNumber?: string;
+    /**
+     * @example
+     * 10
+     */
     pageSize?: string;
     static names(): {
         [key: string]: string;
@@ -513,11 +982,34 @@ export declare class ListIndicesRequest extends $tea.Model {
     });
 }
 export declare class ListIndicesResponseBody extends $tea.Model {
+    /**
+     * @example
+     * Index.InvalidParameter
+     */
     code?: string;
     data?: ListIndicesResponseBodyData;
+    /**
+     * @example
+     * Required parameter(%s) missing or invalid, please check the request parameters.
+     */
     message?: string;
+    /**
+     * @remarks
+     * Id of the request
+     *
+     * @example
+     * 17204B98-xxxx-4F9A-8464-2446A84821CA
+     */
     requestId?: string;
+    /**
+     * @example
+     * 200
+     */
     status?: string;
+    /**
+     * @example
+     * true
+     */
     success?: boolean;
     static names(): {
         [key: string]: string;
@@ -546,16 +1038,54 @@ export declare class ListIndicesResponse extends $tea.Model {
     });
 }
 export declare class RetrieveRequest extends $tea.Model {
+    /**
+     * @example
+     * 100
+     */
     denseSimilarityTopK?: number;
+    /**
+     * @example
+     * true
+     */
     enableReranking?: boolean;
+    /**
+     * @example
+     * false
+     */
     enableRewrite?: boolean;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * 5pwe0m2g6t
+     */
     indexId?: string;
     query?: string;
     rerank?: RetrieveRequestRerank[];
+    /**
+     * @example
+     * 0.20
+     */
     rerankMinScore?: number;
+    /**
+     * @example
+     * 5
+     */
     rerankTopN?: number;
     rewrite?: RetrieveRequestRewrite[];
+    /**
+     * @example
+     * false
+     */
     saveRetrieverHistory?: boolean;
+    searchFilters?: {
+        [key: string]: string;
+    }[];
+    /**
+     * @example
+     * 100
+     */
     sparseSimilarityTopK?: number;
     static names(): {
         [key: string]: string;
@@ -568,16 +1098,52 @@ export declare class RetrieveRequest extends $tea.Model {
     });
 }
 export declare class RetrieveShrinkRequest extends $tea.Model {
+    /**
+     * @example
+     * 100
+     */
     denseSimilarityTopK?: number;
+    /**
+     * @example
+     * true
+     */
     enableReranking?: boolean;
+    /**
+     * @example
+     * false
+     */
     enableRewrite?: boolean;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * 5pwe0m2g6t
+     */
     indexId?: string;
     query?: string;
     rerankShrink?: string;
+    /**
+     * @example
+     * 0.20
+     */
     rerankMinScore?: number;
+    /**
+     * @example
+     * 5
+     */
     rerankTopN?: number;
     rewriteShrink?: string;
+    /**
+     * @example
+     * false
+     */
     saveRetrieverHistory?: boolean;
+    searchFiltersShrink?: string;
+    /**
+     * @example
+     * 100
+     */
     sparseSimilarityTopK?: number;
     static names(): {
         [key: string]: string;
@@ -590,11 +1156,34 @@ export declare class RetrieveShrinkRequest extends $tea.Model {
     });
 }
 export declare class RetrieveResponseBody extends $tea.Model {
+    /**
+     * @example
+     * Index.InvalidParameter
+     */
     code?: string;
     data?: RetrieveResponseBodyData;
+    /**
+     * @example
+     * Required parameter(%s) missing or invalid, please check the request parameters.
+     */
     message?: string;
+    /**
+     * @remarks
+     * Id of the request
+     *
+     * @example
+     * 17204B98-7734-4F9A-8464-2446A84821CA
+     */
     requestId?: string;
+    /**
+     * @example
+     * 200
+     */
     status?: string;
+    /**
+     * @example
+     * true
+     */
     success?: boolean;
     static names(): {
         [key: string]: string;
@@ -625,7 +1214,21 @@ export declare class RetrieveResponse extends $tea.Model {
 export declare class SubmitIndexAddDocumentsJobRequest extends $tea.Model {
     categoryIds?: string[];
     documentIds?: string[];
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * 79c0aly8zw
+     */
     indexId?: string;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * DATA_CENTER_FILE
+     */
     sourceType?: string;
     static names(): {
         [key: string]: string;
@@ -640,7 +1243,21 @@ export declare class SubmitIndexAddDocumentsJobRequest extends $tea.Model {
 export declare class SubmitIndexAddDocumentsJobShrinkRequest extends $tea.Model {
     categoryIdsShrink?: string;
     documentIdsShrink?: string;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * 79c0aly8zw
+     */
     indexId?: string;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * DATA_CENTER_FILE
+     */
     sourceType?: string;
     static names(): {
         [key: string]: string;
@@ -653,11 +1270,34 @@ export declare class SubmitIndexAddDocumentsJobShrinkRequest extends $tea.Model
     });
 }
 export declare class SubmitIndexAddDocumentsJobResponseBody extends $tea.Model {
+    /**
+     * @example
+     * Index.InvalidParameter
+     */
     code?: string;
     data?: SubmitIndexAddDocumentsJobResponseBodyData;
+    /**
+     * @example
+     * Required parameter(%s) missing or invalid, please check the request parameters.
+     */
     message?: string;
+    /**
+     * @remarks
+     * Id of the request
+     *
+     * @example
+     * 778C0B3B-03C1-5FC1-A947-36EDD13606AB
+     */
     requestId?: string;
+    /**
+     * @example
+     * 200
+     */
     status?: string;
+    /**
+     * @example
+     * true
+     */
     success?: boolean;
     static names(): {
         [key: string]: string;
@@ -686,6 +1326,13 @@ export declare class SubmitIndexAddDocumentsJobResponse extends $tea.Model {
     });
 }
 export declare class SubmitIndexJobRequest extends $tea.Model {
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * 79c0aly8zw
+     */
     indexId?: string;
     static names(): {
         [key: string]: string;
@@ -698,11 +1345,34 @@ export declare class SubmitIndexJobRequest extends $tea.Model {
     });
 }
 export declare class SubmitIndexJobResponseBody extends $tea.Model {
+    /**
+     * @example
+     * InvalidParameter
+     */
     code?: string;
     data?: SubmitIndexJobResponseBodyData;
+    /**
+     * @example
+     * Required parameter(%s) missing or invalid, please check the request parameters.
+     */
     message?: string;
+    /**
+     * @remarks
+     * Id of the request
+     *
+     * @example
+     * 17204B98-xxxx-4F9A-8464-2446A84821CA
+     */
     requestId?: string;
+    /**
+     * @example
+     * Success
+     */
     status?: string;
+    /**
+     * @example
+     * True
+     */
     success?: boolean;
     static names(): {
         [key: string]: string;
@@ -731,7 +1401,15 @@ export declare class SubmitIndexJobResponse extends $tea.Model {
     });
 }
 export declare class AddFileResponseBodyData extends $tea.Model {
+    /**
+     * @example
+     * file_9a65732555b54d5ea10796ca5742ba22_XXXXXXXX
+     */
     fileId?: string;
+    /**
+     * @example
+     * DASHSCOPE_DOCMIND
+     */
     parser?: string;
     static names(): {
         [key: string]: string;
@@ -744,8 +1422,21 @@ export declare class AddFileResponseBodyData extends $tea.Model {
     });
 }
 export declare class ApplyFileUploadLeaseResponseBodyDataParam extends $tea.Model {
+    /**
+     * @example
+     * "X-bailian-extra": "MTAwNTQyNjQ5NTE2OTE3OA==",
+     *         "Content-Type": "application/pdf"
+     */
     headers?: any;
+    /**
+     * @example
+     * PUT
+     */
     method?: string;
+    /**
+     * @example
+     * https://bailian-datahub-data-origin-prod.oss-cn-hangzhou.aliyuncs.com/1005426495169178/10024405/68abd1dea7b6404d8f7d7b9f7fbd332d.1716698936847.pdf?Expires=1716699536&OSSAccessKeyId=TestID&Signature=HfwPUZo4pR6DatSDym0zFKVh9Wg%3D
+     */
     url?: string;
     static names(): {
         [key: string]: string;
@@ -758,8 +1449,16 @@ export declare class ApplyFileUploadLeaseResponseBodyDataParam extends $tea.Mode
     });
 }
 export declare class ApplyFileUploadLeaseResponseBodyData extends $tea.Model {
+    /**
+     * @example
+     * 1e6a159107384782be5e45ac4759b247.1719325231035
+     */
     fileUploadLeaseId?: string;
     param?: ApplyFileUploadLeaseResponseBodyDataParam;
+    /**
+     * @example
+     * HTTP
+     */
     type?: string;
     static names(): {
         [key: string]: string;
@@ -788,6 +1487,10 @@ export declare class CreateIndexRequestColumns extends $tea.Model {
     });
 }
 export declare class CreateIndexResponseBodyData extends $tea.Model {
+    /**
+     * @example
+     * jkurxhju6b
+     */
     id?: string;
     static names(): {
         [key: string]: string;
@@ -800,6 +1503,10 @@ export declare class CreateIndexResponseBodyData extends $tea.Model {
     });
 }
 export declare class DeleteFileResponseBodyData extends $tea.Model {
+    /**
+     * @example
+     * file_9a65732555b54d5ea10796ca5742ba22_XXXXXXXX
+     */
     fileId?: string;
     static names(): {
         [key: string]: string;
@@ -824,13 +1531,45 @@ export declare class DeleteIndexDocumentResponseBodyData extends $tea.Model {
     });
 }
 export declare class DescribeFileResponseBodyData extends $tea.Model {
+    /**
+     * @example
+     * cate_cdd11b1b79a74e8bbd675c356a91ee3XXXXXXXX
+     */
     categoryId?: string;
+    /**
+     * @example
+     * 2024-05-26 12:45:43
+     */
     createTime?: string;
+    /**
+     * @example
+     * file_9a65732555b54d5ea10796ca5742ba22_XXXXXXXX
+     */
     fileId?: string;
+    /**
+     * @example
+     * test.pdf
+     */
     fileName?: string;
+    /**
+     * @example
+     * pdf
+     */
     fileType?: string;
+    /**
+     * @example
+     * DASHSCOPE_DOCMIND
+     */
     parser?: string;
+    /**
+     * @example
+     * 1234
+     */
     sizeInBytes?: number;
+    /**
+     * @example
+     * PARSE_SUCCESS
+     */
     status?: string;
     static names(): {
         [key: string]: string;
@@ -843,10 +1582,26 @@ export declare class DescribeFileResponseBodyData extends $tea.Model {
     });
 }
 export declare class GetIndexJobStatusResponseBodyDataDocuments extends $tea.Model {
+    /**
+     * @example
+     * Index.Document.ChunkError
+     */
     code?: string;
+    /**
+     * @example
+     * file_9a65732555b54d5ea10796ca5742ba22_XXXXXXXX
+     */
     docId?: string;
     docName?: string;
+    /**
+     * @example
+     * document parse error
+     */
     message?: string;
+    /**
+     * @example
+     * RUNNING
+     */
     status?: string;
     static names(): {
         [key: string]: string;
@@ -860,7 +1615,15 @@ export declare class GetIndexJobStatusResponseBodyDataDocuments extends $tea.Mod
 }
 export declare class GetIndexJobStatusResponseBodyData extends $tea.Model {
     documents?: GetIndexJobStatusResponseBodyDataDocuments[];
+    /**
+     * @example
+     * 66122af12a4e45ddae6bd6c845556647
+     */
     jobId?: string;
+    /**
+     * @example
+     * PENDING
+     */
     status?: string;
     static names(): {
         [key: string]: string;
@@ -874,6 +1637,10 @@ export declare class GetIndexJobStatusResponseBodyData extends $tea.Model {
 }
 export declare class ListChunksResponseBodyDataNodes extends $tea.Model {
     metadata?: any;
+    /**
+     * @example
+     * 0.3
+     */
     score?: number;
     text?: string;
     static names(): {
@@ -888,6 +1655,10 @@ export declare class ListChunksResponseBodyDataNodes extends $tea.Model {
 }
 export declare class ListChunksResponseBodyData extends $tea.Model {
     nodes?: ListChunksResponseBodyDataNodes[];
+    /**
+     * @example
+     * 16
+     */
     total?: number;
     static names(): {
         [key: string]: string;
@@ -900,13 +1671,41 @@ export declare class ListChunksResponseBodyData extends $tea.Model {
     });
 }
 export declare class ListIndexDocumentsResponseBodyDataDocuments extends $tea.Model {
+    /**
+     * @example
+     * 110002
+     */
     code?: string;
+    /**
+     * @example
+     * pdf
+     */
     documentType?: string;
+    /**
+     * @example
+     * doc_c134aa2073204a5d936d870bf960f56a10024701
+     */
     id?: string;
+    /**
+     * @example
+     * check fileUrlKey[file_path] / fileNameKey[null] / fileExtensionKey[file_extension] is invalid
+     */
     message?: string;
     name?: string;
+    /**
+     * @example
+     * 996764
+     */
     size?: number;
+    /**
+     * @example
+     * cate_21a407a3372c4ba7aedc649709143f0c10021401
+     */
     sourceId?: string;
+    /**
+     * @example
+     * RUNNING
+     */
     status?: string;
     static names(): {
         [key: string]: string;
@@ -920,9 +1719,25 @@ export declare class ListIndexDocumentsResponseBodyDataDocuments extends $tea.Mo
 }
 export declare class ListIndexDocumentsResponseBodyData extends $tea.Model {
     documents?: ListIndexDocumentsResponseBodyDataDocuments[];
+    /**
+     * @example
+     * pno97tn8iu
+     */
     indexId?: string;
+    /**
+     * @example
+     * 1
+     */
     pageNumber?: number;
+    /**
+     * @example
+     * 10
+     */
     pageSize?: number;
+    /**
+     * @example
+     * 2437
+     */
     totalCount?: number;
     static names(): {
         [key: string]: string;
@@ -935,20 +1750,76 @@ export declare class ListIndexDocumentsResponseBodyData extends $tea.Model {
     });
 }
 export declare class ListIndicesResponseBodyDataIndices extends $tea.Model {
+    /**
+     * @example
+     * 5
+     */
     chunkSize?: number;
+    /**
+     * @example
+     * If each RAM user belongs to a RAM group, the configuration is considered compliant.
+     */
     description?: string;
     documentIds?: string[];
+    /**
+     * @example
+     * conv-rewrite-qwen-1.8b
+     */
     embeddingModelName?: string;
+    /**
+     * @example
+     * 259899
+     */
     id?: string;
+    /**
+     * @example
+     * temp_mUB4j
+     */
     name?: string;
+    /**
+     * @example
+     * 10
+     */
     overlapSize?: number;
+    /**
+     * @example
+     * 0.01
+     */
     rerankMinScore?: string;
+    /**
+     * @example
+     * gte-rerank-hybrid
+     */
     rerankModelName?: string;
+    /**
+     * @example
+     * \\n
+     */
     separator?: string;
+    /**
+     * @example
+     * gp-bp1gq62t1788yw2ol
+     */
     sinkInstanceId?: string;
+    /**
+     * @example
+     * cn-hangzhou
+     */
     sinkRegion?: string;
+    /**
+     * @example
+     * es
+     */
     sinkType?: string;
+    /**
+     * @example
+     * DATA_CENTER_FILE
+     */
     sourceType?: string;
+    /**
+     * @example
+     * structured
+     */
     structureType?: string;
     static names(): {
         [key: string]: string;
@@ -962,8 +1833,20 @@ export declare class ListIndicesResponseBodyDataIndices extends $tea.Model {
 }
 export declare class ListIndicesResponseBodyData extends $tea.Model {
     indices?: ListIndicesResponseBodyDataIndices[];
+    /**
+     * @example
+     * 1
+     */
     pageNumber?: number;
+    /**
+     * @example
+     * 10
+     */
     pageSize?: number;
+    /**
+     * @example
+     * 48
+     */
     totalCount?: number;
     static names(): {
         [key: string]: string;
@@ -976,6 +1859,10 @@ export declare class ListIndicesResponseBodyData extends $tea.Model {
     });
 }
 export declare class RetrieveRequestRerank extends $tea.Model {
+    /**
+     * @example
+     * gte-rerank-hybrid
+     */
     modelName?: string;
     static names(): {
         [key: string]: string;
@@ -1001,6 +1888,10 @@ export declare class RetrieveRequestRewrite extends $tea.Model {
 }
 export declare class RetrieveResponseBodyDataNodes extends $tea.Model {
     metadata?: any;
+    /**
+     * @example
+     * 0.3
+     */
     score?: number;
     text?: string;
     static names(): {
@@ -1026,6 +1917,10 @@ export declare class RetrieveResponseBodyData extends $tea.Model {
     });
 }
 export declare class SubmitIndexAddDocumentsJobResponseBodyData extends $tea.Model {
+    /**
+     * @example
+     * 42687eb254a34802bed398357f5498ae
+     */
     id?: string;
     static names(): {
         [key: string]: string;
@@ -1038,7 +1933,15 @@ export declare class SubmitIndexAddDocumentsJobResponseBodyData extends $tea.Mod
     });
 }
 export declare class SubmitIndexJobResponseBodyData extends $tea.Model {
+    /**
+     * @example
+     * eFDr2fGRzP9gdDZWAdo3YQ==
+     */
     id?: string;
+    /**
+     * @example
+     * khdyak1uuj
+     */
     indexId?: string;
     static names(): {
         [key: string]: string;
@@ -1056,251 +1959,249 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, endpoint: string): string;
     /**
-     * @summary 将临时上传的文档导入百炼数据中心，导入成功之后会自动触发文档解析。
+     * 将临时上传的文档导入百炼数据中心，导入成功之后会自动触发文档解析。
      *
-     * @param request AddFileRequest
-     * @param headers map
-     * @param runtime runtime options for this request RuntimeOptions
-     * @return AddFileResponse
+     * @param request - AddFileRequest
+     * @param headers - map
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns AddFileResponse
      */
     addFileWithOptions(WorkspaceId: string, request: AddFileRequest, headers: {
         [key: string]: string;
     }, runtime: $Util.RuntimeOptions): Promise<AddFileResponse>;
     /**
-     * @summary 将临时上传的文档导入百炼数据中心，导入成功之后会自动触发文档解析。
+     * 将临时上传的文档导入百炼数据中心，导入成功之后会自动触发文档解析。
      *
-     * @param request AddFileRequest
-     * @return AddFileResponse
+     * @param request - AddFileRequest
+     * @returns AddFileResponse
      */
     addFile(WorkspaceId: string, request: AddFileRequest): Promise<AddFileResponse>;
     /**
-     * @summary 请求文档上传租约，进行文档上传。
+     * 请求文档上传租约，进行文档上传。
      *
-     * @param request ApplyFileUploadLeaseRequest
-     * @param headers map
-     * @param runtime runtime options for this request RuntimeOptions
-     * @return ApplyFileUploadLeaseResponse
+     * @param request - ApplyFileUploadLeaseRequest
+     * @param headers - map
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns ApplyFileUploadLeaseResponse
      */
     applyFileUploadLeaseWithOptions(CategoryId: string, WorkspaceId: string, request: ApplyFileUploadLeaseRequest, headers: {
         [key: string]: string;
     }, runtime: $Util.RuntimeOptions): Promise<ApplyFileUploadLeaseResponse>;
     /**
-     * @summary 请求文档上传租约，进行文档上传。
+     * 请求文档上传租约，进行文档上传。
      *
-     * @param request ApplyFileUploadLeaseRequest
-     * @return ApplyFileUploadLeaseResponse
+     * @param request - ApplyFileUploadLeaseRequest
+     * @returns ApplyFileUploadLeaseResponse
      */
     applyFileUploadLease(CategoryId: string, WorkspaceId: string, request: ApplyFileUploadLeaseRequest): Promise<ApplyFileUploadLeaseResponse>;
     /**
-     * @summary 创建并运行pipeline
+     * 创建并运行pipeline
      *
-     * @param tmpReq CreateIndexRequest
-     * @param headers map
-     * @param runtime runtime options for this request RuntimeOptions
-     * @return CreateIndexResponse
+     * @param tmpReq - CreateIndexRequest
+     * @param headers - map
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns CreateIndexResponse
      */
     createIndexWithOptions(WorkspaceId: string, tmpReq: CreateIndexRequest, headers: {
         [key: string]: string;
     }, runtime: $Util.RuntimeOptions): Promise<CreateIndexResponse>;
     /**
-     * @summary 创建并运行pipeline
+     * 创建并运行pipeline
      *
-     * @param request CreateIndexRequest
-     * @return CreateIndexResponse
+     * @param request - CreateIndexRequest
+     * @returns CreateIndexResponse
      */
     createIndex(WorkspaceId: string, request: CreateIndexRequest): Promise<CreateIndexResponse>;
     /**
-     * @summary 删除文档
+     * 删除文档
      *
-     * @param headers map
-     * @param runtime runtime options for this request RuntimeOptions
-     * @return DeleteFileResponse
+     * @param headers - map
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns DeleteFileResponse
      */
     deleteFileWithOptions(FileId: string, WorkspaceId: string, headers: {
         [key: string]: string;
     }, runtime: $Util.RuntimeOptions): Promise<DeleteFileResponse>;
     /**
-     * @summary 删除文档
-     *
-     * @return DeleteFileResponse
+     * 删除文档
+     * @returns DeleteFileResponse
      */
     deleteFile(FileId: string, WorkspaceId: string): Promise<DeleteFileResponse>;
     /**
-     * @summary 删除Index
+     * 删除Index
      *
-     * @param request DeleteIndexRequest
-     * @param headers map
-     * @param runtime runtime options for this request RuntimeOptions
-     * @return DeleteIndexResponse
+     * @param request - DeleteIndexRequest
+     * @param headers - map
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns DeleteIndexResponse
      */
     deleteIndexWithOptions(WorkspaceId: string, request: DeleteIndexRequest, headers: {
         [key: string]: string;
     }, runtime: $Util.RuntimeOptions): Promise<DeleteIndexResponse>;
     /**
-     * @summary 删除Index
+     * 删除Index
      *
-     * @param request DeleteIndexRequest
-     * @return DeleteIndexResponse
+     * @param request - DeleteIndexRequest
+     * @returns DeleteIndexResponse
      */
     deleteIndex(WorkspaceId: string, request: DeleteIndexRequest): Promise<DeleteIndexResponse>;
     /**
-     * @summary 删除index doc
+     * 删除index doc
      *
-     * @param tmpReq DeleteIndexDocumentRequest
-     * @param headers map
-     * @param runtime runtime options for this request RuntimeOptions
-     * @return DeleteIndexDocumentResponse
+     * @param tmpReq - DeleteIndexDocumentRequest
+     * @param headers - map
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns DeleteIndexDocumentResponse
      */
     deleteIndexDocumentWithOptions(WorkspaceId: string, tmpReq: DeleteIndexDocumentRequest, headers: {
         [key: string]: string;
     }, runtime: $Util.RuntimeOptions): Promise<DeleteIndexDocumentResponse>;
     /**
-     * @summary 删除index doc
+     * 删除index doc
      *
-     * @param request DeleteIndexDocumentRequest
-     * @return DeleteIndexDocumentResponse
+     * @param request - DeleteIndexDocumentRequest
+     * @returns DeleteIndexDocumentResponse
      */
     deleteIndexDocument(WorkspaceId: string, request: DeleteIndexDocumentRequest): Promise<DeleteIndexDocumentResponse>;
     /**
-     * @summary 获取文档基本信息，包括文档名称、类型、状态等。
+     * 获取文档基本信息，包括文档名称、类型、状态等。
      *
-     * @param headers map
-     * @param runtime runtime options for this request RuntimeOptions
-     * @return DescribeFileResponse
+     * @param headers - map
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns DescribeFileResponse
      */
     describeFileWithOptions(WorkspaceId: string, FileId: string, headers: {
         [key: string]: string;
     }, runtime: $Util.RuntimeOptions): Promise<DescribeFileResponse>;
     /**
-     * @summary 获取文档基本信息，包括文档名称、类型、状态等。
-     *
-     * @return DescribeFileResponse
+     * 获取文档基本信息，包括文档名称、类型、状态等。
+     * @returns DescribeFileResponse
      */
     describeFile(WorkspaceId: string, FileId: string): Promise<DescribeFileResponse>;
     /**
-     * @summary 获取Index运行状态
+     * 获取Index运行状态
      *
-     * @param request GetIndexJobStatusRequest
-     * @param headers map
-     * @param runtime runtime options for this request RuntimeOptions
-     * @return GetIndexJobStatusResponse
+     * @param request - GetIndexJobStatusRequest
+     * @param headers - map
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns GetIndexJobStatusResponse
      */
     getIndexJobStatusWithOptions(WorkspaceId: string, request: GetIndexJobStatusRequest, headers: {
         [key: string]: string;
     }, runtime: $Util.RuntimeOptions): Promise<GetIndexJobStatusResponse>;
     /**
-     * @summary 获取Index运行状态
+     * 获取Index运行状态
      *
-     * @param request GetIndexJobStatusRequest
-     * @return GetIndexJobStatusResponse
+     * @param request - GetIndexJobStatusRequest
+     * @returns GetIndexJobStatusResponse
      */
     getIndexJobStatus(WorkspaceId: string, request: GetIndexJobStatusRequest): Promise<GetIndexJobStatusResponse>;
     /**
-     * @summary Chunk
+     * Chunk
      *
-     * @param request ListChunksRequest
-     * @param headers map
-     * @param runtime runtime options for this request RuntimeOptions
-     * @return ListChunksResponse
+     * @param request - ListChunksRequest
+     * @param headers - map
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns ListChunksResponse
      */
     listChunksWithOptions(WorkspaceId: string, request: ListChunksRequest, headers: {
         [key: string]: string;
     }, runtime: $Util.RuntimeOptions): Promise<ListChunksResponse>;
     /**
-     * @summary Chunk
+     * Chunk
      *
-     * @param request ListChunksRequest
-     * @return ListChunksResponse
+     * @param request - ListChunksRequest
+     * @returns ListChunksResponse
      */
     listChunks(WorkspaceId: string, request: ListChunksRequest): Promise<ListChunksResponse>;
     /**
-     * @summary 查询Index文件
+     * 查询Index文件
      *
-     * @param request ListIndexDocumentsRequest
-     * @param headers map
-     * @param runtime runtime options for this request RuntimeOptions
-     * @return ListIndexDocumentsResponse
+     * @param request - ListIndexDocumentsRequest
+     * @param headers - map
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns ListIndexDocumentsResponse
      */
     listIndexDocumentsWithOptions(WorkspaceId: string, request: ListIndexDocumentsRequest, headers: {
         [key: string]: string;
     }, runtime: $Util.RuntimeOptions): Promise<ListIndexDocumentsResponse>;
     /**
-     * @summary 查询Index文件
+     * 查询Index文件
      *
-     * @param request ListIndexDocumentsRequest
-     * @return ListIndexDocumentsResponse
+     * @param request - ListIndexDocumentsRequest
+     * @returns ListIndexDocumentsResponse
      */
     listIndexDocuments(WorkspaceId: string, request: ListIndexDocumentsRequest): Promise<ListIndexDocumentsResponse>;
     /**
-     * @summary 查询pipeline
+     * 查询pipeline
      *
-     * @param request ListIndicesRequest
-     * @param headers map
-     * @param runtime runtime options for this request RuntimeOptions
-     * @return ListIndicesResponse
+     * @param request - ListIndicesRequest
+     * @param headers - map
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns ListIndicesResponse
      */
     listIndicesWithOptions(WorkspaceId: string, request: ListIndicesRequest, headers: {
         [key: string]: string;
     }, runtime: $Util.RuntimeOptions): Promise<ListIndicesResponse>;
     /**
-     * @summary 查询pipeline
+     * 查询pipeline
      *
-     * @param request ListIndicesRequest
-     * @return ListIndicesResponse
+     * @param request - ListIndicesRequest
+     * @returns ListIndicesResponse
      */
     listIndices(WorkspaceId: string, request: ListIndicesRequest): Promise<ListIndicesResponse>;
     /**
-     * @summary 召回测试
+     * 召回测试
      *
-     * @param tmpReq RetrieveRequest
-     * @param headers map
-     * @param runtime runtime options for this request RuntimeOptions
-     * @return RetrieveResponse
+     * @param tmpReq - RetrieveRequest
+     * @param headers - map
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns RetrieveResponse
      */
     retrieveWithOptions(WorkspaceId: string, tmpReq: RetrieveRequest, headers: {
         [key: string]: string;
     }, runtime: $Util.RuntimeOptions): Promise<RetrieveResponse>;
     /**
-     * @summary 召回测试
+     * 召回测试
      *
-     * @param request RetrieveRequest
-     * @return RetrieveResponse
+     * @param request - RetrieveRequest
+     * @returns RetrieveResponse
      */
     retrieve(WorkspaceId: string, request: RetrieveRequest): Promise<RetrieveResponse>;
     /**
-     * @summary 知识索引
+     * 知识索引
      *
-     * @param tmpReq SubmitIndexAddDocumentsJobRequest
-     * @param headers map
-     * @param runtime runtime options for this request RuntimeOptions
-     * @return SubmitIndexAddDocumentsJobResponse
+     * @param tmpReq - SubmitIndexAddDocumentsJobRequest
+     * @param headers - map
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns SubmitIndexAddDocumentsJobResponse
      */
     submitIndexAddDocumentsJobWithOptions(WorkspaceId: string, tmpReq: SubmitIndexAddDocumentsJobRequest, headers: {
         [key: string]: string;
     }, runtime: $Util.RuntimeOptions): Promise<SubmitIndexAddDocumentsJobResponse>;
     /**
-     * @summary 知识索引
+     * 知识索引
      *
-     * @param request SubmitIndexAddDocumentsJobRequest
-     * @return SubmitIndexAddDocumentsJobResponse
+     * @param request - SubmitIndexAddDocumentsJobRequest
+     * @returns SubmitIndexAddDocumentsJobResponse
      */
     submitIndexAddDocumentsJob(WorkspaceId: string, request: SubmitIndexAddDocumentsJobRequest): Promise<SubmitIndexAddDocumentsJobResponse>;
     /**
-     * @summary 提交索引任务
+     * 提交索引任务
      *
-     * @param request SubmitIndexJobRequest
-     * @param headers map
-     * @param runtime runtime options for this request RuntimeOptions
-     * @return SubmitIndexJobResponse
+     * @param request - SubmitIndexJobRequest
+     * @param headers - map
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns SubmitIndexJobResponse
      */
     submitIndexJobWithOptions(WorkspaceId: string, request: SubmitIndexJobRequest, headers: {
         [key: string]: string;
     }, runtime: $Util.RuntimeOptions): Promise<SubmitIndexJobResponse>;
     /**
-     * @summary 提交索引任务
+     * 提交索引任务
      *
-     * @param request SubmitIndexJobRequest
-     * @return SubmitIndexJobResponse
+     * @param request - SubmitIndexJobRequest
+     * @returns SubmitIndexJobResponse
      */
     submitIndexJob(WorkspaceId: string, request: SubmitIndexJobRequest): Promise<SubmitIndexJobResponse>;
 }