Skip to content

エージェントのリファレンス

カスタムエージェントを作成する際、インストラクションや出力スキーマなどの主要な設定の詳細については、この記事を参照してください。ステップバイステップのセットアップについては、カスタムエージェントの作成を参照してください。概要については、Brazeエージェントおよびよくある質問を参照してください。

モデル

エージェントを設定するときに、レスポンスの生成に使用するモデルを選択できます。Brazeパワードモデルの使用と、独自のAPIキーの持ち込みの2つのオプションがあります。

オプション1：Brazeパワードモデルを使用する

これは最もシンプルなオプションで、追加のセットアップは不要です。Brazeは大規模言語モデル（LLM）への直接アクセスを提供します。このオプションを使用するには、Geminiモデルを使用するAutoを選択します。

オプション2：独自のAPIキーを持ち込む

このオプションでは、OpenAI、Anthropic、Google GeminiなどのプロバイダーにBrazeアカウントを接続できます。LLMプロバイダーから独自のAPIキーを持ち込む場合、トークンコストはBrazeではなくプロバイダーを通じて直接請求されます。

レガシーモデルは数か月後に廃止または非推奨になる可能性があるため、最新のモデルを定期的にテストすることをお勧めします。エージェントをスケールで実行するために、プロバイダーに十分なクレジットがあることを確認してください。また、通知設定でエージェントコンソールの通知に登録すると、Brazeがモデルの利用不可を検出した場合やLLMプロバイダーとの課金の問題が発生した場合にアラートを受け取ることができます。

設定方法：

  1. パートナー連携 > テクノロジーパートナーに移動し、プロバイダーを見つけます。
  2. プロバイダーから取得したAPIキーを入力します。
  3. 保存を選択します。

その後、エージェントに戻ってモデルを選択できます。

Braze提供のLLMを使用する場合、そのモデルのプロバイダーは、お客様とBraze間のデータ処理補遺（DPA）の条件に従い、Brazeのサブプロセッサーとして機能します。独自のAPIキーを持ち込むことを選択した場合、LLMサブスクリプションのプロバイダーは、お客様とBraze間の契約に基づくサードパーティプロバイダーと見なされます。

思考レベル

一部のLLMプロバイダーでは、選択したモデルの思考レベルを調整できます。思考レベルは、モデルが回答する前に使用する思考の範囲を定義します。素早く直接的なレスポンスから、より長い推論の連鎖まで対応します。これはレスポンスの品質、レイテンシー、トークン使用量に影響します。

レベル 使用するタイミング
Minimal シンプルで明確に定義されたタスク（カタログ検索、単純な分類など）。最速のレスポンスで最低コストです。
Low もう少し推論が必要だが、深い分析は不要なタスク。
Medium 複数ステップまたはニュアンスのあるタスク（複数の入力を分析してアクションを推奨するなど）。
High 複雑な推論、エッジケース、またはモデルにステップを踏んで回答させたい場合。

まずMinimalから始めて、エージェントのレスポンスをテストすることをお勧めします。エージェントが正確な回答を提供するのに苦労している場合は、思考レベルをLowまたはMediumに調整できます。まれにHighの思考レベルが必要になることがありますが、このレベルを使用するとトークンコストが高くなり、レスポンス時間が長くなったり、タイムアウトエラーのリスクが高くなったりする可能性があります。エージェントが複数ステップの推論と妥当なレスポンス時間のバランスに苦労している場合は、ユースケースを複数のエージェントに分割し、キャンバスやカタログで連携させることを検討してください。

Brazeは、Connected Contentと同じIP範囲をアウトバウンドLLMコールに使用します。範囲はConnected Content IP許可リストに記載されています。プロバイダーがIP許可リストをサポートしている場合、Brazeのみがキーを使用できるようにこれらの範囲に制限できます。

使用するモデルの決定

各LLMプロバイダーは、モデルの能力、コスト、思考レベルの組み合わせがそれぞれ異なります。以下に一般的なガイドラインとベストプラクティスを示します。

  • コスト効率を重視する場合は、高コストモデルよりも低トークンコストモデルのテストを優先してください。低コストモデルがユースケースに対応できない場合や、一貫性のない不正確な出力を生成する場合にのみ、高コストモデルに調整してください。
  • 速度とパフォーマンス効率を重視する場合は、高い思考レベルよりも低いモデル思考レベルのテストを優先してください。低い思考レベルがユースケースに対応できない場合や、一貫性のない不正確な出力を生成する場合にのみ、高い思考レベルのモデルに調整してください。
  • 低コストモデルやモデル思考レベルがユースケースに対応できない場合や、一貫性のない不正確な出力を生成する場合は、高コストモデルや高い思考レベルのモデルへの調整を検討してください。
  • テスト中は、信頼性と精度をトークン使用量と呼び出し時間とバランスさせるようにしてください。
  • ユースケースごとに最適なモデルと思考レベルが異なる場合があります。タイムアウトなしで一貫した品質を確認するために、徹底的にテストすることをお勧めします。

呼び出しフロー制御

以下の呼び出しフロー制御がワークスペースごとに適用されます。

  • Brazeパワードモデル： 1分あたり5,000回の呼び出し
  • 独自のAPIキーの持ち込み： 1分あたり5,000回の呼び出し

多くのユーザーが同時にエージェントステップに入ると、Brazeはこれらの制限に従って呼び出しをキューに入れるため、大量送信時には処理に時間がかかる場合があります。

1日あたりの呼び出しとクレジットの制限

各エージェントには1日あたりの呼び出し制限があります（デフォルト250,000、契約で許可されていない限り最大1,000,000）。エージェントコンソールのプレビューやSimulate responseを使用したテストキャンバスの実行を含む、すべての呼び出しがこの制限にカウントされます。

エージェントコンソールのDaily action credit cost limitは、エージェントが1日あたりに消費できる最大クレジットを見積もります。Brazeは、選択したモデルのワークスペースごとの呼び出しあたりのクレジット比率に1日あたりの呼び出し制限を掛けます。

クレジット使用量の監視

設定 > 請求 > クレジット使用量 > エージェントコンソールに移動して、クレジット消費量、呼び出し回数、エージェントごとのクレジット比率を確認できます。

クレジット比率は契約に基づいており、クレジット使用量ダッシュボード（Credit RatiosタブおよびAgent Consoleタブ）に表示されます。見積もりは、モデルまたは呼び出し制限を変更すると更新されます。

支出を管理するには、1日あたりの呼び出し制限を下げてください。独自キーの持ち込み（BYO）モデルの場合は、低コストモデルを選択するか、思考レベルを下げてプロバイダーのトークンコストを削減することもできます。Braze Autoは思考レベルの調整をサポートしていません。

レート制限エラー

LLMプロバイダーがキャンバスステップエージェントまたはカタログエージェントの呼び出し中にレート制限エラーを返した場合、Brazeはエクスポネンシャルバックオフを使用して、コールが成功するかBrazeが完了不可能と判断するまで継続的にリクエストを再試行します。

キャンバスまたはカタログの再試行が尽きると、Logsの詳細パネルにErrorが表示され、Outputにプロバイダーメッセージ（Rate limit exceededなど）が表示されます。最初の呼び出しの最終的な成功・失敗にかかわらず、再試行はログに表示されます。特定のユーザーについて、成功するまでに4回の再試行が必要だった場合、ユーザーIDで検索するとLogsに5件すべて（オリジナルと4回の再試行）が表示され、オリジナルと最初の3回の再試行にはRate limit exceededのErrorが表示されます。

Outputフィールドにレート制限超過エラーが表示されているエージェントコンソールのログ詳細。

インストラクションの記述

インストラクションは、エージェントに与えるルールまたはガイドライン（システムプロンプト）です。エージェントが実行されるたびにどのように動作するかを定義します。システムインストラクションは最大25 KBです。

BrazeAI Operatorを使用して開始テンプレートでエージェントを構築した場合は、事前入力されたインストラクションを確認し、必要に応じて編集してください。

プロンプト作成を始めるための一般的なベストプラクティスを以下に示します。

  1. ゴールを念頭に置いて始めましょう。まず目標を述べます。
  2. モデルにロールまたはペルソナを与えます（「You are a …」）。
  3. 明確なコンテキストと制約を設定します（オーディエンス、長さ、トーン、フォーマット）。
  4. 構造を求めます（「Return JSON/bullet list/table…」）。
  5. 説明するのではなく、示しましょう。質の高い例をいくつか含めます。
  6. 複雑なタスクを順序付けられたステップに分割します（「ステップ1… ステップ2…」）。
  7. 推論を促します（「内部的にステップを考え、簡潔な最終回答を提供してください」または「判断を簡潔に説明してください」）。
  8. パイロット、検査、反復を行います。小さな調整が大きな品質向上につながります。
  9. エッジケースを処理し、ガードレールを追加し、拒否のインストラクションを追加します。
  10. 再利用とスケーリングのために、うまくいったことを測定し文書化します。

例

エージェントコンソールの開始設定については、Operatorで構築されたエージェントテンプレートを参照してください。

コピーまたはアレンジできる完全なインストラクション例については、Brazeエージェントのユースケースライブラリを参照してください。

例 カテゴリ エージェントタイプ 内容
ユーザーのコンテキストに基づいてパーソナライズされたメッセージを作成する コンテンツ生成 キャンバスステップエージェント 検索したが予約しなかったユーザー向けに、メールの件名/プリヘッダーとプッシュのタイトル/本文を連携して生成します。
ユーザーフィードバックを分析して次のステップを決定する データ標準化 キャンバスステップエージェント 旅行後のアンケートのセンチメントとトピックを分類し、CRMの次のステップを推奨します。
既存の属性からユーザーを興味バケットに分類する アフィニティエージェント キャンバスステップエージェント 属性と高インテントシグナルからユーザーを興味バケットに分類し、最適な次のエクスペリエンスまたはアイテムを推奨します。
最近の行動から最も関連性の高いキャンバスパスにユーザーをルーティングする アフィニティエージェント キャンバスステップエージェント 最近の行動からモチベーションを推測し、ユーザーの次のキャンバスステップに最適なルートキーを返します。
リアルタイムの高インテントアクションからユーザーを興味カテゴリに割り当てる アフィニティエージェント キャンバスステップエージェント 高インテントアクションから興味カテゴリを割り当て、最適な次のエクスペリエンスまたはアイテムを推奨します。
インバウンドメッセージをオプトアウトインテントで分類する 分類とルーティング キャンバスステップエージェント メッセージがオプトアウトリクエストかどうかを示す厳密なブール値を返します。
インバウンドメッセージをオートメーション用の構造化データに標準化する データ標準化 キャンバスステップエージェント インバウンドSMSまたはチャットを、ダウンストリームオートメーション用の構造化されたインテント、エンティティ、コンプライアンスフラグに正規化します。
ブランド・ガイドラインに沿った高コンバージョンの説明文を作成する コンテンツ生成 カタログエージェント 各カタログ行に対して、短くブランドに沿った説明文を生成します。
地域で使用される言語に基づいて翻訳を提供する カタログエンリッチメント カタログエージェント ロケールと文字数制限に応じてUIおよびマーケティング文字列をローカライズします。
カタログアイテムを説明文、カテゴリ、タグでエンリッチする カタログエンリッチメント カタログエージェント 既存のカタログアイテムデータから、強化された説明文、カテゴリ、タグを生成します。

Liquidの使用

エージェントのインストラクションにLiquidを含めると、レスポンスにパーソナライゼーションのレイヤーを追加できます。エージェントが取得する正確なLiquid変数を指定し、プロンプトのコンテキストに含めることができます。たとえば、「名」を明示的に記述する代わりに、Liquidスニペット{{${first_name}}}を使用できます。

1

Tell a one-paragraph short story about this user, integrating their {{${first_name}}}, {{${last_name}}}, and {{${city}}}. Also integrate any context you receive about how they are currently thinking, feeling, or doing. For example, you may receive {{context.${current_emotion}}}, which is the user's current emotion. You should work that into the story.

エージェントコンソールのLogsセクションで、エージェントの入出力の詳細を確認し、Liquidからどのような値がレンダリングされるかを理解できます。

エージェントが受け取るデータ

エージェントのコンテキストは、オープンエンドの会話メモリではありません。チャットアシスタントとは異なり、エージェントは呼び出し時に明示的に渡されたデータのみを参照します。ユーザープロファイルを閲覧したり、欠落しているフィールドを推測したり、必要な情報が不足していることを通知したりすることはありません。

各エージェントを意図的な入力から出力へのパイプラインとして設計してください。エージェントが必要とするすべてのデータポイントを、以下の1つ以上の方法で接続します。

  1. インストラクション内のLiquid： ユーザー属性（{{${first_name}}}）とキャンバスコンテキスト変数（{{context.${variable_name}}}）をエージェントプロンプトに直接テンプレート化します。
  2. + エージェントコンテキスト： エージェントコンソールで、カタログ、セグメントメンバーシップ、ブランド・ガイドライン、All キャンバス Context、またはユーザーインタラクションデータを選択します。
  3. コンテキストステップ：エージェントステップが実行される前に、キャンバスの上流でcontext.*変数を設定または更新します。
  4. エージェントステップの追加コンテキスト： 他の方法で指定されていない追加のLiquidテンプレート値を、ステップ設定から送信時にエージェントに渡します。

これらのコンテキスト変数をエージェントのインストラクションにLiquidテンプレートとして含めるか、Add All キャンバス Contextを選択してください。これらのチャネルのいずれかを通じて値が渡されない場合、エージェントはそれを受け取りません。必要な入力をインストラクションまたはユースケースの前提条件にリストし、テスト後にエージェントコンソール > Logsで入力を確認してください。

インストラクションにLiquidを含むエージェントの詳細。

カタログエージェントの場合は、JSONスキーマではなくOutputセクションのFieldsを使用します。ただし、インストラクション内でモデルにフィールド名に一致するキーバリュー出力を求めることは可能です。

プロンプトのベストプラクティスの詳細については、以下のモデルプロバイダーのガイドを参照してください。

出力

BrazeAI Operatorを使用して開始テンプレートでエージェントを構築した場合は、事前入力された出力スキーマを確認し、必要に応じて編集してください。

基本スキーマ

基本スキーマは、エージェントが返すシンプルな出力です。文字列、数値、ブール値、文字列の配列、または数値の配列を指定できます。

たとえば、製品を受け取った後の顧客満足度を判定するために、シンプルなフィードバック調査からユーザーのセンチメントスコアを収集したい場合、出力フォーマットを構造化するために基本スキーマとしてNumberを選択できます。

基本スキーマとしてNumberが選択されたエージェントコンソール。

高度なスキーマ

高度なスキーマオプションには、フィールドの手動構造化またはJSONの使用が含まれます。

  • Fields： 一貫して使用できるエージェント出力を強制するノーコードの方法です。
  • JSON： 正確な出力フォーマットを作成するコードアプローチで、JSONスキーマ内に変数やオブジェクトをネストできます。キャンバスステップエージェントでのみ使用可能で、カタログエージェントでは使用できません。

エージェントに単一値の出力ではなく、構造化された方法で定義された複数の値を持つデータ構造を返させたい場合は、高度なスキーマの使用をお勧めします。これにより、出力が一貫したコンテキスト変数としてより適切にフォーマットされます。

フォールバック出力

フォールバック値はキャンバスステップエージェントでのみ使用可能です。キャンバスステップエージェントのエージェントコンソールのOutputセクションで、呼び出しが失敗した場合にBrazeが使用する値を定義できます。

JSONスキーマの場合、Brazeはスキーマを読み取り、各プロパティの入力フィールドを生成するため、キーごとにフォールバック値を設定できます。Fieldsスキーマの場合、各フィールドにフォールバック値を入力します。基本スキーマの場合、単一のフォールバック値を入力します。キャンバスステップエージェントはフォールバック値でLiquidをサポートしています。

セットアップ手順については、フォールバック値の設定を参照してください。キャンバスでのランタイム動作については、エラー処理とフォールバック動作を参照してください。

たとえば、ユーザーが送信したフォームに基づいてサンプル旅行プランを作成するエージェント内で出力フォーマットを使用できます。出力フォーマットにより、すべてのエージェントレスポンスがtripStartDate、tripEndDate、destinationの値を含んで返されるように定義できます。これらの各値はコンテキスト変数から抽出し、Liquidを使用してメッセージステップに配置してパーソナライゼーションに活用できます。

レストランの最新アイスクリームフレーバーを推薦する可能性を判定するために、シンプルなフィードバック調査へのレスポンスをフォーマットしたい場合、出力フォーマットを構造化するために以下のフィールドを設定できます。

フィールド名 値
likelihood_score Number
explanation String
confidence_score Number

likelihood score、explanation、confidence scoreの3つの出力フィールドを表示するエージェントコンソール。

レストランチェーンでの最新の食事体験に関するユーザーフィードバックを収集したい場合、出力フォーマットとしてJSON Schemaを選択し、以下のJSONを挿入して、センチメント変数と理由変数を含むデータオブジェクトを返すことができます。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

{
  "type": "object",
  "properties": {
    "sentiment": {
      "type": "string"
    },
    "reasoning": {
      "type": "string"
    }
  },
  "required": [
    "sentiment",
    "reasoning"
  ]
}

カタログとフィールド

エージェントが参照する特定のカタログを選択し、製品やその他の関連する非ユーザーデータを理解するために必要なコンテキストをエージェントに提供します。エージェントはツールを使用して関連するアイテムのみを検索し、トークン使用量を最小限に抑えるためにそれらのみをLLMに送信します。カタログ検索の精度を向上させるには、ナレッジソースを作成し、カタログを直接添付する代わりにエージェントコンテキストとして追加してください。

エージェントが検索するために選択された「restaurants」カタログと「Loyalty_Program」列。

カタログエージェントをカタログフィールドにデプロイする場合、必須入力コントロールを有効にし、エージェントが呼び出される前に実行に必要な選択済み列を選択します。エージェントは、必須列のいずれかが空白または欠落している場合にのみ行をスキップします。たとえば、まだ入力されていないgenderフィールドなどです。選択済み列はデフォルトで必須として開始されますが、実行をブロックせずに空でもよい列を削除できます。これにより、不完全なデータでのトークンの無駄遣いを防ぎます。

カタログエージェントは、入力フィールドが互いに依存している場合に列の順序も尊重します。列Dが列BとCから生成される場合、エージェントはBとCにその行の値が含まれるまで列Dを実行しません。

デプロイシナリオと例については、カタログエージェントの使用およびカタログエージェントのベストプラクティスを参照してください。

セグメントメンバーシップのコンテキスト

エージェントがキャンバスで使用されている場合に、各ユーザーのセグメントメンバーシップを相互参照するためのセグメントを最大5つまで選択できます。たとえば、エージェントが「Loyalty Users」セグメントのメンバーシップを選択しており、そのエージェントがキャンバスで使用されているとします。ユーザーがエージェントステップに入ると、エージェントは各ユーザーがエージェントコンソールで指定した各セグメントのメンバーであるかどうかを相互参照し、各ユーザーのメンバーシップ（または非メンバーシップ）をLLMのコンテキストとして使用できます。

エージェントメンバーシップアクセス用に選択された「Loyalty Users」セグメント。

ブランド・ガイドライン

エージェントがレスポンスで遵守するブランド・ガイドラインを選択できます。たとえば、エージェントがジムのメンバーシップへの登録を促すSMSコピーを生成する場合、このフィールドを使用して、事前定義された大胆でモチベーショナルなガイドラインを参照できます。

ユーザー固有のインタラクション履歴

ユーザーのインタラクションデータには、最近のキャンペーンおよびキャンバスの開封、クリック、コンバージョンデータが含まれます。たとえば、キャンバスで評価される際にエージェントが参照するコンテキストとしてこのデータを含めることができます。ユーザー固有のインタラクション履歴は、パーソナライズされたメッセージコピーを作成するエージェントに影響を与えるのにも役立ちます。

バージョン履歴

エージェントコンソールは、エージェントの変更を保存するたびに新しいバージョンを記録します。バージョン履歴タブには、保存されたすべてのバージョンと保存間の編集内容が一覧表示されます。

  1. エージェントコンソールでエージェントを開きます。
  2. バージョン履歴タブを選択します。
  3. バージョンを選択して設定を確認します。

バージョンの変更内容を確認するには、表示を選択します。Brazeは、追加と削除をハイライトするコードスタイルのインライン差分を表示します。削除されたコンテンツは赤い取り消し線スタイルで表示されます。

以前のバージョンからインストラクションを復元する必要がある場合は、そのバージョンの表示を開き、インストラクションテキストをコピーして、現在のInstructionsフィールドに貼り付けてください。

エージェントの複製

エージェントを複製して、改善や反復をオリジナルと並べてテストできます。以前の設定を確認または復元するには、バージョン履歴を使用してください。エージェントを複製するには：

  1. エージェントの行にカーソルを合わせ、メニューを選択します。
  2. 複製を選択します。

エージェントのアーカイブ

カスタムエージェントをさらに作成すると、アクティブに使用されていないエージェントをアーカイブすることでエージェント管理ページを整理できます。エージェントをアーカイブするには：

  1. エージェントの行にカーソルを合わせ、メニューを選択します。
  2. アーカイブを選択します。
New Stuff!