REST Resource: projects.locations.brands.channelConfigs

リソース: ChannelConfig

チャネル構成は、運用戦略の構成を表します。チャンネル構成のライフサイクル: * DRAFT: 構成に関連付けられた構成アプリケーション ルールがなく、ブランドのデフォルト構成として設定されていない場合、構成はドラフト状態になります。* ACTIVE: 構成が構成アプリケーション ルールに関連付けられているか、ブランドのデフォルトとして設定されている場合、構成はアクティブな状態になります。* 有効にすると、ランタイムは一致するストアにチャネル構成を適用します。柔軟性を確保するため、チャネル構成と構成適用ルールの関係は、各リソースレベルで 1 対多になっています。* ブランドレベルでは、チャネル構成と構成適用ルールの間に 1 対多の関係があります。* ストアレベルでは、チャネル構成と構成適用ルールの間に別の 1 対多の関係があります。複数のチャネル構成が適用可能な場合、ランタイムは次の優先順位に基づいて適用する構成を決定します（競合が発生した場合は、後者が前者を上書きします）。1. ブランドレベルのデフォルト 2。ブランドレベルのバインディング 3。店舗レベルのデフォルト 4。店舗レベルのバインディング

JSON 表現 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string,
  "operationsConfig": {
    object (OperationsConfig)
  },
  "state": enum (State),
  "type": enum (Type),
  "supplementalInstructions": {
    object (SupplementalInstructions)
  },
  "tone": enum (Tone),
  "configApplicationRules": [
    {
      object (ConfigApplicationRule)
    }
  ]
}
フィールド
name

string

ID。チャネル構成名。形式: projects/{project}/locations/{location}/brands/{brand}/channelConfigs/{channelConfig}
displayName

string

省略可。ユーザー インターフェース用のこのチャネル構成の表示名（省略可）。値は 63 文字以内に制限されています。
createTime

string (Timestamp format)

出力専用。このチャネル構成が作成された時刻。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

出力専用。このチャネル構成が最後に更新された時刻。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
operationsConfig

object (OperationsConfig)

省略可。チャネル構成の運用戦略。
state

enum (State)

出力専用。チャネル構成のステータス。
type

enum (Type)

必須。チャネル構成のタイプ。
supplementalInstructions

object (SupplementalInstructions)

省略可。チャネル構成の補足手順。
tone

enum (Tone)

省略可。エージェントのトーン。
configApplicationRules[]

object (ConfigApplicationRule)

出力専用。このチャネル構成に関連付けられている構成アプリケーション ルール。

OperationsConfig

運用戦略を定義するための構成。

JSON 表現 
{
  "displayName": string,
  "description": string,
  "upsellStrategy": {
    object (UpsellStrategy)
  },
  "greetings": [
    {
      object (Greetings)
    }
  ],
  "defaultLanguageCode": string,
  "featuresConfig": {
    object (FeaturesConfig)
  },
  "interactionMode": enum (InteractionMode),
  "disambiguationStrategy": {
    object (DisambiguationStrategy)
  }
}
フィールド
displayName

string

省略可。この運用戦略の名前。
description

string

省略可。この運用戦略の説明。
upsellStrategy

object (UpsellStrategy)

省略可。アップセル動作の構成。
greetings[]

object (Greetings)

省略可。使用するカスタマイズされた応答メッセージ（言語ごと）。
defaultLanguageCode

string

省略可。顧客対応に使用するデフォルトの言語。
featuresConfig

object (FeaturesConfig)

省略可。エージェント機能の構成。
interactionMode

enum (InteractionMode)

省略可。エージェントのインタラクション モード。
disambiguationStrategy

object (DisambiguationStrategy)

省略可。曖昧性除去コントロールの戦略構成。

UpsellStrategy

アップセルの戦略を定義します。

JSON 表現 
{
  "maxUpsellOffers": integer,
  "maxUpsellDeclines": integer,
  "maxItemsInCart": integer,
  "upsells": [
    {
      object (UpsellConfig)
    }
  ],
  "cateringGuidelines": string
}
フィールド
maxUpsellOffers

integer

省略可。セッションごとに表示するアップセル特典の最大数。
maxUpsellDeclines

integer

省略可。現在のセッションで、お客様がアップセルを拒否できる最大回数。この回数を超えると、それ以降のアップセルはスキップされます。
maxItemsInCart

integer

省略可。現在のセッションで、これ以上のアップセルがスキップされる前にカートに入れることができるアイテムの最大数。
upsells[]

object (UpsellConfig)

省略可。構成済みのアップセル。
cateringGuidelines

string

省略可。このメニューのオフラインで生成されたサービング計算とグループの並べ替えルールを表すテキストのセットを表します。会話型 LLM によって読み取られます。

UpsellConfig

アップセル インスタンスの構成を定義します。

JSON 表現 
{
  "displayName": string,
  "priority": integer,
  "skipOnMultiQuantityUpsoldFromItem": boolean,
  "skipOnPreviousTurnUpsell": boolean,
  "disabled": boolean,

  // Union field upsell_type_config can be only one of the following:
  "greetingOffer": {
    object (GreetingOffer)
  },
  "closingOffer": {
    object (ClosingOffer)
  },
  "celUpsell": {
    object (CelUpsell)
  }
  // End of list of possible types for union field upsell_type_config.
}
フィールド
displayName

string

省略可。アップセルの名前。UI 表示、指標の集計、分析に使用されます。
priority

integer

必須。特定の UpsellStrategy 内の他のすべての UpsellConfig と比較した、アップセル構成の優先順位を表す数値。優先度の高い UpsellConfig は、優先度の低い UpsellConfig よりも先にアップセルが試行されます。

  • 値の範囲は [1, inf) です。
  • 値が小さいほど優先度が高くなります。たとえば、UpsellStrategy で優先度が 1 の UpsellConfig は、常に最初に試行されます。
  • UpsellStrategy 内の各 UpsellConfig には、一意の値の優先度が必要です（例: 優先度 3 を設定できる UpsellConfig は 1 つのみ）。
  • 優先度の値は、UpsellStrategy 内で連続している必要はありません（例: 優先度の値が {1, 2, 5, 6, 9} の UpsellConfig が存在する場合があります）。アップセル構成の優先順位は、相対的な基準で決定されます（前述の例では、1 < 2 < 5 < 6 < 9）。
skipOnMultiQuantityUpsoldFromItem

boolean

省略可。アップセル元のアイテムの数量が 1 より大きい場合に、このアップセルをスキップするかどうか。この設定は、関連するアップセル タイプ（アイテムからコンボ、コンボのサイズアップ、修飾子の追加、コンボのドリンク、アイテムのサイズアップ、コンボのバリエーション、アイテム トリガー）にのみ適用されます。
skipOnPreviousTurnUpsell

boolean

省略可。前の会話ターンがアップセルだった場合に、このアップセルをスキップするかどうか。
disabled

boolean

省略可。アップセル タイプが無効になっているかどうかを示します。true の場合、アップセルは試行されません。この構成は、構成アプリケーション ルールのオーバーライドの一環としてアップセル タイプを無効にする場合に便利です。
共用体フィールド upsell_type_config。アップセルのタイプ固有の構成。upsell_type_config は次のいずれかになります。
greetingOffer

object (GreetingOffer)

エージェントのウェルカム メッセージの一部として、特定のアイテムをアップセルする。
closingOffer

object (ClosingOffer)

お客様が注文を完了した後に、特定の商品をアップセルします。
celUpsell

object (CelUpsell)

Common Expression Language（CEL）に基づいて動的に評価されるアップセル ルール。

GreetingOffer

エージェントのウェルカム メッセージの一部として、特定のアイテムをアップセルする。

JSON 表現 
{
  "messages": [
    {
      object (OfferMessage)
    }
  ]
}
フィールド
messages[]

object (OfferMessage)

必須。使用するアップセル メッセージの応答。

OfferMessage

挨拶と終了のオファー メッセージの共通構成。

JSON 表現 
{
  "displayName": string,
  "messageFrequency": number,
  "upsoldItems": [
    string
  ],
  "messageConfigs": [
    {
      object (MessageConfig)
    }
  ],
  "upsoldItemIds": [
    string
  ]
}
フィールド
displayName

string

省略可。表示と分析に使用する名前。
messageFrequency

number

省略可。このメッセージを使用する時間の割合。たとえば、messageFrequency が 0.2 の場合、このメッセージはセッションの 20% で使用されます。すべての messageFrequency 値が未設定（0.0）の場合、各メッセージはセッションの 1/n の割合で使用されます。ここで、n はオファータイプに構成された OfferMessage の数です。messageFrequency の値が一部しか設定されていない場合、messageFrequency の値が設定されていない OfferMessage は使用されません。
upsoldItems[]

string

省略可。このメッセージでアップセルされるアイテムの名前。これまたは upsoldItemIds を設定します。両方は設定しないでください。
messageConfigs[]

object (MessageConfig)

必須。言語ごとのアップセル メッセージ。
upsoldItemIds[]

string

省略可。このメッセージでアップセルされるアイテムの ID。これまたは upsoldItems を設定します。両方は設定しないでください。

MessageConfig

アップセルに使用する言語固有のメッセージ。

JSON 表現 
{
  "languageCode": string,
  "messageText": string
}
フィールド
languageCode

string

必須。このメッセージに使用する言語のコード。BCP-47 言語コード（「en-US」や「fr-CA」など）。
messageText

string

必須。言語固有のメッセージ テキスト。

ClosingOffer

お客様が注文を完了した後に、特定の商品をアップセルします。

JSON 表現 
{
  "closingMessages": [
    {
      object (ClosingMessage)
    }
  ]
}
フィールド
closingMessages[]

object (ClosingMessage)

必須。適用するクロージング オファーのアップセル。

ClosingMessage

アップセル メッセージの終了設定。

JSON 表現 
{
  "offerMessage": {
    object (OfferMessage)
  },
  "skipTerms": [
    string
  ]
}
フィールド
offerMessage

object (OfferMessage)

必須。オファー メッセージの設定。
skipTerms[]

string

省略可。これらの用語のいずれかが、お客様の注文にすでに含まれているアイテムの名前に含まれている場合、このアップセルはスキップされます。

CelUpsell

一連のアイテムをユーザーにプロアクティブにアップセルするコンテキスト条件を定義する、事前計算されたルールを表します。

JSON 表現 
{
  "conditionExpression": string,
  "suggestedMenuItems": [
    string
  ],
  "triggerReason": string,
  "priority": integer,
  "suggestedModifiers": [
    string
  ],
  "suggestedModifierGroups": [
    {
      object (SuggestedModifierGroup)
    }
  ],
  "maxModifierPerGroup": integer,
  "suggestionOnly": boolean
}
フィールド
conditionExpression

string

必須。現在のセッション状態（Order と ClientSessionMetadata）に対して評価される CEL（Common Expression Language）文字列。True と評価された場合、ルールがトリガーされます。例: "context.weather_condition == 'HOT' && order.items.size() > 0"
suggestedMenuItems[]

string

必須。このルールがトリガーされた場合に提案するアイテムのセマンティック名。
triggerReason

string

省略可。会話型 LLM に提供される自然言語による指示。このアップセルが行われる理由を説明し、自然なアップセルを形成できるようにします。例: "Suggest a cold drink because it is a hot day."
priority

integer

省略可。このルールの priority。数字が大きいほど優先度が高くなります。複数のルールがトリガーされた場合は、優先度が最も高いルールの候補が優先されます。省略した場合、priority のデフォルトは 0 になります。
suggestedModifiers[]

string

省略可。このルールがトリガーされた場合に提案する修飾子のセマンティック名。
suggestedModifierGroups[]

object (SuggestedModifierGroup)

省略可。このルールがトリガーされた場合に提案する修飾子グループ。
maxModifierPerGroup

integer

省略可。グループごとに提案する修飾子の最大数。
suggestionOnly

boolean

省略可。実際のアップセルではなく、推奨されるオプションをユーザーに表示するだけです。

SuggestedModifierGroup

推奨される修飾子グループ。

JSON 表現 
{
  "name": string,
  "suggestedModifiers": [
    string
  ]
}
フィールド
name

string

省略可。修飾子グループのセマンティック名。
suggestedModifiers[]

string

省略可。このグループ内で提案する修飾子のセマンティック名。

挨拶

特定の言語の応答メッセージを表します。

JSON 表現 
{
  "languageCode": string,
  "greetingPhrases": [
    string
  ]
}
フィールド
languageCode

string

省略可。挨拶フレーズの言語コード。BCP-47 言語コード（「en-US」や「fr-CA」など）。
greetingPhrases[]

string

省略可。指定された言語の挨拶フレーズのリスト。

FeaturesConfig

エージェント機能の構成。エージェントのカスタム指示とツールの生成に使用されるフィーチャー トグルのリスト。

JSON 表現 
{
  "orderPickup": {
    object (OrderPickup)
  },
  "orderDineIn": {
    object (OrderDineIn)
  },
  "nameCollection": {
    object (NameCollection)
  },
  "confirmOrderInfoAtStart": boolean,
  "confirmOrderInfoOnFinalize": boolean,
  "getOrderPrices": {
    object (GetOrderPrices)
  },
  "endSessionWithCheckoutRequest": {
    object (EndSessionWithCheckoutRequest)
  },
  "enableAddressCollection": {
    object (EnableAddressCollection)
  },
  "supportCashPayment": {
    object (SupportCashPayment)
  },
  "budgetBasedOrdering": boolean
}
フィールド
orderPickup

object (OrderPickup)

省略可。注文受け取り機能の設定。
orderDineIn

object (OrderDineIn)

省略可。「店内で食事」機能の構成。
nameCollection

object (NameCollection)

省略可。名前収集機能の構成。
confirmOrderInfoAtStart
(deprecated)

boolean

省略可。セッションの開始時に注文情報を確認するかどうか。非推奨: confirmOrderInfoOnFinalize に置き換えられました。
confirmOrderInfoOnFinalize

boolean

省略可。注文を確定する際に注文情報を確認するかどうか。
getOrderPrices

object (GetOrderPrices)

省略可。注文価格機能の構成を取得します。
endSessionWithCheckoutRequest

object (EndSessionWithCheckoutRequest)

省略可。チェックアウト リクエスト機能の構成でセッションを終了します。
enableAddressCollection

object (EnableAddressCollection)

省略可。お届け先住所の収集機能の設定を有効にします。
supportCashPayment

object (SupportCashPayment)

省略可。現金支払い機能の設定をサポートします。
budgetBasedOrdering

boolean

省略可。予算ベースの注文を有効にするかどうか。

OrderPickup

この型にはフィールドがありません。

お客様がエージェントを介して料理を注文し、受け取ることができるようにします。

OrderDineIn

この型にはフィールドがありません。

お客様がエージェントを介して店内飲食の料理を注文できるようにします

NameCollection

この型にはフィールドがありません。

エージェントがセッション中にお客様の名前を収集できるようにします。

GetOrderPrices

この型にはフィールドがありません。

エージェントが POS から注文価格を取得できるようにします。

EndSessionWithCheckoutRequest

この型にはフィールドがありません。

エージェントがチェックアウト リクエストでセッションを終了できるようにします。

EnableAddressCollection

この型にはフィールドがありません。

エージェントはセッション中にお客様のお届け先住所を収集できる。

SupportCashPayment

この型にはフィールドがありません。

エージェントが現金支払いをサポートできるようにします。

InteractionMode

エージェントのインタラクション モード。

列挙型
INTERACTION_MODE_UNSPECIFIED インタラクション モードが指定されていません。
ORDER_TAKING エージェントは双方向の会話に参加して注文を受けます。
LISTEN_ONLY エージェントは聞くだけで、話しません。

DisambiguationStrategy

曖昧性除去コントロールの戦略構成。

JSON 表現 
{
  "mappings": [
    {
      object (DisambiguationMapping)
    }
  ]
}
フィールド
mappings[]

object (DisambiguationMapping)

省略可。構成済みの曖昧さ回避マッピング。

DisambiguationMapping

無効な用語を修正したり、あいまいな項目を明確にしたりするためのマッピング ルール。

JSON 表現 
{
  "type": enum (Type),
  "customerTerms": [
    string
  ],
  "targets": [
    {
      object (TargetItem)
    }
  ],
  "customInstruction": string
}
フィールド
type

enum (Type)

必須。曖昧さ回避ルールのオペレーション タイプ。
customerTerms[]

string

必須。お客様の発話またはショートカット文字列。各顧客用語は 100 文字以内にする必要があります。
targets[]

object (TargetItem)

必須。ネストされた修飾子を含む、提案または明確化する完全に構造化されたターゲット メニュー項目。
customInstruction

string

省略可。オプションのカスタム条件付きマクロ指示またはフレーズのヒント。

種類

曖昧さ回避ルールのオペレーション タイプ。

列挙型
TYPE_UNSPECIFIED 未指定のルールタイプ。
SINGLE_TARGET 単一ターゲットのマッピング（ショートカット、カスタム コンボ構成、有効な類義語）に使用されます。
INVALID_ITEM 無効な商品、在庫切れの商品、競合他社の製品に使用されます。
DISAMBIGUATION 複数の有効なターゲット オプションの中から明確化が必要な、あいまいな入力に使用されます。

TargetItem

構造化アイテムの代替ターゲット。

JSON 表現 
{
  "itemName": string,
  "modifiers": [
    {
      object (TargetModifier)
    }
  ],
  "itemId": string
}
フィールド
itemName

string

必須。メニュー カタログ内のアイテム名。
modifiers[]

object (TargetModifier)

省略可。このターゲットに適用する構造化修飾子。
itemId

string

省略可。メニュー カタログ内のアイテムの一意の ID（menu.proto に直接リンク）。

TargetModifier

対象アイテムに適用する構造化修飾子。

JSON 表現 
{
  "modifierName": string,
  "modifierGroupName": string,
  "modifierId": string,
  "modifierGroupId": string
}
フィールド
modifierName

string

必須。カタログ エントリに直接一致する修飾子名。
modifierGroupName

string

省略可。修飾子をバインドする修飾子グループ名（省略可）。
modifierId

string

省略可。メニュー カタログ内の修飾子の一意の ID（menu.proto に直接リンク）。
modifierGroupId

string

省略可。メニュー カタログ内の修飾子グループの一意の ID。

状態

チャネル構成のステータス。

列挙型
STATE_UNSPECIFIED ステータスが指定されていません。
DRAFT チャネル構成はドラフトであり、まだ使用する準備ができていません。
ACTIVE チャネル構成はアクティブで、使用できます。
PROMOTED チャネル構成がプロモートされます。

種類

チャネル構成のタイプ。

列挙型
TYPE_UNSPECIFIED タイプは指定されていません。
UPSELL_STRATEGY チャネル構成はアップセル戦略用です。
AGENT_CUSTOMIZATION チャネル構成はエージェントのカスタマイズ用です。

SupplementalInstructions

補足指示の構成。

JSON 表現 
{
  "freeformInstructions": string
}
フィールド
freeformInstructions

string

省略可。プロンプトに含まれる自由形式の指示。

トーン

エージェントのトーン。

列挙型
TONE_UNSPECIFIED トーンが指定されていません。
CONCISE_AND_DIRECT エージェントのトーンは簡潔で直接的です。
PROFESSIONAL_AND_FORMAL エージェントのトーンはプロフェッショナルでフォーマルです。
FRIENDLY エージェントの話し方は親しみやすい。

メソッド

create

 ChannelConfig を作成します。

delete

 指定された ChannelConfig を削除します。

get

 ChannelConfig を取得します。

list

 ChannelConfig を一覧表示します。

patch

 指定された ChannelConfig を更新します。

promote

 指定されたチャンネル構成をプロモートします。