ragtime下载 - ragtime源代码下载

ragtime

Ai源码

1.0.0

下载

拉格时间

使用Vectara的开源RAG机器人，用于松弛和不和谐。使用此机器人，您可以创建连接到服务器的Slack或Discord Bot，并通过查询Vectara语料库来回答用户问题。

用法

在消息中提及机器人以接收答复。
将直接消息发送到机器人以进行1：1对话。
该机器人存储消息和线程ID，以在线程或回复时提供上下文感知的答复。

示例命令

@bot-name Your message here
Your message here

安装

先决条件

Python 3.8或更高

设置

克隆存储库：

git clone https://github.com/vectara/ragtime.git
cd ragtime

安装所需的依赖项：
```
 pip3 install requirement.txt
```

设置环境变量：

在项目的根部创建.env文件，并添加以下内容：

 SLACK_BOT_TOKEN=<OAuth level token>
SLACK_APP_TOKEN=<APP level token>
DISCORD_BOT_TOKEN=<Discord bot token>
VECTARA_CUSTOMER_ID="<VECTARA_CUSTOMER_ID>"
VECTARA_CORPUS_IDS="<VECTARA_CORPUS_IDS>"
VECTARA_API_KEY="<VECTARA_API_KEY>"
ACCOUNT_SID=<Twilio account SID>
Auth_TOKEN=<Twilio auth token>
TWILIO_WHATSAPP_NUMBER=<Whatsapp number configured in twilio>

要启用Agentic抹布添加以下变量。

 ENABLE_AGENTIC_RAG=True ## To enable agentic rag. By default ragtime uses vanilla RAG.
AGENTIC_RAG_DATA_DESCRIPTION='Vectara website, docs and forum data'
AGENTIC_RAG_ASSISTANT_SPECIALTY='Vectara'
AGENTIC_RAG_TOOL_NAME='ask_vectara'

VECTARA_CUSTOMER_ID和VECTARA_CORPUS_IDS指向您使用的Vectara帐户和相关语料库。
VECTARA_CORPUS_IDS可以是单个语料库ID（数字）或逗号分隔的语料库列表。

运行ragtime bot

Ragtime支持Slack Bot，Discord Bot和WhatsApp Bot。您可以运行其中之一，也可以运行全部。

如何在本地运行

运行两个机器人
```
python3 main.py
```
仅运行Slack Bot
```
python3 main.py slack
```
仅运行Discord Bot
```
python3 main.py discord
```
仅运行whatsapp bot
```
python3 main.py whatsapp
```

使用Docker运行应用程序

使用Docker构建和运行。

运行两个机器人
```
bash run_docker.sh
```
仅运行Slack Bot
```
bash run_docker.sh slack
```
仅运行Discord Bot
```
bash run_docker.sh discord
```
仅运行whatsapp bot
```
bash run_docker.sh whatsapp
```

创建Slack Bot的步骤

在Orer中，将您的Ragtime Bot连接到Slack Service，请执行以下步骤：

登录您的Slack工作区，并导航到Slack API网站。单击“您的应用程序”，然后单击“创建新应用程序”。提供应用程序的名称，选择要安装它的工作区，然后单击“创建应用程序”。
在应用程序设置中，您可以配置各种详细信息，例如应用程序名称，图标和描述。确保准确填写必要的信息。
配置应用程序后，请导航到“安装应用程序”部分。单击“安装应用程序到工作区”按钮，将机器人添加到您的Slack工作区中。此步骤将生成一个OAuth访问令牌，您需要使用该代币来验证您的机器人。
要添加用户令牌范围，请导航到应用程序设置中的“ OAuth＆Permissions”部分。在“工作空间的OAuth令牌”部分下，您需要添加app_mentions:read ， channels:history ， chat:write ， chat:write.public ， groups:history历史， im:history历史记录，IM：历史记录，MPIM：历史记录，MPIM mpim:history ， mpim:read ， mpim:write ，用户， users:read范围。创建令牌并将其保存为.env文件中的SLACK_BOT_TOKEN 。
使用connection:write范围。在.env文件中，将此令牌保存为SLACK_APP_TOKEN 。
确保保存您对应用程序设置进行的任何更改，并安装/重新安装机器人到工作场所。