GitHub 連携
ドキュメントをもとに Issues と Discussions の質問に回答
概要
Asyntai の GitHub アプリは、リポジトリで寄せられる質問に回答します。誰かが Q&A カテゴリで Discussion を開くか、質問ラベル付きの Issue を作成すると、Asyntai がドキュメントを読み、回答をコメントとして投稿します。メンテナーはバグ報告とコードに時間を使えます。
ドキュメントを Asyntai に置いているプロジェクト向けです。ドキュメントサイト、README、ヘルプセンター、アップロードしたファイルなどが対象です。回答はそのコンテンツ、つまりウェブサイトのチャットと同じナレッジベースから生成されます。
仕組み
アプリは 3 つの場所で回答します。
- Discussions: Q&A など、回答を受け付けるカテゴリの新しいディスカッションすべて。
- Issues: 選んだラベルが付いた新しい Issue すべて。既定のラベルは
questionです。バグ報告と機能要望はチームに残ります。 - 追加質問: 誰でもコメントで
@asyntai-ai-agentにメンションして続きを質問できます。アプリはスレッドを記憶しているので、追加質問も文脈の中で理解されます。
すべての回答はドキュメントに基づきます。ドキュメントにない質問はメンテナー向けに開いたままになるため、アプリのコメントはどれも信頼できます。
要件
- ナレッジベースにドキュメントを登録した Asyntai アカウント。無料プランで始められます。
- アプリをインストールできる、個人アカウントまたは組織の GitHub リポジトリ。
- Discussions の場合は、回答を受け付けるカテゴリ。GitHub では Q&A カテゴリと呼びます。
インストール
次の手順でリポジトリに Asyntai を追加します。
GitHub にアプリをインストール
GitHub Marketplace で Asyntai アプリを開き、Install を押します。回答を許可するアカウントとリポジトリを選びます。リポジトリは後から GitHub の設定で変更できます。
https://github.com/apps/asyntai-ai-agent
Asyntaiアカウントを連携する
インストールが終わると GitHub から Asyntai に移動します。サインインするか無料アカウントを作成し、アプリが回答に使うナレッジベースのウェブサイトを選びます。この操作は一度だけです。
回答する場所を選ぶ
Asyntai ダッシュボードの GitHub ページで Discussions と Issues のオン・オフを切り替え、Issue を質問として扱うラベルを設定します。設定はインストール内のすべてのリポジトリに適用されます。
質問する
Q&A カテゴリでディスカッションを開くか、質問ラベル付きの Issue を作成します。回答は 1 分以内にコメントとして表示されます。返信でアプリにメンションすると追加質問ができます。
ヒント: Asyntai ダッシュボードでドキュメントサイト、README、changelog をナレッジベースに追加してください。アプリが持つドキュメントが多いほど、回答できる質問が増えます。
アプリでできること
- ドキュメントをもとに、セットアップ・設定・使い方の質問に昼夜を問わず回答
- コマンドや設定をコードブロックにした GitHub Markdown で記述
- 回答の出典となるドキュメントページへのリンク
- 追加質問のために各スレッドの文脈を保持
- 質問された言語で回答
- バグ報告、機能要望、プルリクエストはチームに任せる
権限
アプリは質問を読み回答を投稿するために Issues と Discussions の読み取り・書き込み権限、およびリポジトリのメタデータの読み取り権限を求めます。
プライバシー
Asyntai は質問の本文、リポジトリ名、質問者の GitHub ユーザー名を受け取ります。回答したスレッドは、ウェブサイトのチャットと同様に Asyntai ダッシュボードに会話として保存されます。
プランと料金
GitHub 連携は無料プランを含むすべての Asyntai プランで利用できます。回答 1 件は月間メッセージ枠の 1 件として数えられ、枠はすべてのチャネルと連携で共有されます。 料金を見る.
アンインストール
GitHub の設定を開き、Applications、Installed GitHub Apps の順に進んで Asyntai をアンインストールします。アプリはすぐに回答を停止します。Asyntai ダッシュボードの GitHub ページで「切断」を押すこともできます。
お困りですか?
ご質問や問題がございましたら、[email protected]までお問い合わせください。