quick start connectors

快速启动连接器

---

目录

• 目录
• 概述
  • 特征
• 入门
• 贡献

概述

Cohere的Build-Your-and-connector框架使您可以通过聊天API端点将Cohere的命令LLM集成到保存文本信息并在其API中展示的相应搜索端点的任何数据存储/软件。这允许命令模型生成对以专有信息为基础的用户查询的响应。

您可以使用此框架启用的用例的一些示例：

• 围绕广泛内部公司文档的通用问题/回答
• 知识与特定的内部知识子集合
• 内部通讯摘要和搜索
• 使用外部信息提供者的研究，使研究人员和作家可以探索来自第三方的信息

该开源存储库包含代码，使您可以开始与一些最受欢迎的数据库集成。还有一个空模板连接器，您可以扩展使用任何数据源。请注意，不同的数据存储可能需要解决不同的要求或限制，以便获得高质量的响应。尽管已经增强了一些快速启动代码以解决其中一些限制，但其他一些仅提供集成的基础，您将需要进一步开发它们以适合您的特定用例和基础数据存储限制。

请在此处阅读有关我们的连接器框架的更多信息：https：//docs.cohere.com/docs/connectors

入门

该项目需要最少的Python 3.11+和诗歌。每个连接器都使用诗歌创建特定于该连接器的虚拟环境，并安装所有所需的依赖项以运行本地服务器。

对于生产发布，您可以选择使用Docker构建和部署。构建Docker映像时，您可以在root Project目录中使用Dockerfile并指定app构建参数。例如：

docker build . -t gdrive:1 --build-arg app=gdrive

发展

为了开发，请参阅连接器的读数。通常，基于.env-template的该子目录中需要创建一个.env文件。这里最常见的环境变量设置了授权值，例如API键，凭据，还修改了对连接器的搜索方式。

配置.env后，您将能够使用poetry的CLI来启动本地服务器。

预先承诺

建议使用定义的预订，该预定将自动填充您的文件。您可以运行pip install pre-commit

和

在根文件夹中pre-commit install 。现在，您在提交文件之前将自动凸起。目前，预先承诺将运行黑色（固定为24.1.1）。

与cohere集成

该存储库中的所有连接器均已量身定制，以与Cohere的Chat API集成，以使创建一个接地的聊天机器人快速简便。

Cohere的API要求连接器返回文档作为JSON对象的数组。每个文档应是一个具有字符串键和字符串值的对象，其中包含有关文档的所有相关信息（例如title ， url等）。为了获得最佳结果，最大的文本内容应存储在text键中。

例如，返回有关公司支出策略的文档的连接器可能会返回以下内容：

[
  {
    "title" : " Company Travel Policy " ,
    "text" : " Flights, Hotels and Meals can be expensed using this new tool... " ,
    "url" : " https://drive.google.com/file/d/id1 " ,
    "created_at" : " 2023-11-25T20:09:31Z "
  },
  {
    "title" : " 2024 Expenses Policy " ,
    "text" : " The list of recommended hotels are... " ,
    "url" : " https://drive.google.com/file/d/id2 " ,
    "created_at" : " 2023-12-04T16:52:12Z "
  }
]

Cohere的聊天API会查询连接器，并使用这些文档直接引用生成答案。

贡献

贡献是推动开源社区的贡献，对所做的任何贡献都非常感谢。针对特定。要开始，请查看我们的文档。