Copilot knowledge bases とは
Copilot knowledge bases は GitHub Copilot Enterprise を利用している時に使える機能です。
Copilot knowledge bases に GitHub 外で管理しているドキュメントなどを渡すことができ、GitHub Copilot Chat の回答の一部として利用することができます。
Copilot knowledge bases を設定する
上記にも記載したとおり、 Copilot knowledge bases は GitHub Copilot Enterprise 有効にしている Enterprise アカウント傘下の Organization で有効にすることができます。
設定までのおおまかな流れは以下の通りです。
- Copilot knowledge bases に登録する Repository の準備
- Copilot knowledge bases に Repository を登録
Copilot knowledge bases に登録する Repository の準備
Copilot knowledge bases が参照できるファイル拡張子は、.md
, .mdx
のみです。
読み込みさせたいファイルが Markdown 以外だった場合はファイルを変換するなど対応をしてください。
今回は Notion に登録されているページを読み込ませることにしました。Notion のデータは Export 方法は下記リンクに記載されています。
Notion のデータ Export フォーマットは PDF, HTML, Markdo から選択できます。
Copilot knowledge bases は Markdown 以外読み込むことができないので Madkwon を選択します。また、サブページを含めるオプションを有効にすることを忘れないようにしてください。
Export 処理開始後 (ページ数にもよりますが) 数時間で Export が完了します。
Export した Zip ファイルを展開すると Markdown (.md
) ファイルと CSVファイル .csv
が含まれています。Repository に不要なファイルを含めると commit や push に時間がかかるので 不要なファイルは削除することをおすすめします。
Copilot knowledge bases に Repository を登録
knowledge bases の登録は Organizations 設定ページから実施します。
Settings > Copilot > Knowledge の順に進むと設定ページが存在します。
1 knowledge bases に 複数の contents (repository) を紐づけることができます。
Copilot Chat から Knowledge bases を参照しやすい単位に分割すると良いと思っています。 (そこまで検証できていません...)
Knowledge bases に登録してから Copilot Chat で使えるようになるまで1時間ほどかかりました。
さいごに
実際に GitHub Copilot Chat で利用している画面はお見せできませんが、 Knowledge bases 内のデータを元に回答が行われていました。
また、回答を生成したデータソースを表示させる機能もあり生成されたドキュメントの内容を深く知るという使い方もできそうでした。
References