REST Resource: projects.locations.brands.sessionRecords

Resource: SessionRecord

Represents a single session record.

JSON representation 
{
  "name": string,
  "sessionStartTime": string,
  "storeId": string,
  "laneId": string,
  "interactions": [
    {
      object (Interaction)
    }
  ],
  "outcomeLabel": string,
  "outcomeGroupLabel": string,
  "audioRecordingPath": string,
  "order": {
    object (Order)
  },
  "sessionDuration": string,
  "upsellAttemptRecords": [
    {
      object (UpsellAttemptRecord)
    }
  ],
  "audioRecording": string,
  "trafficType": enum (TrafficType),
  "channelType": enum (ChannelType),
  "environment": string,
  "experimentMetadata": {
    object (ExperimentMetadata)
  },
  "menu": string
}
Fields
name

string

Identifier. The resource name of the SessionRecord. Format: projects/{project}/locations/{location}/brands/{brand}/sessionRecords/{sessionRecord}
sessionStartTime

string (Timestamp format)

Output only. The timestamp when the session started.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
storeId

string

Immutable. The ID of the store where the order was placed.
laneId

string

Immutable. The lane ID of the order session.
interactions[]

object (Interaction)

Output only. The conversation turns.
outcomeLabel

string

Output only. The final outcome label of the order.
outcomeGroupLabel

string

Output only. The group label for the outcome.
audioRecordingPath
(deprecated)

string

Output only. Deprecated: Use storagePath instead. Path to the full audio recording.
order

object (Order)

Output only. The order associated with the session record.
sessionDuration

string (Duration format)

Output only. Total duration of the session.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
upsellAttemptRecords[]

object (UpsellAttemptRecord)

Output only. Upsells performed during the session.
audioRecording

string (bytes format)

Output only. Audio recording for the session. This field is only populated when calling sessionRecords.get.

A base64-encoded string.
trafficType

enum (TrafficType)

Output only. The traffic type for the session.
channelType

enum (ChannelType)

Output only. The type of channel used for the session (e.g. drive-through, mobile app, phone call).
environment

string

Output only. The execution environment of the session (e.g. prod, preprod, preprod-au).
experimentMetadata

object (ExperimentMetadata)

Output only. The metadata associated with the experiment.
menu

string

Output only. The resource name of the menu active during the session. Format: projects/{project}/locations/{location}/menus/{menu}

Interaction

Represents a single interaction in a turn in the conversation.

JSON representation 
{
  "turnPosition": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "userUtterance": {
    object (UserUtterance)
  },
  "agentUtterance": {
    object (AgentUtterance)
  },
  "resolveOrder": {
    object (ResolveOrder)
  },
  "submitOrder": {
    object (SubmitOrder)
  },
  "matchIntent": {
    object (MatchIntent)
  },
  "clientExecution": {
    object (ClientExecution)
  },
  "clientOrderUpdate": {
    object (ClientOrderUpdate)
  },
  "suggestedOptions": {
    object (SuggestedOptions)
  }
  // End of mutually exclusive fields.
}
Fields
turnPosition

string (int64 format)

Output only. Turn position in the conversation.
The type of interaction. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
userUtterance

object (UserUtterance)

User utterance.
agentUtterance

object (AgentUtterance)

Agent utterance.
resolveOrder

object (ResolveOrder)

ResolveOrder call performed by the agent
submitOrder

object (SubmitOrder)

SubmitOrder call performed by the agent
matchIntent

object (MatchIntent)

MatchIntent call performed by the agent
clientExecution

object (ClientExecution)

ClientExecution call performed by the agent
clientOrderUpdate

object (ClientOrderUpdate)

Client-initiated order state update
suggestedOptions

object (SuggestedOptions)

Suggested options surfaced to the customer during the turn.
End of mutually exclusive fields.

UserUtterance

The user utterance.

JSON representation 
{
  "text": string,
  "createTime": string
}
Fields
text

string

The text of the user utterance.
createTime

string (Timestamp format)

Output only. The timestamp when the user utterance occurred.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

AgentUtterance

The agent utterance.

JSON representation 
{
  "text": string,
  "createTime": string
}
Fields
text

string

The text of the agent utterance.
createTime

string (Timestamp format)

Output only. The timestamp when the agent utterance occurred.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

ResolveOrder

The resolve order interaction.

JSON representation 
{
  "input": {
    object (ResolveOrderInput)
  },
  "output": {
    object (ResolveOrderOutput)
  }
}
Fields
input

object (ResolveOrderInput)

The input for the resolve order action.
output

object (ResolveOrderOutput)

The output for the resolve order action.

ResolveOrderInput

The input for the resolve order interaction.

JSON representation 
{
  "payload": {
    object
  }
}
Fields
payload

object (Struct format)

The payload for the resolve order interaction.

ResolveOrderOutput

The output for the resolve order interaction.

JSON representation 
{
  "payload": {
    object
  }
}
Fields
payload

object (Struct format)

The payload for the resolve order interaction output.

SubmitOrder

This type has no fields.

The submit order interaction.

MatchIntent

The match intent interaction.

JSON representation 
{
  "input": {
    object (MatchIntentInput)
  },
  "output": {
    object (MatchIntentOutput)
  }
}
Fields
input

object (MatchIntentInput)

The input for the match intent interaction.
output

object (MatchIntentOutput)

The output for the match intent interaction.

MatchIntentInput

The input for the match intent interaction.

JSON representation 
{
  "payload": {
    object
  }
}
Fields
payload

object (Struct format)

The payload for the match intent interaction input.

MatchIntentOutput

The output for the match intent interaction.

JSON representation 
{
  "payload": {
    object
  }
}
Fields
payload

object (Struct format)

The payload for the match intent interaction output.

ClientExecution

The client execution interaction.

JSON representation 
{
  "toolName": string,
  "input": {
    object (ClientExecutionInput)
  },
  "output": {
    object (ClientExecutionOutput)
  }
}
Fields
toolName

string

The tool name for the client execution interaction.
input

object (ClientExecutionInput)

The input for the client execution interaction.
output

object (ClientExecutionOutput)

The output for the client execution interaction.

ClientExecutionInput

The input for the client execution interaction.

JSON representation 
{
  "payload": {
    object
  }
}
Fields
payload

object (Struct format)

The payload for the client execution interaction input.

ClientExecutionOutput

The output for the client execution interaction.

JSON representation 
{
  "payload": {
    object
  }
}
Fields
payload

object (Struct format)

The payload for the client execution interaction output.

ClientOrderUpdate

Client-initiated order state update.

JSON representation 
{
  "order": {
    object (Order)
  }
}
Fields
order

object (Order)

An order state update sent by the client.

SuggestedOptions

Options to suggest to the customer.

JSON representation 
{
  "suggestedModifierGroups": {
    object (SuggestedModifierGroups)
  },
  "customIntegrationAttributes": {
    object
  },
  "suggestedActions": {
    object (SuggestedActions)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "suggestedItems": {
    object (SuggestedItems)
  },
  "suggestedModifiers": {
    object (SuggestedModifiers)
  },
  "suggestedStores": {
    object (SuggestedStores)
  }
  // End of mutually exclusive fields.
}
Fields
suggestedModifierGroups

object (SuggestedModifierGroups)

A group of suggested modifiers.
customIntegrationAttributes

object (Struct format)

Optional. Arbitrary metadata to be associated with an entity, used to build downstream integrations, i.e. identifiers or schema information for constructing an order for submission to a third-party point of sale API.
suggestedActions

object (SuggestedActions)

Optional. Generic contextual action pills.
The suggested options. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
suggestedItems

object (SuggestedItems)

A list of items to suggest to the customer.
suggestedModifiers

object (SuggestedModifiers)

A list of modifiers to suggest to the customer.
suggestedStores

object (SuggestedStores)

A list of stores to suggest to the customer.
End of mutually exclusive fields.

SuggestedItems

A list of items to suggest to the customer.

JSON representation 
{
  "items": [
    {
      object (SuggestedItem)
    }
  ]
}
Fields
items[]

object (SuggestedItem)

The items to suggest to the customer.

SuggestedItem

An item to suggest to the customer.

JSON representation 
{
  "itemId": string,
  "displayName": string,
  "image": {
    object (Image)
  },
  "basePrice": {
    object (Money)
  },
  "integrationAttributes": {
    object (ItemIntegrationAttributes)
  },
  "nutritionalInfo": {
    object (NutritionalInfo)
  },
  "description": string
}
Fields
itemId

string

ID of the item in the menu.
displayName

string

Human-readable name for this tem to be shown on user interfaces.
image

object (Image)

Image to display for this item in the UI.
basePrice

object (Money)

The base price of the item. This may be affected by the selected modifiers. This is the price per unit of the item.
integrationAttributes

object (ItemIntegrationAttributes)

Metadata associated with this entity used for downstream integrations.
nutritionalInfo

object (NutritionalInfo)

Nutritional information for this item.
description

string

Description for this item.

NutritionalInfo

Nutritional information for an item or modifier.

JSON representation 
{
  "calories": string
}
Fields
calories

string

Calorie count or calorie range string (e.g. "290", "250-300 Cal").

SuggestedModifiers

A list of modifiers to suggest to the customer.

JSON representation 
{
  "modifiers": [
    {
      object (SuggestedModifier)
    }
  ],
  "parentUid": string
}
Fields
modifiers[]

object (SuggestedModifier)

The modifiers to suggest to the customer.
parentUid

string

The unique identifier of the parent item/modifier to apply the modifiers to.

SuggestedModifier

A modifier to suggest to the customer.

JSON representation 
{
  "modifierId": string,
  "modifierGroupId": string,
  "modifierGroupDisplayName": string,
  "displayName": string,
  "image": {
    object (Image)
  },
  "priceAdjustment": {
    object (Money)
  },
  "integrationAttributes": {
    object (ModifierIntegrationAttributes)
  },
  "alreadyIncluded": boolean,
  "suggestedModifierGroups": [
    {
      object (SuggestedModGroup)
    }
  ],
  "nutritionalInfo": {
    object (NutritionalInfo)
  }
}
Fields
modifierId

string

ID of the modifier in the menu.
modifierGroupId

string

ID of the modifier group that this modifier should be added to if the suggestion is accepted.
modifierGroupDisplayName

string

Display name of the modifier group that this modifier belongs to.
displayName

string

Human-readable name for this tem to be shown on user interfaces.
image

object (Image)

Image to display for this item in the UI.
priceAdjustment

object (Money)

The price adjustment associated with this modifier, if any. This is the price per unit of the modifier.
integrationAttributes

object (ModifierIntegrationAttributes)

Metadata associated with this entity used for downstream integrations.
alreadyIncluded

boolean

Whether this modifier is already included in the order.
suggestedModifierGroups[]

object (SuggestedModGroup)

The nested modifier groups suggested for this modifier.
nutritionalInfo

object (NutritionalInfo)

Nutritional information for this modifier.

SuggestedModGroup

A modifier group to suggest to the customer.

JSON representation 
{
  "modifierGroupId": string,
  "displayName": string,
  "modifiers": [
    {
      object (SuggestedModifier)
    }
  ],
  "maxSelectionCount": integer,
  "minSelectionCount": integer,
  "maxSelectionCountPerModifier": integer,
  "minSelectionNotMatched": boolean
}
Fields
modifierGroupId

string

ID of the modifier group in the menu.
displayName

string

The display name of the modifier group.
modifiers[]

object (SuggestedModifier)

The modifiers in this group.
maxSelectionCount

integer

The maximum number of modifiers that can be selected from this group.
minSelectionCount

integer

The minimum number of modifiers that must be selected from this group.
maxSelectionCountPerModifier

integer

Limits the number of times each modifier can be applied within this group.
minSelectionNotMatched

boolean

Whether the minimum selection count is not matched.

SuggestedStores

A list of stores to suggest to the customer.

JSON representation 
{
  "stores": [
    {
      object (SuggestedStore)
    }
  ]
}
Fields
stores[]

object (SuggestedStore)

The stores to suggest to the customer.

SuggestedStore

A store to suggest to the customer.

JSON representation 
{
  "store": {
    object (Store)
  },
  "distance": number,
  "address": {
    object (Address)
  },
  "storeHours": [
    {
      object (StoreHours)
    }
  ],
  "phoneNumber": string,
  "storeName": string,
  "open": boolean,
  "timeZone": {
    object (TimeZone)
  }
}
Fields
store
(deprecated)

object (Store)

The suggested store.
distance

number

The distance from the customer to the store in miles.
address

object (Address)

The address of the store.
storeHours[]

object (StoreHours)

The store hours.
phoneNumber

string

The phone number of the store.
storeName

string

The store resource name. Format: projects/{project}/locations/{location}/brands/{brand}/stores/{store}
open

boolean

Whether the store is currently open.
timeZone

object (TimeZone)

The timezone of the store.

SuggestedModifierGroups

A list of modifier groups to suggest to the customer.

JSON representation 
{
  "modifierGroups": [
    {
      object (SuggestedModGroup)
    }
  ]
}
Fields
modifierGroups[]

object (SuggestedModGroup)

The modifier groups to suggest to the customer.

SuggestedActions

A collection of action pills.

JSON representation 
{
  "actions": [
    {
      object (SuggestedAction)
    }
  ]
}
Fields
actions[]

object (SuggestedAction)

The list of suggested actions to display as pills.

SuggestedAction

A single action pill / chip.

JSON representation 
{
  "displayName": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "textInput": {
    object (TextInputAction)
  }
  // End of mutually exclusive fields.
}
Fields
displayName

string

The user-facing label rendered on the pill (e.g. "Edit Pizza", "Sign in").
The typed action triggered when the pill is tapped. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
textInput

object (TextInputAction)

Sends back the text input through the textInput event.
End of mutually exclusive fields.

TextInputAction

Action that sends a text query back to FoodAI via TextInput event.

JSON representation 
{
  "text": string
}
Fields
text

string

For sending back the text input through textInput event.

UpsellAttemptRecord

Represents an upsell attempt during an ordering session. This data is used to display upsell information in the console order history, namely upsell type, turn id, item names, price increase, and acceptance status.

JSON representation 
{
  "turnId": integer,
  "upsellType": string,
  "accepted": boolean,
  "originalItemDisplayName": string,
  "targetItemDisplayName": string,
  "priceIncrease": {
    object (Money)
  }
}
Fields
turnId

integer

Output only. ID of the turn in which the upsell opportunity occurred. Example: 2.
upsellType

string

Output only. The type or configured display name of the upsell event. Example: "COMBO", "UP_SIZE", or "Add fries".
accepted

boolean

Output only. Whether the upsell was accepted by the customer.
originalItemDisplayName

string

Output only. The display name of the original item in the order that triggered the upsell. Example: "Cheeseburger".
targetItemDisplayName

string

Output only. The display name of the target item offered or accepted in the upsell. Example: "French Fries" or "Cheeseburger Combo Meal".
priceIncrease

object (Money)

Output only. The additional monetary price increase for the upsold item. Example: {currencyCode: "USD", units: 1, nanos: 500000000} ($1.50).

TrafficType

The traffic type for the session. This is used to label the monitoring, logging, and observability metrics.

Enums
TRAFFIC_TYPE_UNSPECIFIED The traffic type is not specified.
EXTERNAL The traffic is from an external client.
INTEGRATION_TEST The traffic is from an integration test.
EVAL The traffic is from the eval tool.
PROBER The traffic is from the prober.
MANUAL_TEST The traffic is from manual testing.
INTERNAL_TOOL The traffic is from an internal tool.
CONSOLE The traffic is from the food AI console.
QA Traffic from QA testing.

ExperimentMetadata

The metadata associated with the experiment.

JSON representation 
{
  "publicStudies": [
    {
      object (ExperimentStudy)
    }
  ]
}
Fields
publicStudies[]

object (ExperimentStudy)

Output only. The public studies active during the session.

ExperimentStudy

The metadata associated with the study.

JSON representation 
{
  "studyName": string,
  "armName": string
}
Fields
studyName

string

Optional. The name of the study.
armName

string

Optional. The name of the experiment arm.

Methods

delete

 Deletes an SessionRecord.

get

 Gets a specific SessionRecord.

list

 Lists SessionRecords for a given brand.