docsbot 0.1.2

A simple chat bot for querying information from your local private documents.

DocsBot 使用说明

DocsBot 是一个命令行工具，提供了方便的方式来管理和查询你的资料库。

命令和参数

以下是 DocsBot 支持的命令及其参数：

addbase

这个命令用于添加一个新的资料库。

$ docsbot addbase <dir>

<dir>: 要添加的资料库的目录路径。

listbase

这个命令用于列出所有已添加的资料库。

$ docsbot listbase

deletebase

这个命令用于删除一个已添加的资料库。

$ docsbot deletebase <baseid>

<baseid>: 要删除的资料库的ID。

query

这个命令用于查询一个资料库。

docsbot query <baseid> <query>

: 要查询的资料库的ID。 : 查询字符串。

注意：在所有命令中，都应该替换为真实的资料库ID，

应该替换为真实的目录路径，应该替换为你的查询字符串。

配置项

DocsBot Home目录

docsbot 默认使用目录 $HOME/.docsbot来存储自己的配置信息、资料库的元信息与索引数据等。

docsbot.env  -- 配置文件
base_data.json -- 资料库的元信息，比如ID、目录、文件数
vectors -- 对资料库Embedding后的向量索引数据

配置文件 docsbot.env

第一次运行时，请根据提示设置OpenAI的Key，docsbot自动保存到配置文件 $HOME/.docsbot/docsbot.env中。

OpenAI_KEY=xxxxxxxxx

其他配置项：

VECTOR_STORE_TYPE="Chroma"  # 索引类型，目前支持Chroma、QDRANT
QDRANT_SERVER_URL="http://192.168.1.22:6333"