REST Resource: projects.locations.brands.sessionRecords

Ressource: SessionRecord

Stellt einen einzelnen Sitzungseintrag dar.

JSON-Darstellung
{
  "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)
}
Felder
name

string

ID. Der Ressourcenname des SessionRecord. Format: projects/{project}/locations/{location}/brands/{brand}/sessionRecords/{sessionRecord}

sessionStartTime

string (Timestamp format)

Nur Ausgabe. Der Zeitstempel, der angibt, wann die Sitzung begonnen hat.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

storeId

string

Nicht veränderbar. Die ID des Geschäfts, in dem die Bestellung aufgegeben wurde.

laneId

string

Nicht veränderbar. Die Lane-ID der Bestell-Session.

interactions[]

object (Interaction)

Nur Ausgabe. Die Unterhaltungsbeiträge.

outcomeLabel

string

Nur Ausgabe. Das Label für das Endergebnis der Bestellung.

outcomeGroupLabel

string

Nur Ausgabe. Das Gruppenlabel für das Ergebnis.

audioRecordingPath

string

Nur Ausgabe. Pfad zur vollständigen Audioaufnahme.

order

object (Order)

Nur Ausgabe. Die mit dem Sitzungseintrag verknüpfte Bestellung.

sessionDuration

string (Duration format)

Nur Ausgabe. Gesamtdauer der Sitzung.

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit „s“. Beispiel: "3.5s".

upsellAttemptRecords[]

object (UpsellAttemptRecord)

Nur Ausgabe. Upsells, die während der Sitzung durchgeführt wurden.

audioRecording

string (bytes format)

Nur Ausgabe. Audioaufnahme der Sitzung. Dieses Feld wird nur beim Aufrufen von „sessionRecords.get“ ausgefüllt.

Ein base64-codierter String.

trafficType

enum (TrafficType)

Nur Ausgabe. Der Traffictyp für die Sitzung.

channelType

enum (ChannelType)

Nur Ausgabe. Der für die Sitzung verwendete Kanaltyp (z.B. Drive-In, mobile App, Telefonanruf).

Interaktion

Stellt eine einzelne Interaktion in einer Runde der Unterhaltung dar.

JSON-Darstellung
{
  "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)
  },
  "clientOrderUpdate": {
    object (ClientOrderUpdate)
  }
  // End of list of possible types for union field interaction.
}
Felder
turnPosition

string (int64 format)

Nur Ausgabe. Position in der Unterhaltung.

Union-Feld interaction. Der Typ der Interaktion. Für interaction ist nur einer der folgenden Werte zulässig:
userUtterance

object (UserUtterance)

Nutzeräußerung.

agentUtterance

object (AgentUtterance)

Äußerung des KI-Agenten.

resolveOrder

object (ResolveOrder)

Vom KI-Agenten ausgeführter ResolveOrder-Aufruf

submitOrder

object (SubmitOrder)

Vom KI-Agenten ausgeführter SubmitOrder-Aufruf

matchIntent

object (MatchIntent)

MatchIntent-Aufruf durch den Agenten

clientExecution

object (ClientExecution)

Vom KI-Agenten ausgeführter ClientExecution-Aufruf

clientOrderUpdate

object (ClientOrderUpdate)

Vom Client initiierte Aktualisierung des Bestellstatus

UserUtterance

Die Nutzeräußerung.

JSON-Darstellung
{
  "text": string,
  "createTime": string
}
Felder
text

string

Der Text der Nutzeräußerung.

createTime

string (Timestamp format)

Nur Ausgabe. Der Zeitstempel, zu dem die Nutzeräußerung erfolgt ist.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

AgentUtterance

Die Äußerung des KI-Agenten.

JSON-Darstellung
{
  "text": string,
  "createTime": string
}
Felder
text

string

Der Text der Agentenäußerung.

createTime

string (Timestamp format)

Nur Ausgabe. Der Zeitstempel, der angibt, wann die Äußerung des KI-Agenten erfolgt ist.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

ResolveOrder

Die Interaktion zum Auflösen der Bestellung.

JSON-Darstellung
{
  "input": {
    object (ResolveOrderInput)
  },
  "output": {
    object (ResolveOrderOutput)
  }
}
Felder
input

object (ResolveOrderInput)

Die Eingabe für die Aktion „Bestellung auflösen“.

output

object (ResolveOrderOutput)

Die Ausgabe für die Aktion „Bestellung auflösen“.

ResolveOrderInput

Die Eingabe für die Interaktion zum Auflösen der Reihenfolge.

JSON-Darstellung
{
  "payload": {
    object
  }
}
Felder
payload

object (Struct format)

Die Nutzlast für die Interaktion zum Auflösen der Bestellung.

ResolveOrderOutput

Die Ausgabe für die Interaktion „Bestellung auflösen“.

JSON-Darstellung
{
  "payload": {
    object
  }
}
Felder
payload

object (Struct format)

Die Nutzlast für die Ausgabe der Interaktion zum Auflösen der Bestellung.

SubmitOrder

Dieser Typ hat keine Felder.

Die Interaktion „Bestellung senden“.

MatchIntent

Die Intent-Übereinstimmungsinteraktion.

JSON-Darstellung
{
  "input": {
    object (MatchIntentInput)
  },
  "output": {
    object (MatchIntentOutput)
  }
}
Felder
input

object (MatchIntentInput)

Die Eingabe für die Interaktion mit dem Intent-Abgleich.

output

object (MatchIntentOutput)

Die Ausgabe für die Interaktion mit der Intent-Übereinstimmung.

MatchIntentInput

Die Eingabe für die Interaktion mit dem Intent-Abgleich.

JSON-Darstellung
{
  "payload": {
    object
  }
}
Felder
payload

object (Struct format)

Die Nutzlast für die Eingabe der Intent-Abgleich-Interaktion.

MatchIntentOutput

Die Ausgabe für die Interaktion mit der Intent-Übereinstimmung.

JSON-Darstellung
{
  "payload": {
    object
  }
}
Felder
payload

object (Struct format)

Die Nutzlast für die Ausgabe der Intent-Abgleichsinteraktion.

ClientExecution

Die Interaktion mit der Clientausführung.

JSON-Darstellung
{
  "toolName": string,
  "input": {
    object (ClientExecutionInput)
  },
  "output": {
    object (ClientExecutionOutput)
  }
}
Felder
toolName

string

Der Name des Tools für die Interaktion mit der Clientausführung.

input

object (ClientExecutionInput)

Die Eingabe für die Interaktion mit der Clientausführung.

output

object (ClientExecutionOutput)

Die Ausgabe für die Interaktion mit der Clientausführung.

ClientExecutionInput

Die Eingabe für die Interaktion mit der Clientausführung.

JSON-Darstellung
{
  "payload": {
    object
  }
}
Felder
payload

object (Struct format)

Die Nutzlast für die Eingabe der Interaktion mit der Clientausführung.

ClientExecutionOutput

Die Ausgabe für die Interaktion mit der Clientausführung.

JSON-Darstellung
{
  "payload": {
    object
  }
}
Felder
payload

object (Struct format)

Die Nutzlast für die Ausgabe der Clientausführungsinteraktion.

ClientOrderUpdate

Vom Client initiierte Aktualisierung des Bestellstatus.

JSON-Darstellung
{
  "order": {
    object (Order)
  }
}
Felder
order

object (Order)

Eine vom Client gesendete Aktualisierung des Bestellstatus.

UpsellAttemptRecord

Stellt einen Upselling-Versuch dar. Diese Daten werden verwendet, um im Bestellverlauf der Console Informationen zu Upselling-Angeboten anzuzeigen, nämlich den Upselling-Typ, die Turn-ID und ob das Upselling-Angebot angenommen wurde. Sie werden basierend auf verarbeiteten Logs aus Spanner abgerufen.

JSON-Darstellung
{
  "turnId": integer,
  "upsellType": string,
  "accepted": boolean
}
Felder
turnId

integer

Nur Ausgabe. ID des Schritts, in dem die Upselling-Möglichkeit aufgetreten ist.

upsellType

string

Nur Ausgabe. Die Art des Upselling-Ereignisses.

accepted

boolean

Nur Ausgabe. Gibt an, ob das Upselling akzeptiert wurde.

TrafficType

Der Traffictyp für die Sitzung. Damit werden die Messwerte für Monitoring, Logging und Beobachtbarkeit gekennzeichnet.

Enums
TRAFFIC_TYPE_UNSPECIFIED Der Traffictyp ist nicht angegeben.
EXTERNAL Der Traffic stammt von einem externen Client.
INTEGRATION_TEST Der Traffic stammt aus einem Integrationstest.
EVAL Der Traffic stammt aus dem Bewertungstool.
PROBER Der Traffic stammt vom Prober.
MANUAL_TEST Der Traffic stammt aus manuellen Tests.
INTERNAL_TOOL Der Traffic stammt von einem internen Tool.
CONSOLE Die Zugriffe stammen aus der Food AI-Konsole.

Methoden

delete

Löscht einen SessionRecord.

get

Ruft einen bestimmten SessionRecord ab.

list

Listet SessionRecords für eine bestimmte Marke auf.