【创新实训】AnythingLLM 接口调用（以Python为例）

AnythingLLM 接口调用

AnythingLLM 是一个开源平台，可以将文档、资源和笔记转化为一个智能的、可交互的知识库，就像拥有一个私有化的大模型。同时，AnythingLLM 提供了一套强大的 API，让开发者能够将其核心问答和管理功能集成到自己的应用程序中。

前提准备

1. 一个安装并成功运行的 AnythingLLM 实例；
2. 由于我的实例运行在服务器上，所以我需要使用服务器对应的地址和端口号进行访问；
3. 对于HTTP请求需要十分了解，尤其得熟悉GET和POST请求，以及Headers、Body、JSON数据格式等；
4. 编程环境，我将使用Python进行访问，此外需要安装requests库等依赖库。

一、找到访问AnythingLLM的访问方式

• 由于 AnythingLLM 内置了 Swagger UI来展示其API 文档，我们可以通过访问http://xxx.xxx.xxx.xxx:xxxx/api/docs来查看 AnythingLLM Developer API 文档。
• 文档中列出了所有可用的API端点、每个端点所需的参数、请求体格式、响应格式等。
  • HTTP请求方法：GET、POST、PUT等。
  • 路径：每个API 的具体地址，包含一些参数，比如{slug}和{docName}等。
  • Parameters：需要传入的参数。
  • Request Body：比如对于POST请求，描述需要发送的JSON数据的结构。
  • Response：描述成功或失败时的响应，包括返回的数据结构等。

如图：

• 我们需要使用大模型的问答功能，因此找到Workspaces，使用其中的/v1/workspace/{slug}/chats和/v1/workspace/{slug}/stream-chats是进行问答的窗口。
  • {slug}处用于选择工作区，将想要使用的工作区名称（标识符）填入即可
  • 可以使用GET或POST请求

二、获取 API Key

为了保护 AnythingLLM 实例不被随意访问，因此要使用 API密钥进行验证身份。

• 在设置中打开工具->API 密钥，并点击生成新的API密钥创建一个新的密钥：

• 获得了一个新密钥后，复制密钥的内容，用于填充步骤一中访问大模型问答功