跳转到主要内容
本教程将详细介绍如何使用 XperAI 平台的知识库 API 来创建知识库、上传文件并处理文档。
参考代码 XpertAI SDK 示例

准备工作

在开始调用 API 前,您需要准备以下凭证和信息,你可以在环境变量文件中配置(XPERTAI_API_URL 与 XPERTAI_API_KEY):

如何获取这些凭证

  1. API_URL 和 API_KEY
    • 登录 XperAI 平台数字专家或者知识库
    • 进入「设置」->「API 密钥」页面
    • 生成或复制您的 API 密钥
    • API 基础地址通常是 https://api.xpertai.cn/api/ai/
  2. 工作空间 ID
    • 在 XperAI 控制台中,进入您的工作空间
    • 在浏览器地址栏中可以找到工作空间 ID
    • 格式通常为 UUID(如:23f2b2ff-9318-43b6-a986-928fcf70d4ea
  3. 智能助理 ID
    • 在 XperAI 设置页面中,进入「AI 智能助理」页面
    • 选择您要关联的智能助理
    • 在智能助理提供商图标上可以找到 ID
    • 格式通常为 UUID(如:9ff28c7c-3e63-4ced-b855-2782d79a21b3
  4. 知识库系统集成 ID(可选,仅外部知识库需要)
    • 如果您使用外部知识库集成,需要在集成设置中查找此 ID

安装必要的依赖

API 调用步骤

1. 创建知识库

首先,我们需要创建一个知识库容器:

2. 上传文件

将本地文件上传到 XperAI 平台:

3. 创建文档关联

将上传的文件创建为知识库的文档:

4. 开始嵌入处理

启动文档的向量化处理:

5. 检查处理状态

查询文档处理进度:

完整使用示例

注意事项

  1. 请确保所有 ID 参数都使用从 XperAI 平台获取的正确值
  2. API 密钥需要妥善保管,不要泄露或提交到版本控制系统
  3. 文件上传有大小限制,请参考官方文档了解具体限制
  4. 文档处理时间取决于文件大小和内容复杂度
  5. 建议添加适当的错误处理和重试机制以提高可靠性
通过以上步骤,您可以成功创建知识库、上传文档并完成向量化处理,为后续的智能问答和检索功能做好准备。