For AI agents: a documentation index is available at /docs/llms.txt. Append .md to any page URL for markdown, or send Accept: text/markdown.
AI アシスタントを設定する
AmplitudeでAIアシスタントを有効にしたり、コンテンツソースを接続したり、カスタム回答を作成したり、フォールバックとコミュニケーションスタイルを設定したり、ワークフローとツールを構築したり、ウィジェットをスタイル設定したりすることで、AIアシスタントとリソースセンターを構成できます。 Amplitudeの管理者とビルダーがこの設定を処理します。
AI アシスタントを有効にし、表示場所を選択する
通常、構成には次のような作業が含まれます。
組織で AI アシスタントを有効にします。
組織とプロジェクトで AI アシスタントを有効にしていることを確認してください。 これには以下のものが含まれます:
- AmplitudeプランにAI アシスタントが含まれていること。
- _AI アシスタント > 設定 > AI アシスタント_で、AI アシスタントを有効にします。
ウィジェットランチャーを設定します。
アシスタンス / AI アシスタント または リソースセンター の設定エリアから:
- 事前構築済みのランチャー、カスタム要素、またはカスタムコードを選択して、ランチャーの表示場所を決定します。 たとえば、すべてのページの右下に表示したり、特定の画面上だけに表示したりできます。
- 以下に基づいてターゲティングロジックを指定します。
- ユーザープロパティ(役割やプランなど)。
- Amplitudeで定義されたコホート。
- URLまたはルートルール。
有効にするサーフェスを選択します。
ウィジェットの設定で:
- **チャット(AI アシスタント)**をオンまたはオフにします。
- リソースセンターをオンまたはオフにします。
- ウィジェットを開いたときにユーザーがデフォルトでチャットにアクセスするかリソースセンターにアクセスするかを決定します。
組織がAmplitudeトラフィックをリバースプロキシしている場合や、ネットワーク上のAmplitudeドメインをブロックしている場合は、AI Assistant用のプロキシ設定を作成する必要があります。 チャットリクエストは、ガイドとサーベイの API のほかの部分とは異なるホストに送信されます。ガイドとサーベイをカバーするプロキシは、アシスタントをカバーしません。ガイドとサーベイへのプロキシリクエストに移動します。
コンテンツソースを接続
AIアシスタントの機能は、あなたが提供するコンテンツによって異なります。そのコンテンツは、[コンテンツとソース] およびリソースセンターを通じて管理できます。
コンテンツソースを追加する
ソースの例を次に示します。
- 公開ドキュメントまたはヘルプセンター。
- 内部知識ベース。
- プロダクトマーケティングページ。
- ハウツーコンテンツを含むブログです。
ソースを接続するには:
- AI Assistant > コンテンツ > Sources に移動します。
- **「ソースを追加」**をクリックし、種類を選択します(「ヘルプセンター」、「Web」、「ドキュメントサイト」など)。
- ベース URL、必要に応じて資格情報、サイトマップなど、必要な詳細情報を入力してください。
- 同期頻度を設定します(自動またはオンデマンド)。
- 保存して初期同期を実行します。
各ソースは多数のコンテンツ項目(個々の記事、ページ、ドキュメント)を取り込みます。Amplitudeはこれら両方についてインデックスを付けます:
- リソースセンター(検索と推奨事項)。
- AI Assistant(ドキュメント検索ツールを使用)。
プランの制限は、接続できるソースとドキュメントの数を制御する場合があります。制限に達した場合は、Amplitudeプランを確認してください。
リソースセンターの推奨事項をキュレーションする
リソースセンターの設定を使用して、さまざまなコンテキストに対応したレコメンデーションセットを作成します:
- ページ別または機能別。
- ユーザーセグメント別。
- グローバルデフォルトとして使用します。
以下を含めることができます:
- 記事や文書。
- ガイドとサーベイのコンテンツ(ツアー、チェックリスト、サーベイ)。
- リンクやその他のリソース。
AIアシスタントは、次に以下のことができます:
- 回答の中でユーザーをこれらの項目にリンクさせることができます。
- ワークフローの一部としてガイドやサーベイをトリガーできます。
カスタム回答を作成する
カスタム回答を使用すると、ドキュメント内の特定のギャップを埋めることができ、重要なトピックについて正確な表現を強制できます。
典型的なユースケース:
- 「貴社のSLAはどのようになっていますか?」
- 「ビジネスプランとエンタープライズプランの違いは何ですか?」
- 「購読をキャンセルするにはどうすればよいですか?」
回答を作成するには:
- AI Assistant > コンテンツ > Answers に移動します。
- Create New をクリックします。
- 次の項目を設定します。
- ステータス:
DraftまたはPublished. AIアシスタントが回答を使用できるかどうかを制御します。 - タイトル: 回答のタイトルまたは簡単な説明です。
- 答え: AIアシスタントに使わせたいテキストです。
- 答えは一言一句です: AIアシスタントにテキストを解釈するのではなく、提供したテキストをそのまま使用するよう指示します。これは、ユーザーが払い戻しについて尋ねた場合など、特定のトピックや重要なトピックを伝える必要がある場合に役立ちます。
- ステータス:
- [作成] をクリックします。
Amplitudeは回答をインデックス化し、AIアシスタントがそれらを利用できるようにします。回答はリソースセンターにスタンドアロンの記事として表示されることはありません。 これらは、AI アシスタントの応答を強化するために特に存在します。
フォールバックとハンドオフの設定
AI アシスタントが自信を持って質問に答えられない場合、推測するのではなく、丁寧にフォールバックします。
フォールバックを設定するには:
- _AI Assistant > Behavior > Fallbacks_に移動します。
- 次の各シナリオに対してフォールバックを設定します。
- AI アシスタントがユーザーの質問に対する回答を見つけることができません。
- ユーザーが否定的なフィードバックを寄せています。
- ユーザーが人間へのエスカレーションを要求しました。
AI Assistant は、適切な回答を見つけられないケースをサポートするために、少なくとも 1 つのフォールバックを必要とします。このフォールバックはすべてのユーザーを対象にする必要があります。
各フォールバックには以下が含まれます:
- ターゲティング機能を使用すると、ユーザーの異なるコホートやセグメントに対して異なるフォールバックオプションを設定できます。
- たとえば、ユーザーが定義するフォールバックメッセージ: 「正しく回答できる自信がありません。別のリソースと接続させていただきます」
- アクションまたはアシスト:
| アクション | 概要 |
|---|---|
| リンクにアクセス | AIアシスタントの応答とともに開くURLを入力します。 |
| 要素をクリックする | ページ上の要素を指定します。この要素を使用して別のアクションをトリガーできます。 |
| コールバックを実行する | ガイドとサーベイSDKで定義したコールバック関数を実行します。 |
| サードパーティのチャットを開く | ユーザーを誘導するチャットプロバイダーを選択します。このアクションは、「人間へのエスカレーション」フォールバックとともに使用すると最も効果的です。 |
| ガイドを表示 | 既存のガイドを選択して起動します。 |
| アンケートを表示 | 起動する既存のアンケートを選択します。 |
| 記事を開く | リソースセンターで開くための索引付き記事を選択します。 |
| ビデオを再生する | 再生するビデオを選択します。 _ガイドとサーベイ > コンテンツ > ビデオ_で、利用可能なビデオを追加および管理できます。 |
コミュニケーションスタイルを設定する
AI Assistant > Behavior > Communication Style を使用して、AI Assistant が応答をどのようにフォーマットするか、およびチャットインターフェイスでユーザーにどのように表示されるかを制御できます。
フォーマット方法
AI Assistantが応答をどのようにフォーマットするかを指定するには:
- AI Assistant > Behavior > Communication Style > Advanced に移動します。
- フォーマット手順を入力します。 たとえば、「箇条書きで回答してください」や「回答を3文以内に抑える」などです。
AI Assistantは、レスポンスを生成するときにこれらの指示を適用します。
チャットアシスタントアイコン
チャットアシスタント用のカスタムアイコンをアップロードするには:
- _AI Assistant > Behavior > Communication Style_に移動します。
- チャットアシスタントアイコンとして使用する画像をアップロードしてください。
ワークフローとツールの設定
内部では、AI Assistantはツール(API)やワークフロー(複数ステップの手順)を呼び出すことができるため、単に質問に答える以上のことができます。
組み込みツール
デフォルトでは、AIAssistantは次のようなツールにアクセスできます。
- ドキュメント検索:関連するヘルプコンテンツの検索。
- ガイド検索:関連するガイドとサーベイのエクスペリエンスを検索します。
- ガイドランチャー: ユーザーのプロダクト内で特定のガイドやチェックリストを起動します。
- フォールバックツール:AIアシスタントは、自信を持って回答できない場合や、ユーザーが否定的なフィードバックを提供した場合に、これらのツールを使用します。
AIアシスタントは、ユーザーのリクエストへの回答や対応に役立つ可能性がある場合にはいつでも、これらのツールを自動的に検討します。
ワークフロー
ワークフローは、複数のステップとツールをつなぎ合わせて、再利用可能なパターンを構成します。例えば:
- 「ユーザーがパスワードをリセットできるように支援してください」
- 「ダッシュボードが空である理由をトラブルシューティングします。」
- 「機能採用チェックリストを確認してください。」
典型的なワークフローは次のようになります。
- チャットで確認のための質問をしてください。
- 内部APIを呼び出してデータを検索します。
- そのデータに基づいて複数のブランチから選択します。
- 関連するガイドやチェックリストを起動します。
- 概要を記述して AI Assistant チャットに戻ります。
ワークフローを作成するには:
- _AIAssistant > Automations > Workflows_に移動し、Createをクリックします。
- ワークフローのトリガーを定義します。 たとえば、ユーザーが入力したときにワークフローをトリガーする単語やフレーズを定義します。 オプションで、ユーザーがトピックを変更したり、応答しなくなったりした場合など、ワークフローを終了するタイミングをAIAssistantに指示できます。
- ワークフローを定義します。 自然言語を使用して、AIアシスタントにどのように応答すべきかを知らせます。アクションの挿入 をクリックするか、
@を入力してワークフローにアクションを挿入します。 - ワークフローのターゲットを設定します。
- 保存と有効化をクリックして、ワークフローをアクティブ化します。
ワークフローの例
このワークフローは、ユーザーが自分のプランを確認し、関連するガイドを起動することで、空のダッシュボードをトラブルシューティングするのに役立ちます。
トリガー:
Use this workflow whenever the user reports that their dashboard or charts aren't showing data, or asks why their data is missing.
プロンプト:
First, ask the user whether they recently set up a new project or whether data was previously showing.
Then, check the user's account and plan status using @Get user account information.
If the account is on a free plan, let the user know that data may take up to 24 hours to appear and launch @Empty dashboard troubleshooting guide.
If the account is on a paid plan, ask whether they've verified that events are being sent using the Amplitude Debugger, then launch @Instrumentation troubleshooting guide.
Exit the workflow and return to AI Assistant chat with a brief summary of what you recommended.
ツール
独自の API に裏打ちされたカスタム ツールを使用して AI アシスタントを拡張してください。定義するツールごとに次のことを行います。
- 名前と説明(人間のエージェントにそれを説明しているかのように平易な言語で書かれています)。
- タイプと検証を含む 1 つ以上の入力パラメータ。
- リクエストを受信するバックエンド エンドポイント。
AI Assistant はこれらのツールを使用して次のことを行います。
- 内部情報を検索します(アカウントステータス、プランの制限額など)。
- アクションを実行します(サポートチケットの作成、内部ワークフローの開始など)。
- よりパーソナライズされた状況に応じたヘルプを提供します。
新しいツールを作成するには:
- AI Assistant > Automations > Tools に移動し、Create をクリックします。
- ツールの詳細を入力します。 人間のエージェントにツールを説明しているかのように、わかりやすい言葉で記述された名前と説明を入力してください。 オプションで、ツールを実行する前にユーザーに確認メッセージを送信するダイアログを有効にできます。
- API呼び出しを定義します:
- HTTP メソッドを選択します。GET、POST、PUT、PATCH、または DELETE です。
- APIエンドポイントの追加:リクエストを受信するサーバー上の完全なURLを入力します。エンドポイントは、有効な
httpまたはhttpsURLである必要があります。 - リクエストパラメータの定義:パラメータとは、AI Assistantがツールを呼び出すときに入力できる入力値です。各パラメータについて、タイプ(例:
stringまたはnumber)、キー、必須のステータス、および説明を設定します。説明を平易な言語で記述することで、AI アシスタントがパラメータの使用方法とタイミングを理解できるようになります。 - パラメータをエンドポイントまたは本文に配線する: AI Assistant はパラメータを URL やリクエスト本文に自動的に追加しません。 パラメータを使用するには、エンドポイント URL、リクエスト本文、またはその両方で、プレースホルダを使用して
{{parameter_name}}パラメータを参照してください。AI Assistantは、定義してもプレースホルダで参照していないパラメータをすべて無視します。 - リクエスト本文を定義します。有効な JSON を指定します。 本文はJSONオブジェクトでなければなりません(配列ではありません)。 ボディ内のパラメータを
{{parameter_name}}プレースホルダで参照します。URLを通じてすべてのパラメータを渡すGET要求の場合、本文は空白のままにしてください。 - リクエストヘッダーを定義します。有効な JSON を指定します。 たとえば、
{"Content-Type": "application/json"}または{"Authorization": "Bearer YOUR_TOKEN"}です。
- 応答をテストします。 定義した各パラメータの値を入力し、テスト要求をエンドポイントに送信し、応答を確認します。
GETリクエストの例
パラメータをクエリ文字列値として渡す単純なGET要求です。
- メソッド:
GET - エンドポイント:
https://weather.example.com/search?city={{city}} - パラメータ:
city(文字列、必須) - 「天気を調べる都市。」 - 本文: 空のままにしておきます。
GETリクエストの場合、パラメータをエンドポイントURLに直接埋め込みます。たとえば、?city だけでなく ?city={{city}} を使用してください。 {{city}}プレースホルダは、AI アシスタントに値を挿入する場所を指示するものです。
URL と本文パラメータを含む POST リクエスト
URL パスとリクエスト本文の両方にパラメータプレースホルダを混在させたり、それらの横に静的値を含めることができます。
- メソッド:
POST - エンドポイント:
https://api.example.com/update_order/{{order_id}} - パラメータ:
order_id(文字列, 必須);shipping(文字列, 必須) - 「注文の配送方法。例: 『標準』または『速達』。」 - 本文:
{
"shipping": "{{shipping}}",
"notify_customer": true
}
- ヘッダー:
{
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_TOKEN"
}
この例では、URL パスは {{order_id}} を使用しており、本文は {{shipping}} を使用しています。この値はパラメータから取得されない静的値です。"notify_customer": true
パラメータについて知っておくべき重要な事項
- パラメータは、AI Assistantがツールを呼び出すときに提供できる値を定義します。 これらのツールは、クエリ文字列、フォームフィールド、または本文コンテンツを自動的に生成しません。
{{parameter_name}}プレースホルダを使用して、各パラメータをエンドポイントのURLまたは本文に自分で接続する必要があります。- AI Assistantは、ツールを実行する前に必要なパラメータを検証します。 必要なパラメータが欠落している場合、AI Assistantはリクエストを送信しません。
- このツールはすべてのリクエストをJSON形式で送信するため、カスタムツールはJSON APIと組み合わせて最適に機能します。
ユーザーの承認と安全性
ユーザーデータに影響を与えるツールや機密性の高いアクションを実行するツールについては、ユーザーの承認を要求できます。
- AI Assistantは自分が何をしたいのかをわかりやすい言葉で説明します。
- ユーザーはアクションを確認または拒否します。
ツールを追加するとき:
- リスクを最小限に抑えるには、読み取り専用ツールを使用してください。
- 書き込み可能なツールを、適切に範囲を絞った価値の高いアクションに限定してください。
- X-ray を使用して、AI Assistant がいつ、どのように、なぜツールを呼び出したかを監査してください。
スタイル AI アシスタントおよびリソースセンター
AI アシスタントは、ガイド&サーベイおよびリソースセンターと同じテーマシステムを使用しているため、アプリ内ブランドの一貫性を保つことができます。
テーマを選択または作成する
- _AI アシスタント > テーマ_に移動します。
- 編集する既存のテーマを選択するか、[テーマの作成]をクリックします。
AI アシスタントとリソースセンターは、ガイドとサーベイとテーマを共有していませんが、それぞれが同じ設定と構成をサポートしています。
テーマは通常、次のことを制御します。
- プライマリカラーとセカンダリカラーです。
- フォントとタイポグラフィー。
- ボタンのスタイル。
- パネルの背景と境界線。
リソースセンターと AI アシスタントにテーマを適用する
リソースセンターの設定で:
- ウィジェットで使用するテーマを選択します。
- テーマのランチャー、パネル/ヘッダー、リスト項目、タブ(チャット/リソース)(利用可能な場合)のコンポーネントが希望どおりに表示されていることを確認します。
AI Assistantは同じ基本テーマを共有していますが、以下のような追加設定を公開する場合があります:
- チャットバブルの色や背景など、チャットタブのスタイル設定。
- AIアシスタントの名前とアバター。
- ランチャーに使用されるアイコン。
これは役に立ちましたか?