@re-ai/volc-knowledge

@re-ai/volc-knowledge

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

安装

npm install @re-ai/volc-knowledge

功能特性

• 知识库管理（创建/更新/删除/查询/检索/聊天）
• 文档管理（添加/更新/删除/查询/元数据更新）
• 切片管理（添加/更新/删除/查询/重排）
• 重排功能（基于模型的搜索结果优化）

快速开始

import { ReAIVolcKnowledge } from '@re-ai/volc-knowledge';

// 知识库API示例
const knowledgeInfo = await ReAIVolcKnowledge.doRequest({
  endpoint: '/knowledge/info',
  method: 'POST',
  body: {
    name: 'your-knowledge-name'
  }
});

// 文档API示例
const docList = await ReAIVolcKnowledge.doRequest({
  endpoint: '/document/list',
  method: 'POST',
  body: {
    knowledgeId: 'knowledge-id',
    page: 1,
    pageSize: 10
  }
});

// 切片API示例
const updatedSlice = await ReAIVolcKnowledge.doRequest({
  endpoint: '/slice/update',
  method: 'POST',
  body: {
    sliceId: 'slice-id',
    content: 'updated content'
  }
});

// 重排API示例
const rerankedResults = await ReAIVolcKnowledge.doRequest({
  endpoint: '/rerank',
  method: 'POST',
  body: {
    query: 'search query',
    documents: [
      { content: 'document 1 content' },
      { content: 'document 2 content' }
    ]
  }
});

参考文档

• API列表
• 知识库功能说明
• 最佳实践

开发

# 安装依赖
npm install

# 构建
npm run build

# 运行测试
npm test

贡献

欢迎提交Pull Request。请确保遵循以下规范：

• 代码风格符合项目规范
• 提交信息遵循Conventional Commits
• 新增功能需包含单元测试

许可证

MIT