@alicloud/bailian20231229 1.0.0 → 1.2.0

package/dist/client.d.ts

@@ -98,6 +98,93 @@ export declare class ApplyFileUploadLeaseResponse extends $tea.Model {
         [key: string]: any;
     });
 }
+export declare class CreateIndexRequest extends $tea.Model {
+    categoryIds?: string[];
+    chunkSize?: number;
+    columns?: CreateIndexRequestColumns[];
+    description?: string;
+    documentIds?: string[];
+    embeddingModelName?: string;
+    name?: string;
+    overlapSize?: number;
+    rerankMinScore?: number;
+    rerankModelName?: string;
+    separator?: string;
+    sinkInstanceId?: string;
+    sinkRegion?: string;
+    sinkType?: string;
+    sourceType?: string;
+    structureType?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class CreateIndexShrinkRequest extends $tea.Model {
+    categoryIdsShrink?: string;
+    chunkSize?: number;
+    columnsShrink?: string;
+    description?: string;
+    documentIdsShrink?: string;
+    embeddingModelName?: string;
+    name?: string;
+    overlapSize?: number;
+    rerankMinScore?: number;
+    rerankModelName?: string;
+    separator?: string;
+    sinkInstanceId?: string;
+    sinkRegion?: string;
+    sinkType?: string;
+    sourceType?: string;
+    structureType?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class CreateIndexResponseBody extends $tea.Model {
+    code?: string;
+    data?: CreateIndexResponseBodyData;
+    message?: string;
+    requestId?: string;
+    status?: string;
+    success?: boolean;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class CreateIndexResponse extends $tea.Model {
+    headers?: {
+        [key: string]: string;
+    };
+    statusCode?: number;
+    body?: CreateIndexResponseBody;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
 export declare class DescribeFileResponseBody extends $tea.Model {
     code?: string;
     data?: DescribeFileResponseBodyData;
@@ -131,6 +218,237 @@ export declare class DescribeFileResponse extends $tea.Model {
         [key: string]: any;
     });
 }
+export declare class GetIndexJobStatusRequest extends $tea.Model {
+    indexId?: string;
+    jobId?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class GetIndexJobStatusResponseBody extends $tea.Model {
+    code?: string;
+    data?: GetIndexJobStatusResponseBodyData;
+    message?: string;
+    requestId?: string;
+    status?: string;
+    success?: boolean;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class GetIndexJobStatusResponse extends $tea.Model {
+    headers?: {
+        [key: string]: string;
+    };
+    statusCode?: number;
+    body?: GetIndexJobStatusResponseBody;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class RetrieveRequest extends $tea.Model {
+    denseSimilarityTopK?: number;
+    enableReranking?: boolean;
+    enableRewrite?: boolean;
+    indexId?: string;
+    query?: string;
+    rerank?: RetrieveRequestRerank[];
+    rerankMinScore?: number;
+    rerankTopN?: number;
+    rewrite?: RetrieveRequestRewrite[];
+    saveRetrieverHistory?: boolean;
+    sparseSimilarityTopK?: number;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class RetrieveShrinkRequest extends $tea.Model {
+    denseSimilarityTopK?: number;
+    enableReranking?: boolean;
+    enableRewrite?: boolean;
+    indexId?: string;
+    query?: string;
+    rerankShrink?: string;
+    rerankMinScore?: number;
+    rerankTopN?: number;
+    rewriteShrink?: string;
+    saveRetrieverHistory?: boolean;
+    sparseSimilarityTopK?: number;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class RetrieveResponseBody extends $tea.Model {
+    code?: string;
+    data?: RetrieveResponseBodyData;
+    message?: string;
+    requestId?: string;
+    status?: string;
+    success?: boolean;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class RetrieveResponse extends $tea.Model {
+    headers?: {
+        [key: string]: string;
+    };
+    statusCode?: number;
+    body?: RetrieveResponseBody;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class SubmitIndexAddDocumentsJobRequest extends $tea.Model {
+    categoryIds?: string[];
+    documentIds?: string[];
+    indexId?: string;
+    sourceType?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class SubmitIndexAddDocumentsJobShrinkRequest extends $tea.Model {
+    categoryIdsShrink?: string;
+    documentIdsShrink?: string;
+    indexId?: string;
+    sourceType?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class SubmitIndexAddDocumentsJobResponseBody extends $tea.Model {
+    code?: string;
+    data?: SubmitIndexAddDocumentsJobResponseBodyData;
+    message?: string;
+    requestId?: string;
+    status?: string;
+    success?: boolean;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class SubmitIndexAddDocumentsJobResponse extends $tea.Model {
+    headers?: {
+        [key: string]: string;
+    };
+    statusCode?: number;
+    body?: SubmitIndexAddDocumentsJobResponseBody;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class SubmitIndexJobRequest extends $tea.Model {
+    indexId?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class SubmitIndexJobResponseBody extends $tea.Model {
+    code?: string;
+    data?: SubmitIndexJobResponseBodyData;
+    message?: string;
+    requestId?: string;
+    status?: string;
+    success?: boolean;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class SubmitIndexJobResponse extends $tea.Model {
+    headers?: {
+        [key: string]: string;
+    };
+    statusCode?: number;
+    body?: SubmitIndexJobResponseBody;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
 export declare class AddFileResponseBodyData extends $tea.Model {
     fileId?: string;
     parser?: string;
@@ -172,6 +490,34 @@ export declare class ApplyFileUploadLeaseResponseBodyData extends $tea.Model {
         [key: string]: any;
     });
 }
+export declare class CreateIndexRequestColumns extends $tea.Model {
+    column?: string;
+    isRecall?: boolean;
+    isSearch?: boolean;
+    name?: string;
+    type?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class CreateIndexResponseBodyData extends $tea.Model {
+    id?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
 export declare class DescribeFileResponseBodyData extends $tea.Model {
     categoryId?: string;
     createTime?: string;
@@ -191,6 +537,111 @@ export declare class DescribeFileResponseBodyData extends $tea.Model {
         [key: string]: any;
     });
 }
+export declare class GetIndexJobStatusResponseBodyDataDocuments extends $tea.Model {
+    code?: string;
+    docId?: string;
+    docName?: string;
+    message?: string;
+    status?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class GetIndexJobStatusResponseBodyData extends $tea.Model {
+    documents?: GetIndexJobStatusResponseBodyDataDocuments[];
+    jobId?: string;
+    status?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class RetrieveRequestRerank extends $tea.Model {
+    modelName?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class RetrieveRequestRewrite extends $tea.Model {
+    modelName?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class RetrieveResponseBodyDataNodes extends $tea.Model {
+    metadata?: any;
+    score?: number;
+    text?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class RetrieveResponseBodyData extends $tea.Model {
+    nodes?: RetrieveResponseBodyDataNodes[];
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class SubmitIndexAddDocumentsJobResponseBodyData extends $tea.Model {
+    id?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class SubmitIndexJobResponseBodyData extends $tea.Model {
+    id?: string;
+    indexId?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
 export default class Client extends OpenApi {
     constructor(config: $OpenApi.Config);
     getEndpoint(productId: string, regionId: string, endpointRule: string, network: string, suffix: string, endpointMap: {
@@ -232,6 +683,24 @@ export default class Client extends OpenApi {
      * @return ApplyFileUploadLeaseResponse
      */
     applyFileUploadLease(CategoryId: string, WorkspaceId: string, request: ApplyFileUploadLeaseRequest): Promise<ApplyFileUploadLeaseResponse>;
+    /**
+     * @summary 创建并运行pipeline
+     *
+     * @param tmpReq CreateIndexRequest
+     * @param headers map
+     * @param runtime runtime options for this request RuntimeOptions
+     * @return CreateIndexResponse
+     */
+    createIndexWithOptions(WorkspaceId: string, tmpReq: CreateIndexRequest, headers: {
+        [key: string]: string;
+    }, runtime: $Util.RuntimeOptions): Promise<CreateIndexResponse>;
+    /**
+     * @summary 创建并运行pipeline
+     *
+     * @param request CreateIndexRequest
+     * @return CreateIndexResponse
+     */
+    createIndex(WorkspaceId: string, request: CreateIndexRequest): Promise<CreateIndexResponse>;
     /**
      * @summary 获取文档基本信息，包括文档名称、类型、状态等。
      *
@@ -248,4 +717,76 @@ export default class Client extends OpenApi {
      * @return DescribeFileResponse
      */
     describeFile(WorkspaceId: string, FileId: string): Promise<DescribeFileResponse>;
+    /**
+     * @summary 获取Index运行状态
+     *
+     * @param request GetIndexJobStatusRequest
+     * @param headers map
+     * @param runtime runtime options for this request RuntimeOptions
+     * @return GetIndexJobStatusResponse
+     */
+    getIndexJobStatusWithOptions(WorkspaceId: string, request: GetIndexJobStatusRequest, headers: {
+        [key: string]: string;
+    }, runtime: $Util.RuntimeOptions): Promise<GetIndexJobStatusResponse>;
+    /**
+     * @summary 获取Index运行状态
+     *
+     * @param request GetIndexJobStatusRequest
+     * @return GetIndexJobStatusResponse
+     */
+    getIndexJobStatus(WorkspaceId: string, request: GetIndexJobStatusRequest): Promise<GetIndexJobStatusResponse>;
+    /**
+     * @summary 召回测试
+     *
+     * @param tmpReq RetrieveRequest
+     * @param headers map
+     * @param runtime runtime options for this request RuntimeOptions
+     * @return RetrieveResponse
+     */
+    retrieveWithOptions(WorkspaceId: string, tmpReq: RetrieveRequest, headers: {
+        [key: string]: string;
+    }, runtime: $Util.RuntimeOptions): Promise<RetrieveResponse>;
+    /**
+     * @summary 召回测试
+     *
+     * @param request RetrieveRequest
+     * @return 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
+     */
+    submitIndexAddDocumentsJobWithOptions(WorkspaceId: string, tmpReq: SubmitIndexAddDocumentsJobRequest, headers: {
+        [key: string]: string;
+    }, runtime: $Util.RuntimeOptions): Promise<SubmitIndexAddDocumentsJobResponse>;
+    /**
+     * @summary 知识索引
+     *
+     * @param request SubmitIndexAddDocumentsJobRequest
+     * @return 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
+     */
+    submitIndexJobWithOptions(WorkspaceId: string, request: SubmitIndexJobRequest, headers: {
+        [key: string]: string;
+    }, runtime: $Util.RuntimeOptions): Promise<SubmitIndexJobResponse>;
+    /**
+     * @summary 提交索引任务
+     *
+     * @param request SubmitIndexJobRequest
+     * @return SubmitIndexJobResponse
+     */
+    submitIndexJob(WorkspaceId: string, request: SubmitIndexJobRequest): Promise<SubmitIndexJobResponse>;
 }