Skip to content

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

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

モデル

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

オプション1：Brazeが提供するモデルを使用する

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

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

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

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

設定方法：

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

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

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

思考レベル

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

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

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

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

使用するモデルの決定

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

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

呼び出しフロー制御

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

  • Brazeが提供するモデル： 1分あたり5,000回の呼び出し
  • 独自のAPIキーを持ち込む場合： 1分あたり5,000回の呼び出し

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

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

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

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

クレジットが消費されるタイミング

Brazeは、処理が完了した呼び出しに対してのみクレジットを請求します。以下の理由で呼び出しが失敗した場合、クレジットは消費されません。

  • LLMプロバイダーからのレート制限エラー（最終的に失敗するリトライを含む）
  • 選択したモデルが利用不可
  • エージェントが1日あたりの呼び出し制限に達した場合

呼び出しがタイムアウトした場合、エージェントが使用可能な出力を返さなくてもクレジットは消費されます。

クレジット使用量の監視

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

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

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

レート制限エラー

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

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

レート制限エラーは、ログに表示される失敗したリトライを含め、Brazeクレジットを消費しません。

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

インストラクションの作成

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

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

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

  1. ゴールを念頭に置いて始めます。まず目標を明示してください。
  2. モデルに役割やペルソナを与えます（「あなたは…です」）。
  3. 明確なコンテキストと制約を設定します（対象者、長さ、トーン、フォーマット）。
  4. 構造を求めます（「JSON/箇条書き/テーブルで返してください…」）。
  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.

エージェントコンソールのログセクションで、エージェントの入力と出力の詳細を確認し、Liquidからレンダリングされた値を把握できます。

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

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

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

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

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

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

カタログエージェントの場合は、JSONスキーマではなく出力セクションのフィールドを使用してください。それでも、モデルにそれらのフィールド名に一致するキーバリュー出力を求めるインストラクションを記述できます。

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

出力

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!