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會查詢連接器，並使用這些文檔直接引用生成答案。

貢獻

貢獻是推動開源社區的貢獻，對所做的任何貢獻都非常感謝。針對特定。要開始，請查看我們的文檔。