@alicloud/bailian20231229 1.1.0 → 1.3.0

package/dist/client.d.ts

@@ -185,6 +185,109 @@ export declare class CreateIndexResponse extends $tea.Model {
         [key: string]: any;
     });
 }
+export declare class DeleteIndexRequest extends $tea.Model {
+    indexId?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class DeleteIndexResponseBody extends $tea.Model {
+    code?: string;
+    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 DeleteIndexResponse extends $tea.Model {
+    headers?: {
+        [key: string]: string;
+    };
+    statusCode?: number;
+    body?: DeleteIndexResponseBody;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class DeleteIndexDocumentRequest extends $tea.Model {
+    documentIds?: string[];
+    indexId?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class DeleteIndexDocumentShrinkRequest extends $tea.Model {
+    documentIdsShrink?: string;
+    indexId?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class DeleteIndexDocumentResponseBody extends $tea.Model {
+    code?: string;
+    data?: DeleteIndexDocumentResponseBodyData;
+    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 DeleteIndexDocumentResponse extends $tea.Model {
+    headers?: {
+        [key: string]: string;
+    };
+    statusCode?: number;
+    body?: DeleteIndexDocumentResponseBody;
+    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;
@@ -264,6 +367,151 @@ export declare class GetIndexJobStatusResponse extends $tea.Model {
         [key: string]: any;
     });
 }
+export declare class ListChunksRequest extends $tea.Model {
+    fields?: string[];
+    filed?: string;
+    indexId?: string;
+    pageNum?: number;
+    pageSize?: number;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class ListChunksResponseBody extends $tea.Model {
+    code?: string;
+    data?: ListChunksResponseBodyData;
+    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 ListChunksResponse extends $tea.Model {
+    headers?: {
+        [key: string]: string;
+    };
+    statusCode?: number;
+    body?: ListChunksResponseBody;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class ListIndexDocumentsRequest extends $tea.Model {
+    documentName?: string;
+    documentStatus?: string;
+    indexId?: string;
+    pageNumber?: number;
+    pageSize?: number;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class ListIndexDocumentsResponseBody extends $tea.Model {
+    code?: string;
+    data?: ListIndexDocumentsResponseBodyData;
+    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 ListIndexDocumentsResponse extends $tea.Model {
+    headers?: {
+        [key: string]: string;
+    };
+    statusCode?: number;
+    body?: ListIndexDocumentsResponseBody;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class ListIndicesRequest extends $tea.Model {
+    indexName?: string;
+    pageNumber?: string;
+    pageSize?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class ListIndicesResponseBody extends $tea.Model {
+    code?: string;
+    data?: ListIndicesResponseBodyData;
+    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 ListIndicesResponse extends $tea.Model {
+    headers?: {
+        [key: string]: string;
+    };
+    statusCode?: number;
+    body?: ListIndicesResponseBody;
+    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;
@@ -341,6 +589,69 @@ export declare class RetrieveResponse extends $tea.Model {
         [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(): {
@@ -455,6 +766,18 @@ export declare class CreateIndexResponseBodyData extends $tea.Model {
         [key: string]: any;
     });
 }
+export declare class DeleteIndexDocumentResponseBodyData extends $tea.Model {
+    deletedDocument?: 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;
@@ -504,6 +827,109 @@ export declare class GetIndexJobStatusResponseBodyData extends $tea.Model {
         [key: string]: any;
     });
 }
+export declare class ListChunksResponseBodyDataNodes 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 ListChunksResponseBodyData extends $tea.Model {
+    nodes?: ListChunksResponseBodyDataNodes[];
+    total?: number;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class ListIndexDocumentsResponseBodyDataDocuments extends $tea.Model {
+    code?: string;
+    documentType?: string;
+    id?: string;
+    message?: string;
+    name?: string;
+    size?: number;
+    sourceId?: string;
+    status?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class ListIndexDocumentsResponseBodyData extends $tea.Model {
+    documents?: ListIndexDocumentsResponseBodyDataDocuments[];
+    indexId?: string;
+    pageNumber?: number;
+    pageSize?: number;
+    totalCount?: number;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class ListIndicesResponseBodyDataIndices extends $tea.Model {
+    chunkSize?: number;
+    description?: string;
+    documentIds?: string[];
+    embeddingModelName?: string;
+    id?: string;
+    name?: string;
+    overlapSize?: number;
+    rerankMinScore?: string;
+    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 ListIndicesResponseBodyData extends $tea.Model {
+    indices?: ListIndicesResponseBodyDataIndices[];
+    pageNumber?: number;
+    pageSize?: number;
+    totalCount?: number;
+    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(): {
@@ -554,6 +980,18 @@ export declare class RetrieveResponseBodyData extends $tea.Model {
         [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;
@@ -626,6 +1064,42 @@ export default class Client extends OpenApi {
      * @return CreateIndexResponse
      */
     createIndex(WorkspaceId: string, request: CreateIndexRequest): Promise<CreateIndexResponse>;
+    /**
+     * @summary 删除Index
+     *
+     * @param request DeleteIndexRequest
+     * @param headers map
+     * @param runtime runtime options for this request RuntimeOptions
+     * @return DeleteIndexResponse
+     */
+    deleteIndexWithOptions(WorkspaceId: string, request: DeleteIndexRequest, headers: {
+        [key: string]: string;
+    }, runtime: $Util.RuntimeOptions): Promise<DeleteIndexResponse>;
+    /**
+     * @summary 删除Index
+     *
+     * @param request DeleteIndexRequest
+     * @return DeleteIndexResponse
+     */
+    deleteIndex(WorkspaceId: string, request: DeleteIndexRequest): Promise<DeleteIndexResponse>;
+    /**
+     * @summary 删除index doc
+     *
+     * @param tmpReq DeleteIndexDocumentRequest
+     * @param headers map
+     * @param runtime runtime options for this request RuntimeOptions
+     * @return DeleteIndexDocumentResponse
+     */
+    deleteIndexDocumentWithOptions(WorkspaceId: string, tmpReq: DeleteIndexDocumentRequest, headers: {
+        [key: string]: string;
+    }, runtime: $Util.RuntimeOptions): Promise<DeleteIndexDocumentResponse>;
+    /**
+     * @summary 删除index doc
+     *
+     * @param request DeleteIndexDocumentRequest
+     * @return DeleteIndexDocumentResponse
+     */
+    deleteIndexDocument(WorkspaceId: string, request: DeleteIndexDocumentRequest): Promise<DeleteIndexDocumentResponse>;
     /**
      * @summary 获取文档基本信息，包括文档名称、类型、状态等。
      *
@@ -660,6 +1134,60 @@ export default class Client extends OpenApi {
      * @return GetIndexJobStatusResponse
      */
     getIndexJobStatus(WorkspaceId: string, request: GetIndexJobStatusRequest): Promise<GetIndexJobStatusResponse>;
+    /**
+     * @summary Chunk
+     *
+     * @param request ListChunksRequest
+     * @param headers map
+     * @param runtime runtime options for this request RuntimeOptions
+     * @return ListChunksResponse
+     */
+    listChunksWithOptions(WorkspaceId: string, request: ListChunksRequest, headers: {
+        [key: string]: string;
+    }, runtime: $Util.RuntimeOptions): Promise<ListChunksResponse>;
+    /**
+     * @summary Chunk
+     *
+     * @param request ListChunksRequest
+     * @return ListChunksResponse
+     */
+    listChunks(WorkspaceId: string, request: ListChunksRequest): Promise<ListChunksResponse>;
+    /**
+     * @summary 查询Index文件
+     *
+     * @param request ListIndexDocumentsRequest
+     * @param headers map
+     * @param runtime runtime options for this request RuntimeOptions
+     * @return ListIndexDocumentsResponse
+     */
+    listIndexDocumentsWithOptions(WorkspaceId: string, request: ListIndexDocumentsRequest, headers: {
+        [key: string]: string;
+    }, runtime: $Util.RuntimeOptions): Promise<ListIndexDocumentsResponse>;
+    /**
+     * @summary 查询Index文件
+     *
+     * @param request ListIndexDocumentsRequest
+     * @return ListIndexDocumentsResponse
+     */
+    listIndexDocuments(WorkspaceId: string, request: ListIndexDocumentsRequest): Promise<ListIndexDocumentsResponse>;
+    /**
+     * @summary 查询pipeline
+     *
+     * @param request ListIndicesRequest
+     * @param headers map
+     * @param runtime runtime options for this request RuntimeOptions
+     * @return ListIndicesResponse
+     */
+    listIndicesWithOptions(WorkspaceId: string, request: ListIndicesRequest, headers: {
+        [key: string]: string;
+    }, runtime: $Util.RuntimeOptions): Promise<ListIndicesResponse>;
+    /**
+     * @summary 查询pipeline
+     *
+     * @param request ListIndicesRequest
+     * @return ListIndicesResponse
+     */
+    listIndices(WorkspaceId: string, request: ListIndicesRequest): Promise<ListIndicesResponse>;
     /**
      * @summary 召回测试
      *
@@ -678,6 +1206,24 @@ export default class Client extends OpenApi {
      * @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 提交索引任务
      *