REST Resource: projects.locations.brands.sessionRecords

Ressource : SessionRecord

Représente un seul enregistrement de session.

Représentation JSON 
{
  "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)
}
Champs
name

string

Identifiant. Nom de ressource du SessionRecord. Format : projects/{project}/locations/{location}/brands/{brand}/sessionRecords/{sessionRecord}
sessionStartTime

string (Timestamp format)

Uniquement en sortie. Code temporel de début de la session.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
storeId

string

Immuable. ID du magasin où la commande a été passée.
laneId

string

Immuable. ID de la ligne de la session de commande.
interactions[]

object (Interaction)

Uniquement en sortie. Les tours de conversation.
outcomeLabel

string

Uniquement en sortie. Libellé du résultat final de la commande.
outcomeGroupLabel

string

Uniquement en sortie. Libellé du groupe pour le résultat.
audioRecordingPath

string

Uniquement en sortie. Chemin d'accès à l'enregistrement audio complet.
order

object (Order)

Uniquement en sortie. Commande associée à l'enregistrement de la session.
sessionDuration

string (Duration format)

Uniquement en sortie. Durée totale de la session.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"
upsellAttemptRecords[]

object (UpsellAttemptRecord)

Uniquement en sortie. Ventes incitatives réalisées pendant la session.
audioRecording

string (bytes format)

Uniquement en sortie. Enregistrement audio de la session. Ce champ n'est renseigné que lors de l'appel de sessionRecords.get.

Chaîne encodée en base64.
trafficType

enum (TrafficType)

Uniquement en sortie. Type de trafic de la session.
channelType

enum (ChannelType)

Uniquement en sortie. Type de canal utilisé pour la session (par exemple, drive, application mobile, appel téléphonique).

Interaction

Représente une interaction unique dans un tour de conversation.

Représentation JSON 
{
  "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.
}
Champs
turnPosition

string (int64 format)

Uniquement en sortie. Position du tour dans la conversation.
Champ d'union interaction. Type d'interaction. interaction ne peut être qu'un des éléments suivants :
userUtterance

object (UserUtterance)

Énoncé de l'utilisateur.
agentUtterance

object (AgentUtterance)

Énoncé de l'agent.
resolveOrder

object (ResolveOrder)

Appel ResolveOrder effectué par l'agent
submitOrder

object (SubmitOrder)

Appel SubmitOrder effectué par l'agent
matchIntent

object (MatchIntent)

Appel MatchIntent effectué par l'agent
clientExecution

object (ClientExecution)

Appel ClientExecution effectué par l'agent
clientOrderUpdate

object (ClientOrderUpdate)

Mise à jour de l'état de la commande lancée côté client

UserUtterance

L'énoncé de l'utilisateur.

Représentation JSON 
{
  "text": string,
  "createTime": string
}
Champs
text

string

Texte de l'énoncé de l'utilisateur.
createTime

string (Timestamp format)

Uniquement en sortie. Horodatage de l'énoncé de l'utilisateur.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

AgentUtterance

L'énoncé de l'agent.

Représentation JSON 
{
  "text": string,
  "createTime": string
}
Champs
text

string

Texte de l'énoncé de l'agent.
createTime

string (Timestamp format)

Uniquement en sortie. Horodatage de l'énoncé de l'agent.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

ResolveOrder

Interaction de résolution de commande.

Représentation JSON 
{
  "input": {
    object (ResolveOrderInput)
  },
  "output": {
    object (ResolveOrderOutput)
  }
}
Champs
input

object (ResolveOrderInput)

Entrée pour l'action de résolution de commande.
output

object (ResolveOrderOutput)

Résultat de l'action de résolution de la commande.

ResolveOrderInput

Entrée pour l'interaction de résolution de commande.

Représentation JSON 
{
  "payload": {
    object
  }
}
Champs
payload

object (Struct format)

Charge utile pour l'interaction de résolution de commande.

ResolveOrderOutput

Résultat de l'interaction de résolution de la commande.

Représentation JSON 
{
  "payload": {
    object
  }
}
Champs
payload

object (Struct format)

Charge utile pour la sortie de l'interaction de résolution de commande.

SubmitOrder

Ce type ne comporte aucun champ.

L'interaction d'envoi de la commande.

MatchIntent

Interaction de correspondance d'intention.

Représentation JSON 
{
  "input": {
    object (MatchIntentInput)
  },
  "output": {
    object (MatchIntentOutput)
  }
}
Champs
input

object (MatchIntentInput)

Entrée pour l'interaction de mise en correspondance des intents.
output

object (MatchIntentOutput)

Résultat de l'interaction de mise en correspondance de l'intent.

MatchIntentInput

Entrée pour l'interaction de mise en correspondance des intents.

Représentation JSON 
{
  "payload": {
    object
  }
}
Champs
payload

object (Struct format)

Charge utile pour l'entrée d'interaction de mise en correspondance d'intent.

MatchIntentOutput

Résultat de l'interaction de mise en correspondance de l'intent.

Représentation JSON 
{
  "payload": {
    object
  }
}
Champs
payload

object (Struct format)

Charge utile pour la sortie de l'interaction de correspondance d'intent.

ClientExecution

Interaction d'exécution du client.

Représentation JSON 
{
  "toolName": string,
  "input": {
    object (ClientExecutionInput)
  },
  "output": {
    object (ClientExecutionOutput)
  }
}
Champs
toolName

string

Nom de l'outil pour l'interaction d'exécution du client.
input

object (ClientExecutionInput)

Entrée pour l'interaction d'exécution côté client.
output

object (ClientExecutionOutput)

Résultat de l'interaction d'exécution du client.

ClientExecutionInput

Entrée pour l'interaction d'exécution côté client.

Représentation JSON 
{
  "payload": {
    object
  }
}
Champs
payload

object (Struct format)

Charge utile pour l'entrée d'interaction d'exécution du client.

ClientExecutionOutput

Résultat de l'interaction d'exécution du client.

Représentation JSON 
{
  "payload": {
    object
  }
}
Champs
payload

object (Struct format)

Charge utile pour la sortie de l'interaction d'exécution du client.

ClientOrderUpdate

Mise à jour de l'état de la commande lancée côté client.

Représentation JSON 
{
  "order": {
    object (Order)
  }
}
Champs
order

object (Order)

Mise à jour de l'état de la commande envoyée par le client.

UpsellAttemptRecord

Représente une tentative de vente incitative. Ces données sont utilisées pour afficher les informations de vente incitative dans l'historique des commandes de la console, à savoir le type de vente incitative, l'ID de tour et si la vente incitative a été acceptée. Elles sont renseignées à partir de Spanner en fonction des journaux traités.

Représentation JSON 
{
  "turnId": integer,
  "upsellType": string,
  "accepted": boolean
}
Champs
turnId

integer

Uniquement en sortie. ID du tour au cours duquel l'opportunité de vente incitative s'est présentée.
upsellType

string

Uniquement en sortie. Type d'événement de vente incitative.
accepted

boolean

Uniquement en sortie. Indique si la vente incitative a été acceptée.

TrafficType

Type de trafic de la session. Il est utilisé pour étiqueter les métriques de surveillance, de journalisation et d'observabilité.

Enums
TRAFFIC_TYPE_UNSPECIFIED Le type de trafic n'est pas spécifié.
EXTERNAL Le trafic provient d'un client externe.
INTEGRATION_TEST Le trafic provient d'un test d'intégration.
EVAL Le trafic provient de l'outil d'évaluation.
PROBER Le trafic provient du vérificateur.
MANUAL_TEST Le trafic provient de tests manuels.
INTERNAL_TOOL Le trafic provient d'un outil interne.
CONSOLE Le trafic provient de la console Food AI.

Méthodes

delete

 Supprime un SessionRecord.

get

 Récupère un SessionRecord spécifique.

list

 Répertorie les SessionRecords pour une marque donnée.