@re-ai/volc-knowledge/dist/interface/slice.d.ts

火山引擎知识库接口接入SDK

/**
 * 切片相关接口定义
 */
export interface ISliceAPI {
    /**
     * 列出切片
     * @param documentId 文档ID
     * @param params 查询参数
     */
    list(documentId: string, params?: Record<string, any>): Promise<any>;
    /**
     * 更新切片
     * @param sliceId 切片ID
     * @param updateData 更新数据
     */
    update(sliceId: string, updateData: Record<string, any>): Promise<any>;
    /**
     * 获取切片信息
     * @param sliceId 切片ID
     */
    info(sliceId: string): Promise<any>;
    /**
     * 添加切片
     * @param documentId 文档ID
     * @param sliceData 切片数据
     */
    add(documentId: string, sliceData: Record<string, any>): Promise<any>;
    /**
     * 删除切片
     * @param sliceId 切片ID
     */
    delete(sliceId: string): Promise<any>;
    /**
     * 重排切片
     * @param sliceIds 切片ID列表
     * @param options 重排选项
     */
    rerank(sliceIds: Array<string>, options?: Record<string, any>): Promise<any>;
}