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
}
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

string

Output only. 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.

Interaction

Represents a single interaction in a turn in the conversation.

JSON representation 
{
  "turnPosition": string,

  // Union field interaction can be only one of the following:
  "userUtterance": {
    object (UserUtterance)
  },
  "agentUtterance": {
    object (AgentUtterance)
  },
  "resolveOrder": {
    object (ResolveOrder)
  },
  "submitOrder": {
    object (SubmitOrder)
  },
  "matchIntent": {
    object (MatchIntent)
  },
  "clientExecution": {
    object (ClientExecution)
  }
  // End of list of possible types for union field interaction.
}
Fields
turnPosition

string (int64 format)

Output only. Turn position in the conversation.
Union field interaction. The type of interaction. interaction can be only one of the following:
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

UserUtterance

The user utterance.

JSON representation 
{
  "text": string
}
Fields
text

string

The text of the user utterance.

AgentUtterance

The agent utterance.

JSON representation 
{
  "text": string
}
Fields
text

string

The text of the agent utterance.

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.

UpsellAttemptRecord

Represents an upsell attempt. This data is used to display upsell information in the console order history, namely upsell type, turn id, and whether the upsell was accepted, and is populated from Spanner based on processed logs.

JSON representation 
{
  "turnId": integer,
  "upsellType": string,
  "accepted": boolean
}
Fields
turnId

integer

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

string

Output only. The type of upsell event.
accepted

boolean

Output only. Whether the upsell was accepted.

Methods

delete

 Deletes an SessionRecord.

get

 Gets a specific SessionRecord.

list

 Lists SessionRecords for a given brand.