[DOC] API 文档 / 在 Wiki 内新增 API 文档

[BertieGo]

使用阿里云 PAI 的 DSW 和 AutoDL 来部署 Chatchat 都访问不了 API 文档，各种资源访问报错😭，可以直接把 API 文档放在 Wiki 里面吗？谢谢

[dosubot[bot]]

🤖

嘿，@BertieGo！很高兴再次见到你。遇到问题我们一起解决。

非常抱歉听到您在访问 API 文档时遇到了问题。我完全理解您的困扰，将 API 文档直接放在 Wiki 中确实可以方便用户直接查阅。

目前，Langchain-Chatchat 的 API 文档是按照以下结构组织的：

1. 聊天 API：

   • /chat/chat：通过 LLMChain 与 LLM 模型交互。
   • /chat/search_engine_chat：与搜索引擎交互。
   • /chat/feedback：返回 LLM 模型对话得分。
   • /chat/knowledge_base_chat：与知识库交互。
   • /chat/file_chat：文件对话。
   • /chat/agent_chat：与代理交互。

2. LLM 模型管理 API：

   • /llm_model/list_running_models：列出当前已加载的模型。
   • /llm_model/list_config_models：列出在配置中的模型。
   • /llm_model/get_model_config：获取模型配置（合并）。
   • /llm_model/stop：停止指定的 LLM 模型（模型工作器）。
   • /llm_model/change：切换指定的 LLM 模型（模型工作器）。

3. 服务器状态 API：

   • /server/configs：获取原始服务器配置信息。
   • /server/list_search_engines：获取服务器支持的搜索引擎。
   • /server/get_prompt_template：获取服务器配置的提示模板。

4. 其他 API：

   • /other/completion：请求 LLM 模型完成（通过 LLMChain）。
   • /other/embed_texts：向量化文本，支持本地模型和在线模型。

5. 知识库管理 API：

   • /knowledge_base/list_knowledge_bases：获取知识库列表。
   • /knowledge_base/create_knowledge_base：创建知识库。
   • /knowledge_base/delete_knowledge_base：删除知识库。
   • /knowledge_base/list_files：获取知识库中的文件列表。
   • /knowledge_base/search_docs：搜索知识库。
   • /knowledge_base/update_docs_by_id：直接更新知识库文档。
   • /knowledge_base/upload_docs：上传文件到知识库并/或向量化。
   • /knowledge_base/delete_docs：删除知识库中的指定文件。
   • /knowledge_base/update_info：更新知识库介绍。
   • /knowledge_base/update_docs：更新现有文件到知识库。
   • /knowledge_base/download_doc：下载对应的知识文件。
   • /knowledge_base/recreate_vector_store：基于内容文档重建向量库，并流式处理进度。
   • /knowledge_base/upload_temp_docs：上传文件到临时目录进行文件对话。

6. 知识库摘要 API：

   • /knowledge_base/kb_summary_api/summary_file_to_vector_store：基于文件名摘要的单个知识库。
   • /knowledge_base/kb_summary_api/summary_doc_ids_to_vector_store：基于 doc_ids 摘要的单个知识库。
   • /knowledge_base/kb_summary_api/recreate_summary_vector_store：重建单个知识库文件摘要。

我建议您可以将这些信息复制并添加到 Wiki 中，以便于您和其他用户在访问 API 文档时更加方便。如果您需要进一步的帮助，或者有其他问题，欢迎随时向我提问。

Sources

• server/api.py

About Dosu

This response is meant to be useful and save you time. It is not meant to be a precise solution, but rather a starting point for your own research.

Help me be more useful! Please leave a 👍 if this is helpful and 👎 if it is irrelevant.

If you want to continue the conversation, start your reply with @dosu-bot.

[BertieGo]

/chat/knowledge_base_chat 接口具体要传递什么参数？

[zRzRzRzRzRzRzR]

建议源代码安装，autodl那个有bug，源码已经修复了