Method: projects.locations.sessions.processOrder

1 ターンのロジックを実行してユーザー入力を処理し、結果を返します。

HTTP リクエスト

POST https://foodorderingaiagent.googleapis.com/v1beta/{config.session=projects/*/locations/*/sessions/*}:processOrder

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
config.session

string

必須。注文のセッション。形式: projects/{project}/locations/{location}/sessions/{session}

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現
{
  "config": {
    "session": string,
    "store": string,
    "laneId": string,
    "enableEchoCancellation": boolean,
    "daypartId": string,
    "userInfo": {
      "preferredName": string,
      "paymentInfo": {
        object (PaymentInfo)
      },
      "deliveryAddress": string,
      "pastOrders": [
        {
          object (PastOrder)
        }
      ],
      "loyaltyInfo": {
        object (LoyaltyInfo)
      },
      "phoneNumber": string,
      "userId": string,
      "savedDeliveryAddress": {
        object (DeliveryAddress)
      }
    },
    "orderType": enum (OrderType),
    "initialOrder": {
      "items": [
        {
          object (OrderItem)
        }
      ],
      "metadata": {
        object (OrderMetadata)
      },
      "fulfillment": {
        object (OrderFulfillment)
      },
      "priceInfo": {
        object (OrderPriceInfo)
      },
      "externalOrderId": string,
      "orderPayment": {
        object (OrderPayment)
      }
    },
    "featureGate": {
      "triggerOfferEngineOnDemand": boolean,
      "triggerLoyaltyOnDemand": boolean,
      "triggerOrderMediaAssistantOnDemand": boolean,
      "menuResponseEnabled": boolean,
      "revampedPaymentFlowEnabled": boolean,
      "updatedOrderStateEnabled": boolean,
      "enableOrderStatusRetrieval": boolean
    },
    "initialUtterance": string,
    "clientAppInfo": {
      "deviceModel": string,
      "osVersion": string,
      "sdkVersion": string
    },
    "mode": enum (SessionMode),
    "channelType": enum (ChannelType),
    "enableListenOnlyDualChannel": boolean,
    "testSessionStartTime": string
  },
  "turnType": enum (TurnType),

  // Union field input can be only one of the following:
  "textInput": {
    object (TextInput)
  },
  "audioInput": {
    object (AudioInput)
  },
  "eventInput": {
    object (EventInput)
  },
  "clientExecutionResult": {
    object (ClientExecutionResult)
  },
  "blobInput": {
    object (Blob)
  }
  // End of list of possible types for union field input.
}
フィールド
config.store

string

必須。注文が行われている店舗。形式: projects/{project}/locations/{location}/brands/{brand}/stores/{store}

config.laneId

string

省略可。特定のドライブスルー レーンの ID。

config.enableEchoCancellation

boolean

省略可。セッションでエコー キャンセラを有効にするかどうか。有効にすると、クライアントは AudioInput で customerAudio と crewAudio を提供する必要があります。

config.daypartId

string

省略可。朝食、昼食、夕食など、フードメニューの時間帯。これは、注文に使用するメニューを決定するために使用されます。

config.userInfo

object (UserInfo)

省略可。エージェントと共有されたエンドユーザーの個人情報。

config.orderType
(deprecated)

enum (OrderType)

省略可。非推奨: 代わりに initialOrder.fulfillment.fulfillment_type を使用してください。発注する注文のタイプ。

config.initialOrder

object (Order)

省略可。エージェント セッションを開始する前の最初の注文。指定されている場合、エージェントはこれを初期注文ステータスとして使用します。

config.featureGate

object (FeatureGate)

省略可。セッションのフィーチャー ゲート。これは、セッションの機能を有効または無効にするために使用されます。

config.initialUtterance

string

省略可。会話を開始するためのクライアントからの最初の発話。指定すると、エージェントはこれをユーザーの最初の発話として使用し、グリーティング メッセージから開始しません。

config.clientAppInfo

object (ClientAppInfo)

省略可。クライアント アプリケーションとデバイス環境に関する情報。

config.mode

enum (SessionMode)

省略可。セッションのモード。

config.channelType

enum (ChannelType)

省略可。エージェントとのコミュニケーションに使用されるチャネルの種類。

config.enableListenOnlyDualChannel

boolean

省略可。セッションでリッスン専用デュアル チャンネルを有効にするかどうか。有効にすると、クライアントは AudioInput で customerAudio と crewAudio を提供し、CES はメディア処理サーバーで EAC と合計を行います。

config.testSessionStartTime

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"。

turnType

enum (TurnType)

省略可。セッション ライフサイクルにおけるリクエストの位置を明示的に示すインジケーター。クライアントが、初回セッション設定変数を挿入するタイミングを決定論的に制御できるようにします。

共用体フィールド input。クライアントからの入力。input は次のいずれかになります。
textInput

object (TextInput)

クライアントからのテキスト入力。

audioInput

object (AudioInput)

クライアントからの音声入力。

eventInput

object (EventInput)

クライアントからのイベント入力。

clientExecutionResult

object (ClientExecutionResult)

クライアント実行リクエストの結果。

blobInput

object (Blob)

汎用バイナリデータ入力。http://google3/google/cloud/ces/v1main/session_service.proto?l=720 をミラーリングします。

レスポンスの本文

FoodOrderingService.ProcessOrder に対するレスポンス メッセージです。機能的には、BidiProcessOrderResponse のフィールドからストリーミング固有のフィールドを除いたものが含まれます。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

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

object (BidiProcessOrderResponse)

出力専用。リクエストに対するエージェントのレスポンスのリスト。順番に返されます。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。

TextInput

クライアントからのテキスト入力。クライアントは、音声の代わりにテキスト入力をエージェントに送信することもできます。クライアントは、テキスト入力または音声入力のいずれかを使用する必要があります。両方を使用することはできません。

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

string

必須。クライアントからのテキスト発話。

AudioInput

クライアントからの音声入力。入力音声には、お客様、乗務員などの複数のチャンネルが含まれる場合があります。これらはすべて同期され、構成で指定された形式にする必要があります。音声ヘッダーは含めないでください。デフォルトでは、音声は 16 ビットのリニア PCM 音声エンコードと 16, 000 Hz のサンプルレートを使用する必要があります。すべてのチャネルの合計バイト数は 25,600 バイト未満にする必要があります。

JSON 表現
{
  "customerAudio": string,
  "crewAudio": string
}
フィールド
customerAudio

string (bytes format)

必須。お客様の音声データ。

Base64 でエンコードされた文字列。

crewAudio

string (bytes format)

省略可。乗組員の音声データ。これは、お客様と同じレーンにいるクルーメンバー用のオプションのオーディオ チャンネルであり、エコー キャンセラの参照オーディオとして機能します。

Base64 でエンコードされた文字列。

EventInput

クライアントからのイベント入力。これは、エージェント内で特定のイベントをトリガーするために使用されます。

JSON 表現
{

  // Union field event can be only one of the following:
  "driveOffEvent": {
    object (DriveOffEvent)
  },
  "crewInterjectionEvent": {
    object (CrewInterjectionEvent)
  },
  "updateOrderStateEvent": {
    object (OrderStateUpdateEvent)
  },
  "clientEscalationEvent": {
    object (ClientEscalationEvent)
  },
  "customizedInputEvent": {
    object (CustomizedInputEvent)
  },
  "callerHangupEvent": {
    object (CallerHangupEvent)
  },
  "posErrorInput": {
    object (PosErrorEvent)
  }
  // End of list of possible types for union field event.
}
フィールド
共用体フィールド event。次の ID: 10 トリガーするイベント。event は次のいずれかになります。
driveOffEvent

object (DriveOffEvent)

ドライブオフ イベント。

crewInterjectionEvent

object (CrewInterjectionEvent)

クルーの割り込みイベント。

updateOrderStateEvent

object (OrderStateUpdateEvent)

注文ステータスのクライアントサイドの更新。

clientEscalationEvent

object (ClientEscalationEvent)

クライアントサイドのエスカレーション イベント。

customizedInputEvent

object (CustomizedInputEvent)

カスタマイズされた入力イベント。

callerHangupEvent

object (CallerHangupEvent)

省略可。発信者のハングアップ イベント。

posErrorInput

object (PosErrorEvent)

省略可。POS エラーイベント。

DriveOffEvent

ドライブオフ イベント。これは、お客様が車で出発したことを示します。このイベントの後、セッションは終了します。

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

string

省略可。ドライブオフの理由(「注文完了」、「予期しないドライブオフ」など)。

CrewInterjectionEvent

クルーの割り込みイベント。これは、クルーメンバーがセッションに介入したことを示します。このイベントの後、セッションは終了します。

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

string

省略可。クルーメンバーが介入したモード(「ヘッドセット」、「POS」など)。

OrderStateUpdateEvent

注文ステータスの更新リクエスト。このイベントは、クライアント側で注文が更新されたとき(従来のタッチ インターフェースで商品が追加または削除されたときなど)に送信する必要があります。

JSON 表現
{
  "order": {
    object (Order)
  }
}
フィールド
order

object (Order)

必須。このセッションに関連付けられている注文の更新された状態。

ClientEscalationEvent

クライアントがセッションを人間のエージェントにエスカレーションしていることを示します。

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

string

省略可。クライアント エスカレーションの理由(「payment-declined」、「pos-error」、「integration-error」など)。

CustomizedInputEvent

このフィールドを使用すると、Food AI クライアントはカスタマイズされたイベントをエージェントに送信できます。デフォルトでは、これは no-op です。この機能を有効にするには、カスタマー サポートにお問い合わせください。

JSON 表現
{
  "input": {
    object
  }
}
フィールド
input

object (Struct format)

必須。クライアントからエージェントへの入力。

CallerHangupEvent

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

お客様が通話を途中で切ったことを示します(AI への嫌悪感など)。

PosErrorEvent

販売時点情報管理(POS)固有の障害。

JSON 表現
{
  "errorMessages": [
    string
  ],
  "affectedItemUids": [
    string
  ],
  "affectedExternalIds": [
    string
  ],
  "metadata": {
    string: string,
    ...
  }
}
フィールド
errorMessages[]

string

省略可。エラーの説明(人が読める形式)のリスト。複数の問題が同時に発生した場合(複数の商品が在庫なしの場合など)や、1 つの複雑なエラーの詳細な内訳を提供する場合、複数のエラー メッセージを提供できます。これらのメッセージは、エージェントがお客様に通知するため、またはロギング目的で使用できます。

affectedItemUids[]

string

省略可。エラーの原因となった、デリバリー&テイクアウト AI エージェントによって生成された一意のアイテム UID。UpdatedOrderState.OrderItem.uid に対応します。

affectedExternalIds[]

string

省略可。エラーの原因となった外部 ID(メニューから取得)のリスト。POS の実際の表現と一致している必要があります。通常、menu.proto の統合属性(ItemIntegrationAttributes や ModifierIntegrationAttributes など)にあります。

metadata

map (key: string, value: string)

省略可。デバッグまたはブランド固有のシグナリング用の自由形式のメタデータ。ブランド固有のエラーコードまたはカテゴリを渡すために使用できます(例: {"BRAND_ERROR_CODE": "OUT_OF_STOCK"})。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

ClientExecutionResult

クライアント実行リクエストの結果。

JSON 表現
{
  "executionId": string,

  // Union field response can be only one of the following:
  "finalizeOrderResponse": {
    object (FinalizeOrderResponse)
  },
  "submitOrderResponse": {
    object (SubmitOrderResponse)
  },
  "orderPricesResponse": {
    object (OrderPricesResponse)
  },
  "validateDeliveryAddressResponse": {
    object (ValidateDeliveryAddressResponse)
  },
  "orderStatusResponse": {
    object (OrderStatusResponse)
  }
  // End of list of possible types for union field response.
}
フィールド
executionId

string

必須。この結果の実行リクエストの ID。

共用体フィールド response。実行の具体的な結果。response は次のいずれかになります。
finalizeOrderResponse

object (FinalizeOrderResponse)

注文の確定結果。

submitOrderResponse

object (SubmitOrderResponse)

注文の送信結果。

orderPricesResponse

object (OrderPricesResponse)

注文価格の取得結果。

validateDeliveryAddressResponse

object (ValidateDeliveryAddressResponse)

お届け先住所の検証結果。

orderStatusResponse

object (OrderStatusResponse)

注文ステータスの取得結果。

FinalizeOrderResponse

注文の確定結果。

JSON 表現
{
  "paymentFlowEnabled": boolean,
  "paymentInfo": {
    object (PaymentInfo)
  },
  "totalAmountDue": {
    object (Money)
  },
  "orderPriceInfo": {
    object (OrderPriceInfo)
  }
}
フィールド
paymentFlowEnabled

boolean

省略可。エージェントで支払い処理フローを有効にするかどうか。

paymentInfo

object (PaymentInfo)

省略可。お客様のお支払い情報。paymentFlowEnabled が false の場合は、何も行いません。

totalAmountDue

object (Money)

省略可。注文の合計金額。

orderPriceInfo

object (OrderPriceInfo)

省略可。注文の詳細な価格情報。

SubmitOrderResponse

注文の送信結果。

JSON 表現
{
  "success": boolean,
  "estimatedReadyDuration": string
}
フィールド
success

boolean

必須。注文が正常に送信されたかどうか。

estimatedReadyDuration

string (Duration format)

省略可。注文の準備が完了するまでの推定時間。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。

OrderPricesResponse

注文価格の取得結果。

JSON 表現
{
  "success": boolean,
  "orderPriceInfo": {
    object (OrderPriceInfo)
  }
}
フィールド
success

boolean

必須。注文価格が正常に取得されたかどうか。

orderPriceInfo

object (OrderPriceInfo)

省略可。すべての割引、手数料、税金などを差し引いた後の注文合計額

ValidateDeliveryAddressResponse

お届け先住所の検証結果。

JSON 表現
{
  "success": boolean,
  "validationStatus": enum (ValidationStatus)
}
フィールド
success

boolean

必須。検証がエラーなしで完了したかどうか。

validationStatus

enum (ValidationStatus)

必須。お届け先住所の検証ステータス。

OrderStatusResponse

注文ステータスの取得結果。

JSON 表現
{
  "success": boolean
}
フィールド
success

boolean

必須。注文ステータスが正常に取得されたかどうか。

Blob

会話内の blob 入力または出力を表します。

JSON 表現
{
  "mimeType": string,
  "data": string
}
フィールド
mimeType

string

必須。ソースデータの IANA 標準 MIME タイプ。

data

string (bytes format)

必須。blob の未加工バイト。

Base64 でエンコードされた文字列。

構成

セッションとデリバリー&テイクアウト プロパティの構成。各接続の開始時に、クライアントはまず構成メッセージを送信する必要があります。これは、セッションを開始する他のリクエストよりも前に行う必要があります。クライアントが切断された場合は、再接続時に同じ構成メッセージを繰り返す必要があります。

JSON 表現
{
  "session": string,
  "store": string,
  "laneId": string,
  "enableEchoCancellation": boolean,
  "daypartId": string,
  "userInfo": {
    object (UserInfo)
  },
  "orderType": enum (OrderType),
  "initialOrder": {
    object (Order)
  },
  "featureGate": {
    object (FeatureGate)
  },
  "initialUtterance": string,
  "clientAppInfo": {
    object (ClientAppInfo)
  },
  "mode": enum (SessionMode),
  "channelType": enum (ChannelType),
  "enableListenOnlyDualChannel": boolean,
  "testSessionStartTime": string
}
フィールド
session

string

必須。注文のセッション。形式: projects/{project}/locations/{location}/sessions/{session}

store

string

必須。注文が行われている店舗。形式: projects/{project}/locations/{location}/brands/{brand}/stores/{store}

laneId

string

省略可。特定のドライブスルー レーンの ID。

enableEchoCancellation

boolean

省略可。セッションでエコー キャンセラを有効にするかどうか。有効にすると、クライアントは AudioInput で customerAudio と crewAudio を提供する必要があります。

daypartId

string

省略可。朝食、昼食、夕食など、フードメニューの時間帯。これは、注文に使用するメニューを決定するために使用されます。

userInfo

object (UserInfo)

省略可。エージェントと共有されたエンドユーザーの個人情報。

orderType
(deprecated)

enum (OrderType)

省略可。非推奨: 代わりに initialOrder.fulfillment.fulfillment_type を使用してください。発注する注文のタイプ。

initialOrder

object (Order)

省略可。エージェント セッションを開始する前の最初の注文。指定されている場合、エージェントはこれを初期注文ステータスとして使用します。

featureGate

object (FeatureGate)

省略可。セッションのフィーチャー ゲート。これは、セッションの機能を有効または無効にするために使用されます。

initialUtterance

string

省略可。会話を開始するためのクライアントからの最初の発話。指定すると、エージェントはこれをユーザーの最初の発話として使用し、グリーティング メッセージから開始しません。

clientAppInfo

object (ClientAppInfo)

省略可。クライアント アプリケーションとデバイス環境に関する情報。

mode

enum (SessionMode)

省略可。セッションのモード。

channelType

enum (ChannelType)

省略可。エージェントとのコミュニケーションに使用されるチャネルの種類。

enableListenOnlyDualChannel

boolean

省略可。セッションでリッスン専用デュアル チャンネルを有効にするかどうか。有効にすると、クライアントは AudioInput で customerAudio と crewAudio を提供し、CES はメディア処理サーバーで EAC と合計を行います。

testSessionStartTime

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"。

UserInfo

Food AI エージェントと共有されるエンドユーザーの個人情報。

JSON 表現
{
  "preferredName": string,
  "paymentInfo": {
    object (PaymentInfo)
  },
  "deliveryAddress": string,
  "pastOrders": [
    {
      object (PastOrder)
    }
  ],
  "loyaltyInfo": {
    object (LoyaltyInfo)
  },
  "phoneNumber": string,
  "userId": string,
  "savedDeliveryAddress": {
    object (DeliveryAddress)
  }
}
フィールド
preferredName

string

省略可。エージェントがユーザーに呼びかける際に使用するユーザーの名前。Food AI クライアントは、ユーザーのプロフィールに基づいて優先される名前を選択し、ブランドの規則(名またはフルネームを使用するなど)に沿っていることを確認する必要があります。

paymentInfo

object (PaymentInfo)

省略可。ユーザーのお支払い情報。

deliveryAddress
(deprecated)

string

省略可。非推奨: 代わりに savedDeliveryAddress を使用してください。ユーザーの保存済みのお届け先住所。

pastOrders[]

object (PastOrder)

省略可。お客様の注文履歴。

loyaltyInfo

object (LoyaltyInfo)

省略可。ユーザーのポイント プログラム情報。

phoneNumber

string

省略可。ユーザーの電話番号。

userId

string

省略可。クライアントのシステムにおけるユーザーの固有識別子。

savedDeliveryAddress

object (DeliveryAddress)

省略可。ユーザーの保存済みのお届け先住所。既存の文字列 deliveryAddress フィールドを置き換えます。

PastOrder

お客様の過去の注文。

JSON 表現
{
  "order": {
    object (Order)
  }
}
フィールド
order

object (Order)

必須。元の Food AI 注文。

LoyaltyInfo

顧客のポイント情報を表します。

JSON 表現
{
  "loyaltyAmount": {
    object (LoyaltyAmount)
  }
}
フィールド
loyaltyAmount

object (LoyaltyAmount)

必須。ポイントの金額。これは、ポイント残高または消費されたポイントです。

OrderType

発注する注文のタイプ。

列挙型
ORDER_TYPE_UNSPECIFIED 注文タイプが指定されていません。
ORDER_TYPE_DRIVE_THROUGH ドライブスルーの注文です。
ORDER_TYPE_CARRY_OUT 注文は持ち帰り用です。
ORDER_TYPE_DELIVERY 注文が配送である。

FeatureGate

セッションのフィーチャー ゲート。これは、セッションの機能を有効または無効にするために使用されます。

JSON 表現
{
  "triggerOfferEngineOnDemand": boolean,
  "triggerLoyaltyOnDemand": boolean,
  "triggerOrderMediaAssistantOnDemand": boolean,
  "menuResponseEnabled": boolean,
  "revampedPaymentFlowEnabled": boolean,
  "updatedOrderStateEnabled": boolean,
  "enableOrderStatusRetrieval": boolean
}
フィールド
triggerOfferEngineOnDemand

boolean

省略可。一部のユーザーのみを対象とする場合、設定すると、支払いフローで特典エンジンがオプションになり、ユーザーがリクエストした場合にのみトリガーされます。

triggerLoyaltyOnDemand

boolean

省略可。限定されたユーザーのみを対象とする場合、設定すると、ポイント プログラムは支払いフローでオプションとなり、ユーザーがリクエストした場合にのみトリガーされます。

triggerOrderMediaAssistantOnDemand

boolean

省略可。一部のユーザーのみを対象として、設定されている場合、注文メディア アシスタントはオプションとなり、ユーザーがリクエストした場合にのみトリガーされます。

menuResponseEnabled

boolean

省略可。設定されている場合、BidiProcessOrderResponse でメニューデータをクライアントに返します。

revampedPaymentFlowEnabled

boolean

省略可。一部のユーザーのみを対象として、設定されている場合は、刷新されたバージョンの支払いフローが使用されます。

updatedOrderStateEnabled

boolean

省略可。設定されている場合、legacyOrderStateResponse の代わりに updatedOrderState が返されます。

enableOrderStatusRetrieval

boolean

省略可。設定すると、エージェントは注文ステータスの取得をサポートします。

ClientAppInfo

クライアント アプリケーションとデバイス環境に関する情報。これは主にロギング、分析、デバッグに使用されます。

JSON 表現
{
  "deviceModel": string,
  "osVersion": string,
  "sdkVersion": string
}
フィールド
deviceModel

string

省略可。クライアントのデバイスモデル(例: 「iPhone 13」、「Google Pixel 7」、「Kiosk v2」)。

osVersion

string

省略可。クライアントのオペレーティング システムのバージョン(例: 「iOS 16.1」、「Android 13」)。

sdkVersion

string

省略可。クライアント SDK またはアプリケーション ソフトウェアのバージョン。

SessionMode

セッションのモード。

列挙型
SESSION_MODE_UNSPECIFIED セッション モードが指定されていません。
HYBRID セッションは音声とテキストの両方をサポートしています。これがデフォルトです。
TEXT セッションはテキストのみです。

TurnType

セッション内の単項リクエストのライフサイクル位置を表します。

列挙型
TURN_TYPE_UNSPECIFIED 右左折タイプが指定されていません。
INITIALIZE このリクエストが単項モードでセッションを初期化することを明示的に示します。設定すると、初回セッション変数(店舗のメタデータやメニューなど)が CES に挿入されます。
SUBSEQUENT 後続の会話ターンまたはセッション中の更新を明示的に示します。設定すると、入力トークンの爆発を防ぐために、初回セッション変数が省略されます。

BidiProcessOrderResponse

FoodOrderingService.BidiProcessOrder メソッドから返される最上位のメッセージ。

JSON 表現
{

  // Union field response can be only one of the following:
  "agentAudio": {
    object (AgentAudio)
  },
  "speechRecognition": {
    object (SpeechRecognition)
  },
  "legacyOrderStateResponse": {
    object
  },
  "interruptionSignal": {
    object (InterruptionSignal)
  },
  "agentEvent": {
    object (AgentEvent)
  },
  "clientExecutionRequest": {
    object (ClientExecutionRequest)
  },
  "updatedOrderState": {
    object (UpdatedOrderState)
  },
  "agentText": {
    object (AgentText)
  },
  "suggestedOptions": {
    object (SuggestedOptions)
  },
  "sentimentMeasurement": {
    object (SentimentMeasurement)
  },
  "turnCompleted": {
    object (TurnCompleted)
  },
  "endSession": {
    object (EndSession)
  },
  "recommendedOrders": {
    object (RecommendedOrders)
  }
  // End of list of possible types for union field response.
}
フィールド
共用体フィールド response。エージェントからの回答。response は次のいずれかになります。
agentAudio

object (AgentAudio)

エージェントからの音声レスポンス。

speechRecognition

object (SpeechRecognition)

エージェントからの音声認識結果。

legacyOrderStateResponse

object (Struct format)

セッションの以前の注文ステータスのレスポンス。

interruptionSignal

object (InterruptionSignal)

音声入力から割り込み信号が検出されました。

agentEvent

object (AgentEvent)

エージェントからのイベント。

clientExecutionRequest

object (ClientExecutionRequest)

リクエストはクライアントに転送されて実行されます。これは、注文にコードを追加するなど、クライアントサイドの実行に使用されます。

updatedOrderState

object (UpdatedOrderState)

注文ステータスの更新を示します。注文の完全な状態が含まれます。

agentText

object (AgentText)

エージェントからのテキスト レスポンス。

suggestedOptions

object (SuggestedOptions)

お客様に提案するオプション。

sentimentMeasurement

object (SentimentMeasurement)

このターンで測定されたリアルタイムの感情スコア。

turnCompleted

object (TurnCompleted)

「曲がり終えました」というメッセージ。

endSession

object (EndSession)

セッションが終了し、これが最後のターンであることを示します。

エージェントは、現在のターンで保留中のレスポンスの送信を完了してから、最後の turnCompleted メッセージを送信します。エージェントは新しいターンを開始しません。たとえば、2 ターンのセッションは次のようになります。

  • ターン 1
  • お客様の入力 1
  • ... エージェントのレスポンスと注文ステータスのメッセージ
  • turnCompleted
  • ターン 2
  • お客様の入力 2
  • ... エージェントのレスポンスと注文ステータスのメッセージ
  • endSession
  • ... エージェントの応答と注文ステータス メッセージを保留中
  • turnCompleted
recommendedOrders

object (RecommendedOrders)

エージェントからの推奨注文。

AgentAudio

エージェントからの音声レスポンス。

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

string (bytes format)

エージェントからの音声データ。

Base64 でエンコードされた文字列。

SpeechRecognition

エージェントからの音声認識結果。

JSON 表現
{
  "transcript": string,
  "languageCode": string,
  "isFinal": boolean
}
フィールド
transcript

string

検出された言語の音声入力から文字変換されたテキスト。

languageCode

string

文字起こしの言語コード。言語コードは BCP-47 形式(「en-US」など)にする必要があります。

isFinal

boolean

これがターンの最終的な音声文字変換であるかどうかを示します。

InterruptionSignal

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

エージェントの音声レスポンスが中断されたことを示します(エンドユーザーの割り込みなど)。クライアントは直ちに再生を停止する必要があります。

AgentEvent

クライアントがアクションを実行する必要があるエージェントからの特別なイベント。

JSON 表現
{

  // Union field event can be only one of the following:
  "restartOrder": {
    object (RestartOrder)
  }
  // End of list of possible types for union field event.
}
フィールド
共用体フィールド event。エージェントからのイベント。event は次のいずれかになります。
restartOrder

object (RestartOrder)

お客様が注文の再開をリクエストしている。

RestartOrder

お客様が注文のやり直しを希望している。

JSON 表現
{
  "confirmationStep": boolean
}
フィールド
confirmationStep

boolean

エージェントがお客様に再起動のリクエストを確認しています。

ClientExecutionRequest

クライアントサイドにコマンドの実行を求めるリクエスト。

JSON 表現
{
  "executionId": string,

  // Union field request can be only one of the following:
  "finalizeOrderRequest": {
    object (FinalizeOrderRequest)
  },
  "submitOrderRequest": {
    object (SubmitOrderRequest)
  },
  "orderPricesRequest": {
    object (OrderPricesRequest)
  },
  "validateDeliveryAddressRequest": {
    object (ValidateDeliveryAddressRequest)
  },
  "orderStatusRequest": {
    object (OrderStatusRequest)
  }
  // End of list of possible types for union field request.
}
フィールド
executionId

string

必須。この実行リクエストの一意の ID。

共用体フィールド request。実行する特定のリクエスト。request は次のいずれかになります。
finalizeOrderRequest

object (FinalizeOrderRequest)

注文を確定するリクエスト。

submitOrderRequest

object (SubmitOrderRequest)

注文を送信するリクエスト。

orderPricesRequest

object (OrderPricesRequest)

注文価格を取得するためのリクエスト。

validateDeliveryAddressRequest

object (ValidateDeliveryAddressRequest)

お届け先住所を検証するリクエスト。

orderStatusRequest

object (OrderStatusRequest)

注文ステータスを取得するリクエスト。

FinalizeOrderRequest

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

注文を確定するリクエスト。通常、このメッセージは、お客様が注文を完了して支払いを希望していることを示した場合にエージェントから送信されます。

SubmitOrderRequest

注文を送信するリクエスト。お客様から収集した必要な支払い情報がすべて含まれます。

JSON 表現
{
  "paymentInfo": {
    object (PaymentInfo)
  },
  "loyaltyInfo": {
    object (LoyaltyInfo)
  },
  "tipAmount": {
    object (Money)
  }
}
フィールド
paymentInfo

object (PaymentInfo)

必須。注文のお支払い情報。

loyaltyInfo

object (LoyaltyInfo)

省略可。注文に使用されたポイント。

tipAmount

object (Money)

省略可。注文のチップの金額。

OrderPricesRequest

注文価格を取得するためのリクエスト。

JSON 表現
{
  "order": {
    object (Order)
  }
}
フィールド
order

object (Order)

省略可。価格を取得する注文。指定されていない場合、リクエストはセッション内の既存の注文 / カートに対するものであると想定できます。

ValidateDeliveryAddressRequest

セッション中に収集されたお届け先住所を検証するリクエスト。

JSON 表現
{
  "deliveryAddress": {
    object (DeliveryAddress)
  }
}
フィールド
deliveryAddress

object (DeliveryAddress)

必須。検証するお届け先住所。

OrderStatusRequest

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

注文ステータスを取得するリクエスト。

UpdatedOrderState

注文ステータスの更新を表す、エージェントから返されるイベント。

JSON 表現
{
  "order": {
    object (Order)
  },
  "changed": boolean
}
フィールド
order

object (Order)

このセッションに関連付けられている注文の更新された状態。

changed

boolean

出力専用。注文ステータスに更新があるかどうか。

AgentText

エージェントからのテキスト レスポンス。

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

string

エージェントからのテキスト レスポンス。

SuggestedOptions

お客様に提案するオプション。

JSON 表現
{
  "suggestedModifierGroups": {
    object (SuggestedModifierGroups)
  },

  // Union field suggested_options can be only one of the following:
  "suggestedItems": {
    object (SuggestedItems)
  },
  "suggestedModifiers": {
    object (SuggestedModifiers)
  }
  // End of list of possible types for union field suggested_options.
}
フィールド
suggestedModifierGroups

object (SuggestedModifierGroups)

提案された修飾子のグループ。

共用体フィールド suggested_options。提案されたオプション。suggested_options は次のいずれかになります。
suggestedItems

object (SuggestedItems)

お客様に提案するアイテムのリスト。

suggestedModifiers

object (SuggestedModifiers)

お客様に提案する修飾子のリスト。

SuggestedItems

お客様に提案するアイテムのリスト。

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

object (SuggestedItem)

お客様に提案するアイテム。

SuggestedItem

お客様に提案するアイテム。

JSON 表現
{
  "itemId": string,
  "displayName": string,
  "image": {
    object (Image)
  },
  "basePrice": {
    object (Money)
  },
  "integrationAttributes": {
    object (ItemIntegrationAttributes)
  }
}
フィールド
itemId

string

メニュー内のアイテムの ID。

displayName

string

ユーザー インターフェースに表示される、このアイテムの人が読める名前。

image

object (Image)

UI でこのアイテムに表示する画像。

basePrice

object (Money)

商品アイテムの基本価格。これは、選択した修飾子の影響を受ける可能性があります。これは、商品アイテムの単位あたりの価格です。

integrationAttributes

object (ItemIntegrationAttributes)

ダウンストリーム統合に使用される、このエンティティに関連付けられたメタデータ。

SuggestedModifiers

お客様に提案する修飾子のリスト。

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

object (SuggestedModifier)

お客様に提案する修飾子。

parentUid

string

修飾子を適用する親アイテム / 修飾子の固有識別子。

SuggestedModifier

お客様に提案する修飾子。

JSON 表現
{
  "modifierId": string,
  "modifierGroupId": string,
  "modifierGroupDisplayName": string,
  "displayName": string,
  "image": {
    object (Image)
  },
  "priceAdjustment": {
    object (Money)
  },
  "integrationAttributes": {
    object (ModifierIntegrationAttributes)
  },
  "alreadyIncluded": boolean
}
フィールド
modifierId

string

メニュー内の修飾子の ID。

modifierGroupId

string

提案が承認された場合に、この修飾子を追加する修飾子グループの ID。

modifierGroupDisplayName

string

この修飾子が属する修飾子グループの表示名。

displayName

string

ユーザー インターフェースに表示される、このアイテムの人が読める名前。

image

object (Image)

UI でこのアイテムに表示する画像。

priceAdjustment

object (Money)

この修飾子に関連付けられている価格調整(存在する場合)。これは、修飾子の単位あたりの価格です。

integrationAttributes

object (ModifierIntegrationAttributes)

ダウンストリーム統合に使用される、このエンティティに関連付けられたメタデータ。

alreadyIncluded

boolean

この修飾子がすでに注文に含まれているかどうか。

SuggestedModifierGroups

お客様に提案する修飾子グループのリスト。

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

object (SuggestedModGroup)

お客様に提案する修飾子グループ。

SuggestedModGroup

お客様に提案する修飾子グループ。

JSON 表現
{
  "modifierGroupId": string,
  "displayName": string,
  "modifiers": [
    {
      object (SuggestedModifier)
    }
  ],
  "maxSelectionCount": integer,
  "minSelectionCount": integer,
  "maxSelectionCountPerModifier": integer
}
フィールド
modifierGroupId

string

メニュー内の修飾子グループの ID。

displayName

string

修飾子グループの表示名。

modifiers[]

object (SuggestedModifier)

このグループの修飾子。

maxSelectionCount

integer

このグループから選択できる修飾子の最大数。

minSelectionCount

integer

このグループから選択する必要がある修飾子の最小数。

maxSelectionCountPerModifier

integer

このグループ内で各修飾子を適用できる回数を制限します。

SentimentMeasurement

このターンで測定されたリアルタイムの感情スコア。

JSON 表現
{
  "score": number,
  "magnitude": number
}
フィールド
score

number

省略可。-1.0(ネガティブな感情)から 1.0(ポジティブな感情)の間の感情スコア。

magnitude

number

省略可。スコアに関係なく、感情の大きさ。

TurnCompleted

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

Food AI エージェントが現在の会話ターンの終了を検出し、このターンではこれ以上の出力を行わないことを示します。

EndSession

エージェントがセッションを終了したことを示します。正常に完了した(ユーザーが「さようなら」と言ったなど)か、)またはエージェントによるエスカレーション。

JSON 表現
{
  "type": enum (EndType),
  "reason": string,
  "posResponse": string,
  "agentResponse": string,
  "storeSchedule": {
    object (Schedule)
  }
}
フィールド
type

enum (EndType)

セッション終了イベントのタイプ。

reason

string

セッションを終了する理由。

posResponse

string

省略可。注文のチェックインに対する POS のレスポンス(省略可)。これは、POS 取引ステータスを表す不透明な文字列ペイロードです。

agentResponse

string

省略可。ユーザーに読み上げられるか表示される、エージェントの最終レスポンス メッセージ(省略可)。

storeSchedule

object (Schedule)

省略可。店舗のスケジュール。これは、終了タイプが STORE_CLOSED の場合にのみ設定されます。

EndType

セッション終了イベントのタイプ。

列挙型
END_TYPE_UNSPECIFIED 終了タイプが指定されていません。
DRIVE_OFF お客様が車で走り去った。
AGENT_ESCALATION エージェントがセッションを人間のエージェントにエスカレーションした。
CREW_INTERJECTION クルー メンバーがセッションに割り込んだ。
ORDER_COMPLETED 注文は正常に完了しており、これ以上の対応は必要ありません。
PAYMENT_FLOW_SUCCESS お支払いのフローが正常に完了し、これ以上の対応は必要ありません。
PAYMENT_FLOW_FAILURE 支払いフローが失敗した。
CLIENT_ESCALATION クライアントがセッションを人間のエージェントにエスカレーションした。
CALLER_HANGUP お客様が途中で電話を切った。
REQUESTED_CHECKOUT お客様がチェックアウトをリクエストしました。
REQUESTED_ORDER_STATUS お客様から注文ステータスについて問い合わせを受けた。
STORE_CLOSED 店舗が閉鎖されている。

RecommendedOrders

エージェントからユーザーに推奨される注文のリスト。

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

object (RecommendedOrder)

ユーザーに表示されるおすすめの注文。

RecommendedOrder

エージェントがユーザーに推奨する注文。

JSON 表現
{
  "order": {
    object (Order)
  }
}
フィールド
order

object (Order)

ユーザーに表示される推奨注文。