Cohere Toolkit

Toolkit 是一个可部署的一站式 RAG（检索增强生成）应用程序，使用户能够快速构建基于 LLM（大语言模型）的产品。

• 试用 Toolkit
• 关于 Toolkit
• Toolkit 设置
• 故障排除
• 操作指南
  • 如何设置 Command 模型提供商
  • 如何添加工具
  • 如何为工具添加认证
  • 如何设置 Google Drive
  • 如何设置 Gmail
  • 如何设置 Slack 工具
  • 如何设置 Github 工具
  • 如何设置 Sharepoint
  • 如何设置 Google Text-to-Speech
  • 如何添加身份验证
  • 如何部署 Toolkit 服务
  • 如何使用 VSCode/PyCharm 调试 Docker 化的 Toolkit API
  • 如何设置 Github Actions 进行自动化数据库迁移
  • 如何自定义主题
  • 如何贡献
• 试用 Cohere 的 Command Showcase

立即试用：

快速运行 Toolkit 主要有两种方式：本地运行和云端运行。请参阅下面给出的具体说明。

本地运行

你需要安装 Docker、Docker-compose >= 2.22 和 Poetry。点击此处查看更详细的设置。 注意：要在本地构建时包含社区工具，请将 docker-compose.yml 中的 INSTALL_COMMUNITY_DEPS 构建参数（build arg）设置为 true。

两种方式都将在 http://localhost:4000 提供前端服务。

使用 make

使用提供的 Makefile 可以简化和自动化 Cohere Toolkit 的开发工作流程，包括 Docker Compose 管理、测试、代码检查（linting）和环境设置。

git clone https://github.com/cohere-ai/cohere-toolkit.git
cd cohere-toolkit
make first-run

仅使用 Docker Compose

如果你希望在没有 Makefile 提供的额外自动化的情况下快速启动并管理容器环境，可以直接使用 Docker Compose。

git clone https://github.com/cohere-ai/cohere-toolkit.git
cd cohere-toolkit
docker compose up
docker compose run --build backend alembic -c src/backend/alembic.ini upgrade head

云端运行

GitHub Codespaces

要使用 GitHub Codespaces 运行此项目，请参阅我们的 Codespaces 设置指南。

关于 Toolkit

• Interfaces（界面） - 任何客户端 UI，目前包含两个 Web 应用程序（一个是 Agentic 应用，一个是基础应用）和一个 Slack 机器人实现。
  • 默认为 Cohere 的 Web UI，位于 src/interfaces/assistants_web - 一个使用 Next.js 构建的 Web 应用。开箱即用，包含一个简单的 SQL 数据库，用于在应用中存储对话历史。
  • 你可以使用 docker compose 文件更改 Web UI。
• Backend API（后端 API） - 位于 src/backend，遵循与 Cohere Chat API 类似的结构，但也包含可自定义的元素：
  • Model（模型） - 你可以自定义访问 Cohere Command 模型的提供商。Toolkit 默认包含 Cohere Platform、Sagemaker、Azure、Bedrock、HuggingFace 和本地模型。更多详情请点击此处。
  • Retrieval（检索） - 你可以自定义应用程序运行时所使用的工具和数据源。
• Service Deployment Guides（服务部署指南） - 我们还提供了如何在生产环境中部署 Toolkit 服务的指南，包括 AWS、GCP 和 Azure。更多详情请点击此处。

贡献

贡献是推动开源社区发展的动力，我们非常感谢任何形式的贡献。如需开始，请查看我们的文档。

贡献者

由 contrib.rocks 制作。

Cohere Toolkit 快速上手指南

Cohere Toolkit 是一个可部署的一体化 RAG（检索增强生成）应用程序，旨在帮助开发者快速构建基于 LLM 的产品。

1. 环境准备

在开始之前，请确保您的本地环境已安装以下依赖：

• Docker：下载地址
• Docker-compose：版本需 >= 2.22，安装指南
• Poetry：Python 依赖管理工具，安装指南

2. 安装步骤

您可以选择使用自动化脚本或手动通过 Docker Compose 启动项目。

方法一：使用 Makefile（推荐）

此方法通过提供的 Makefile 自动化处理 Docker Compose 管理、环境设置等工作流。

git clone https://github.com/cohere-ai/cohere-toolkit.git
cd cohere-toolkit
make first-run

方法二：使用 Docker Compose

如果您希望手动控制容器的启动和数据库迁移，请执行以下命令：

git clone https://github.com/cohere-ai/cohere-toolkit.git
cd cohere-toolkit
docker compose up
docker compose run --build backend alembic -c src/backend/alembic.ini upgrade head

注意：若需在本地构建时包含社区工具，请在 docker-compose.yml 文件中将 INSTALL_COMMUNITY_DEPS 构建参数设置为 true。

3. 基本使用

服务启动成功后，工具包将在本地运行前端界面。

• 访问地址：http://localhost:4000

该界面默认使用 Cohere 的 Web UI（基于 Next.js 构建），内置 SQL 数据库用于存储对话历史，并已集成 Cohere Command 模型。您可以直接在网页上进行对话交互和 RAG 功能测试。