REST Resource: projects.locations.brands.sessionRecords

Recurso: SessionRecord

Representa um único registro de sessão.

Representação 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)
}
Campos
name

string

Identificador. O nome do recurso do SessionRecord. Formato: projects/{project}/locations/{location}/brands/{brand}/sessionRecords/{sessionRecord}
sessionStartTime

string (Timestamp format)

Apenas saída. O carimbo de data/hora de início da sessão.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
storeId

string

Imutável. O ID da loja em que o pedido foi feito.
laneId

string

Imutável. O ID da faixa da sessão do pedido.
interactions[]

object (Interaction)

Apenas saída. As interações da conversa.
outcomeLabel

string

Apenas saída. O rótulo do resultado final do pedido.
outcomeGroupLabel

string

Apenas saída. O rótulo do grupo para o resultado.
audioRecordingPath

string

Apenas saída. Caminho para a gravação de áudio completa.
order

object (Order)

Apenas saída. O pedido associado ao registro da sessão.
sessionDuration

string (Duration format)

Apenas saída. Duração total da sessão.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".
upsellAttemptRecords[]

object (UpsellAttemptRecord)

Apenas saída. Upsells realizados durante a sessão.
audioRecording

string (bytes format)

Apenas saída. Gravação de áudio da sessão. Esse campo só é preenchido ao chamar sessionRecords.get.

Uma string codificada em base64.
trafficType

enum (TrafficType)

Apenas saída. O tipo de tráfego da sessão.
channelType

enum (ChannelType)

Apenas saída. O tipo de canal usado para a sessão (por exemplo, drive-thru, app para dispositivos móveis, ligação telefônica).

Interação

Representa uma única interação em um turno da conversa.

Representação 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.
}
Campos
turnPosition

string (int64 format)

Apenas saída. Posição da vez na conversa.
Campo de união interaction. O tipo de interação. interaction pode ser apenas de um dos tipos a seguir:
userUtterance

object (UserUtterance)

Enunciado do usuário.
agentUtterance

object (AgentUtterance)

Frase do agente.
resolveOrder

object (ResolveOrder)

Chamada ResolveOrder realizada pelo agente
submitOrder

object (SubmitOrder)

Chamada SubmitOrder realizada pelo agente
matchIntent

object (MatchIntent)

Chamada MatchIntent realizada pelo agente
clientExecution

object (ClientExecution)

Chamada ClientExecution realizada pelo agente
clientOrderUpdate

object (ClientOrderUpdate)

Atualização do estado do pedido iniciada pelo cliente

UserUtterance

A fala do usuário.

Representação JSON 
{
  "text": string,
  "createTime": string
}
Campos
text

string

O texto da fala do usuário.
createTime

string (Timestamp format)

Apenas saída. O carimbo de data/hora de quando o usuário falou.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

AgentUtterance

A fala do agente.

Representação JSON 
{
  "text": string,
  "createTime": string
}
Campos
text

string

O texto da fala do agente.
createTime

string (Timestamp format)

Apenas saída. O carimbo de data/hora de quando a fala do agente ocorreu.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

ResolveOrder

A interação de resolução do pedido.

Representação JSON 
{
  "input": {
    object (ResolveOrderInput)
  },
  "output": {
    object (ResolveOrderOutput)
  }
}
Campos
input

object (ResolveOrderInput)

A entrada para a ação de resolver o pedido.
output

object (ResolveOrderOutput)

A saída da ação de resolução do pedido.

ResolveOrderInput

A entrada para a interação de resolução de pedido.

Representação JSON 
{
  "payload": {
    object
  }
}
Campos
payload

object (Struct format)

O payload da interação de resolução do pedido.

ResolveOrderOutput

A saída da interação de resolução do pedido.

Representação JSON 
{
  "payload": {
    object
  }
}
Campos
payload

object (Struct format)

O payload da saída da interação de resolução do pedido.

SubmitOrder

Esse tipo não tem campos.

A interação de envio de pedido.

MatchIntent

A interação de intent de correspondência.

Representação JSON 
{
  "input": {
    object (MatchIntentInput)
  },
  "output": {
    object (MatchIntentOutput)
  }
}
Campos
input

object (MatchIntentInput)

A entrada para a interação de intent de correspondência.
output

object (MatchIntentOutput)

A saída da interação de intent de correspondência.

MatchIntentInput

A entrada para a interação de intent de correspondência.

Representação JSON 
{
  "payload": {
    object
  }
}
Campos
payload

object (Struct format)

O payload para a entrada de interação de intent de correspondência.

MatchIntentOutput

A saída da interação de intent de correspondência.

Representação JSON 
{
  "payload": {
    object
  }
}
Campos
payload

object (Struct format)

O payload da saída da interação de intent de correspondência.

ClientExecution

A interação de execução do cliente.

Representação JSON 
{
  "toolName": string,
  "input": {
    object (ClientExecutionInput)
  },
  "output": {
    object (ClientExecutionOutput)
  }
}
Campos
toolName

string

O nome da ferramenta para a interação de execução do cliente.
input

object (ClientExecutionInput)

A entrada para a interação de execução do cliente.
output

object (ClientExecutionOutput)

A saída da interação de execução do cliente.

ClientExecutionInput

A entrada para a interação de execução do cliente.

Representação JSON 
{
  "payload": {
    object
  }
}
Campos
payload

object (Struct format)

O payload para a entrada de interação de execução do cliente.

ClientExecutionOutput

A saída da interação de execução do cliente.

Representação JSON 
{
  "payload": {
    object
  }
}
Campos
payload

object (Struct format)

O payload da saída da interação de execução do cliente.

ClientOrderUpdate

Atualização do estado do pedido iniciada pelo cliente.

Representação JSON 
{
  "order": {
    object (Order)
  }
}
Campos
order

object (Order)

Uma atualização do estado do pedido enviada pelo cliente.

UpsellAttemptRecord

Representa uma tentativa de upsell. Esses dados são usados para mostrar informações de upsell no histórico de pedidos do console, como tipo de upsell, ID da vez e se o upsell foi aceito, e são preenchidos pelo Spanner com base nos registros processados.

Representação JSON 
{
  "turnId": integer,
  "upsellType": string,
  "accepted": boolean
}
Campos
turnId

integer

Apenas saída. ID da vez em que a oportunidade de upsell ocorreu.
upsellType

string

Apenas saída. O tipo de evento de upsell.
accepted

boolean

Apenas saída. Se o upsell foi aceito.

TrafficType

O tipo de tráfego da sessão. Isso é usado para rotular as métricas de monitoramento, geração de registros e observabilidade.

Tipos enumerados
TRAFFIC_TYPE_UNSPECIFIED O tipo de tráfego não foi especificado.
EXTERNAL O tráfego é de um cliente externo.
INTEGRATION_TEST O tráfego é de um teste de integração.
EVAL O tráfego é da ferramenta de avaliação.
PROBER O tráfego é da sonda.
MANUAL_TEST O tráfego é de testes manuais.
INTERNAL_TOOL O tráfego é de uma ferramenta interna.
CONSOLE O tráfego vem do console de IA de comida.

Métodos

delete

 Exclui um SessionRecord.

get

 Recebe um SessionRecord específico.

list

 Lista SessionRecords de uma determinada marca.