quick start connectors

クイックスタートコネクタ

---

目次

• 目次
• 概要
  • 特徴
• はじめる
• 貢献

概要

CohereのBuild-Your-Own-Connector Frameworkを使用すると、CohereのCommand LLMをChat APIエンドポイントを介してテキスト情報を保持し、APIに対応する検索エンドポイントが露出しているデータストア/ソフトウェアに統合できます。これにより、コマンドモデルは、独自の情報に基づいたユーザークエリに応答した応答を生成できます。

このフレームワークで有効にできるユースケースのいくつかの例：

• 一般的な質問/幅広い社内企業のドキュメントに関する回答
• 内部知識の特定のサブセットで作業する知識
• 内部通信の概要と検索
• 情報の外部プロバイダーを使用した研究、研究者と作家がサードパーティからの情報を探求できるようにする

このオープンソースリポジトリには、最も人気のあるデータストアのいくつかと統合を開始できるコードが含まれています。また、任意のDataSourceを使用するために拡張できる空のテンプレートコネクタもあります。さまざまなデータストアには、良質の応答を得るために対処する必要があるさまざまな要件または制限がある場合があることに注意してください。これらの制限のいくつかに対処するためにQuickStartコードの一部が強化されていますが、他のコードは統合の基本を提供するだけであり、特定のユースケースと基礎となるデータストアの制限に合わせてさらに開発する必要があります。

コネクタフレームワークの詳細については、https：//docs.cohere.com/docs/connectorsをご覧ください

はじめる

このプロジェクトでは、Python 3.11+と詩が少なくとも必要です。各コネクタは詩を使用して、そのコネクタに固有の仮想環境を作成し、ローカルサーバーを実行するために必要なすべての依存関係をインストールします。

生産リリースの場合、オプションでDockerを使用して構築および展開できます。 Docker画像を構築するときは、Root ProjectディレクトリのDockerfileを使用して、 appビルド引数を指定できます。例えば：

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

発達

開発については、コネクタのreadmeを参照してください。一般に、 .env-templateに基づいて、そのサブディレクトリに作成する必要がある.envファイルがあります。ここでの環境変数は、APIキー、資格情報などの認証値を最も一般的に設定し、そのコネクタの検索の動作方法を変更します。

.envを構成した後、 poetryのCLIを使用してローカルサーバーを起動することができます。

事前契約

ファイルを自動的に覆すように定義された事前契約を使用することをお勧めします。 pip install pre-commitを実行できます

そして

ルートフォルダー内にpre-commit install 。ファイルをコミットする前に、あなたのファイルは自動的に糸くずになります。現在、事前コミットは黒です（24.1.1に固定）。

Cohereとの統合

このリポジトリのすべてのコネクタは、Cohereのチャット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のChat APIはコネクタを照会し、これらのドキュメントを使用して直接引用して回答を生成します。

貢献

貢献は、オープンソースコミュニティを推進するものであり、行われた貢献は大歓迎です。特定のために。開始するには、ドキュメントをご覧ください。