For the complete documentation index, see llms.txt. This page is also available as Markdown.

AIアシスタント

AIアシスタントは、ドキュメントだけでなく、知識ベース全体から得た正確で文脈に沿った回答をユーザーに提供します

GitBook Assistant
GitBook Assistant

AI Assistant は、自然言語を使用してドキュメントに関する迅速で正確な回答をユーザーに提供します。ユーザーに合わせてパーソナライズされ、Web サイトや製品に埋め込むことができ、公開済みドキュメントのサイドバーまたは検索ボックスに表示できます。

ユーザーが最も必要とする場所とタイミングで、すべてのユーザーが利用できる製品エキスパートだと考えてください。

Assistant はエージェント型検索を使用し、ユーザーの現在のページ、以前に読んだページ、過去の会話に基づいてクエリのコンテキストを理解します。

以下のボックスで Assistant に質問してみてください:

GitBook Assistant

AI Assistant を設定する

AI Assistant を設定するには、 カスタマイズツール をサイトのサイドバーで開き、】【t_577c0d39】. Here you can enable the Assistant and customize its instructions, welcome message, and suggested questions. AIアシスタントをクリックします。ここで Assistant を有効にし、指示、ウェルカムメッセージ、候補の質問をカスタマイズできます。

カスタム指示を追加する

カスタム指示では Assistant の口調を調整し、製品固有の知識や用語を追加できます。これにより、回答を一貫して全体的なスタイルに合わせられます。

カスタム指示は Assistant の口調と知識を洗練します。組み込みのガードレールを上書きすることはできません。

ウェルカムメッセージをカスタマイズする

ウェルカムメッセージは、進行中の会話がない状態で訪問者が Assistant を開いたときに最初に表示されるものです。期待値を設定したり、ユーザーを特定のワークフローへ案内したりするために使用してください。

候補の質問を追加する

候補の質問は、進行中の会話がない状態で Assistant を開いたときに表示される、あらかじめ用意されたプロンプトです。ユーザーが質問できる内容を理解するのに役立ち、有用な回答やワークフローへユーザーを案内することにも役立ちます。

候補の質問に関するベストプラクティス:

  • 実際のユーザーの目標(セットアップ、トラブルシューティング、統合)から始めます。

  • ユーザーが使う言葉を使用します(社内コードネームは避けます)。

  • 具体的にします。「~について教えて」よりも「どうすれば~できますか?」の方が効果的です。

  • クイックスタート、ハウツー、トラブルシューティング、リファレンスなど、さまざまな目的をカバーします。

Assistant を製品に埋め込む場合は、埋め込み設定で候補を動的に設定することもできます。 埋め込みのカスタマイズ.

Assistant の表示場所を選択する

次の項目の下で 外観で、 配置 を設定して、読者が Assistant を利用する場所を選択します:

  • サイドバー (デフォルト)— 完全なチャット体験。Ultimate サイトプランで利用可能

  • 検索ボックス — キーワード検索結果とともに表示されるインライン回答。Premium および Ultimate サイトプランで利用可能

Assistant のあいさつはサイドバー配置にのみ適用されるため、 配置 が次に設定されている間は非表示になります 検索ボックス.

公開済みドキュメントで AI Assistant を使用する

読者が Assistant を利用する方法は、その配置によって異なります。

サイドバー配置

ユーザーは 3 つの方法で GitBook Assistant にアクセスできます:

  • 押します + I Macではまたは Ctrl + I PC の場合

  • をクリックするか、 GitBook Assistant の横にあるボタン 質問または検索… バー

  • 質問を 質問または検索… バーに入力し、メニュー上部の「質問する…」オプションを選択します

検索ボックス配置

配置 に設定されている場合、 検索ボックス、ユーザーは 質問または検索… バーで、キーワード結果とともに直接質問できます。

直接クリックするか、 + K を Mac で、または Ctrl + K を PC で押すことで開けます。

要約された回答に加えて、その下には Assistant が回答の作成に使用したソースを表示する展開可能なセクションと、フォローアップとしてクリックできる関連質問も表示されます。

Assistant は、ドキュメントサイトのコンテンツと、 接続.

公開済みドキュメントを検索する

キーワード検索は、Assistant がオンかどうかにかかわらず、すべてのサイトで自動的に有効になります。

ユーザーはドキュメントサイト内でキーワードを検索し、サイト全体の特定のページやページセクションにすばやく移動できます。

AI Assistant を製品に埋め込む

GitBook Assistant を製品や Web サイトに直接埋め込むことで、ユーザーはアプリケーションを離れることなく AI を活用したヘルプにすぐアクセスできます。Assistant は、 Docs Embedの一部として埋め込むことができます。これには、AI を活用したチャット用の Assistant タブ、範囲を絞った検索用の Search タブ、ドキュメントを閲覧するための Docs タブが含まれます。

使用しているスタックに適した埋め込み方法を選択してください:

Assistant の埋め込みに関する追加ガイド:

AI Assistant の知識を拡張する

AI Assistant は、以下を通じて外部知識を利用できます: 接続MCP サーバー.

GitBook でレコードをサイトに同期する場合は接続を使用し、AI Assistant をカスタムツールに接続する場合は MCP サーバーを使用できます。

接続

最適な用途

接続は、コンテンツ量の多いソースに最適です:

  • GitHub の Issue とディスカッション

  • Slack または Discord の会話

  • サポートコンテンツ

  • 外部ドキュメント、ヘルプセンター、Web サイト

MCP サーバー

最適な用途

MCP サーバーは、ライブツールとデータに最適です:

  • 現在のアカウントまたは製品の状態

  • 頻繁に変更される内部システム

  • チケット作成やバグ報告などのアクション

  • GitBook に同期したくないソース

1

サイトの設定を開く

サイトのダッシュボードを開きます。次に、 設定接続.

2

ソースを接続する

ソースタイプを選択します。次に認証するか、インポートする URL を入力します。

3

レコードを AI Assistant に公開する

をオンにします 検索 / Assistant に公開 (接続用)。

GitBook は、その後これらのレコードを検索と AI Assistant で使用できます。

1

サイトの設定を開く

サイトのダッシュボードを開きます。次に、 設定AI と MCP.

2

新しいサーバーを追加する

MCP サーバーのテーブルで、 MCP サーバーを追加.

3

サーバーの詳細を入力する

サーバーに名前を付けます。URL を追加します。

次に、GitBook が各リクエストで送信する必要がある HTTP ヘッダーを設定します。

最終更新

役に立ちましたか?