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

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

/**
 * 文档相关接口定义
 */
export interface IDocumentAPI {
    /**
     * 添加文档
     * @param knowledgeId 知识库ID
     * @param document 文档数据
     */
    add(knowledgeId: string, document: Record<string, any>): Promise<any>;
    /**
     * 获取文档信息
     * @param documentId 文档ID
     */
    info(documentId: string): Promise<any>;
    /**
     * 列出文档
     * @param knowledgeId 知识库ID
     * @param params 查询参数
     */
    list(knowledgeId: string, params?: Record<string, any>): Promise<any>;
    /**
     * 更新文档元数据
     * @param documentId 文档ID
     * @param metaData 元数据
     */
    updateMeta(documentId: string, metaData: Record<string, any>): Promise<any>;
    /**
     * 删除文档
     * @param documentId 文档ID
     */
    delete(documentId: string): Promise<any>;
}