インテグレーションビルダーは、高度な技術スキルやプログラミングスキルがなくても、AIエージェントを任意のAPIやデータソースに接続できる強力なノーコードツールです。この記事では、インテグレーションビルダーに関するよくある質問(FAQ)について説明します。
この記事では、次のトピックについて説明します。
関連記事:
パラメータとデータに関するFAQ
会話のセッションデータはどのように収集されますか?
AIエージェントとの会話でのセッションデータ収集は、セッション開始時のユーザーMetadataの自動キャプチャから始まり、AIエージェントとのインタラクションを通じて継続され、入力、レスポンス、コンテンツエンティティをキャプチャできます。
チャットセッションが開始すると、特にユーザーがログインしている場合、特定のMetadataが自動的に収集されます。通常、このMetadataにはユーザーIDまたはアカウント情報、セッションID、場所、タイムスタンプなど、ユーザー固有の詳細情報が含まれます。このデータは、会話アクションとして保存できます。
会話中に、ユーザーからの特定のレスポンス(フリーテキストとして記述、またはボタンで送信)をキャプチャするように選択できます。次のいずれかを選択できます。
- 条件設定ブロックで「パラメータ収集」設定を使用するパラメータ
- コンテンツエンティティ
これらのパラメータをインテグレーションに渡して、URLエンドポイントまたはリクエストボディのリクエストパラメータとして使用できます。
URLパラメータとは?使用方法は?
URLパラメータは、会話から取得したリクエストパラメータ内のインテグレーションに渡された情報に基づいて変化する、URLの動的パラメータです。
パラメータとして使用されるユーザーIDの例を以下に示します。
https://{{zendesk_subdomain}}.zendesk.com/api/v2/users/{{user_id}}
二重の中括弧で囲まれたパラメータuser_id が、URLに追加されています。
APIで使用する会話のデータにアクセスするにはどうすればよいですか?
会話のデータを使用するには、パラメータを収集するか、Metadataをセッションデータのパラメータに保存して、上記のようにパラメータとしてセッションにデータを保存する必要があります。データは、会話から取得した場合はリクエストパラメータとしてインテグレーションビルダーに保存する、またはAPIに送信される場合はセッションデータ/Metadataとして保存する必要があります。また、リクエストボディでそのパラメータを動的に送信することもできます。
会話で使用するAPIレスポンスのパラメータやデータにアクセスするにはどうすればよいですか?
APIレスポンスのパラメータまたはデータを使用するには、それらを環境のセッションパラメータとして保存する必要があります(ほとんどの場合、成功シナリオ)。保存後、特定のシナリオでAPIが実行されると、セッションパラメータにアクセスして、AIエージェント メッセージで使用したり、条件設定ブロックのパラメータとして使用できます。
- AIエージェントメッセージでは、{{parameterName}}でアクセスします。
- 条件設定ブロックでは、パラメータ名でアクセスします。
ボディでリクエストパラメータを送信するにはどうすればよいですか?
ボディでリクエストパラメータを送信するには、次のように二重の中括弧で囲む必要があります。
{{exampleParameter}}
リクエストボディで配列を送信できますか?
はい、リクエストパラメータを定義する際、データ型を配列として選択できます。テスト時に、JSONata関数$eval($)を使用して値を再フォーマットしてください。eval関数は、JSON式またはJSONata式を含む文字列を、JSONとして解析して評価します。
ここでは、配列に含まれる文字列を取得し、$eval()を使用して配列として解析します。最も一般的なユースケースは、注文の配列を送信する場合です。
テスト時に、リクエストパラメータや誤ったパラメータを受信しないのはなぜですか?
テスト用に、インテグレーションビルダーのリクエストパラメータにエンドポイントの実データと一致するテスト値を使用する必要があります。ただし、ライブ会話では、このパラメータ値は会話から取得されます。テスト時にセッションデータにパラメータと値がない場合は、対話で正しいパラメータとしてキャプチャし、保存していることを確認してください。
サニタイズ済みセッションデータは、会話ログには表示されませんので注意してください。この場合、デバッグのためにAIエージェントメッセージに一時的に記録する必要があります。
[Object, object]が表示されるのはなぜですか?
[Object, object]が表示される理由は、オブジェクトの出力を試みたが、システムには体系的な表示方法がないからです。これを解決するには、オブジェクトを文字列形式に変換する必要があります。
成功したコールは記録されますか?
いいえ、PIIとGDPRのため、成功したデータコールはログに記録されません。失敗したコールはログに記録され、必要に応じて問題に関する詳細をトラブルシューティングで確認できます。
環境に関するFAQ
別の環境は必要ですか?
インテグレーションをテストする場合、実際のデータやライブデータを使用したくない場合があります。サンドボックス、ステージング、または開発環境にアクセスできる場合は(技術チームに問い合わせる、またはAPIドキュメントで確認)、インテグレーションビルダー内で設定できます。
リクエストパラメータと出力は、環境間で共有されます。ただし、環境ごとにエンドポイントと認証方法が異なります。対話ビルダーでは、APIノードの環境を簡単に切り替えることができます。つまり、テスト時に対話を1回作成するだけで、本番環境に切り替えてインテグレーションを使用することができます。
カードとカルーセルに関するFAQ
カードの最大数を設定する必要がありますか?
Sunshine Conversationsインテグレーションでは、最大10枚のカードを使用できます。
カルーセル内のカード数を最大9枚(または1枚のフォールバックカードと8枚)に制限することをお勧めします。フォールバックカードを使用すると、ユーザーはカルーセルから出ることができます(商品が表示されない場合など)。
カルーセル内のカードに画像を表示する必要がありますか?
はい、画像は必須データフィールドです。動的画像(製品ごとの画像など)が不要な場合は、画像フィールドに汎用画像のリンクを入力できます。
認証に関するFAQ
どのような認証方法を使用できますか?
次の認証方法を使用できます。
- APIキー
- ベアラートークン
- 有効期限トークン
- Basic認証
- OAuth 2.0
- IP許可リスト
インテグレーションビルダーの認証を開始するには、インテグレーションの技術要件を参照してください。
許可リストのエンドポイントでインテグレーションを作成できますか?
はい。これには、当社のIPアドレスを許可リストに追加する必要があります。IPアドレスのリストについては、IPでAIエージェント(Advanced)をCRMに接続するを参照してください。
認証専用インテグレーションとは何ですか?いつ必要ですか?
認証専用インテグレーションの詳細については、インテグレーションビルダーでカスタム認証を使用するを参照してください。
API制限とスロットリングを実装できますか?
直接、API制限やスロットリングをすることはありません。API制限は、通常、バックエンドシステムなどのインテグレーション対象のシステムやAPIによって行われます。これらの制限は、バックエンドの設定によって異なります。
APIレスポンスが9秒以上かかる場合はどうなりますか?
AIエージェント(Advanced)アドオンは、APIレスポンスに9秒のタイムアウトを適用しています。この時間内にAPIが応答しない場合、リクエストはタイムアウトし、エラーECONNABORTEDが返されます。さらに、レスポンス時間が長いほど、ユーザーのフラストレーションが高まり、ユーザーエクスペリエンスに悪影響を及ぼす可能性があります。
これに対処するために、特定のAPIレスポンスに9秒以上かかると予想される場合は、可能であれば会話の開始時(チャットの開始イベント時など)に必要なAPIコールを実行し、関連情報をセッションに保存することをお勧めします。これにより、必要なときにデータを使用でき、会話フローでの遅延を回避できます。