Method: projects.locations.brands.sessionRecords.list

Lista SessionRecords de uma determinada marca.

Solicitação HTTP

GET https://foodorderingaiagent.googleapis.com/v1beta/{parent=projects/*/locations/*/brands/*}/sessionRecords

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. A marca para listar as sessões de pedidos. Formato: projects/{project}/locations/{location}/brands/{brand}

Parâmetros de consulta

Parâmetros
pageSize

integer

Opcional. O número máximo de registros de sessão a serem retornados. O serviço pode retornar um valor inferior a este. Se não for especificado, no máximo 50 sessões serão retornadas. O valor máximo é 1.000. Valores maiores serão convertidos para 1.000.
pageToken

string

Opcional. Um token de página recebido de uma chamada sessionRecords.list anterior. Forneça isso para recuperar a página subsequente.
filter

string

Opcional. Expressão de filtro baseada na AIP-160. Esse campo permite filtrar registros de sessão com base em vários atributos.

Campos de filtro aceitos:

  • session_id (string): o ID da sessão. Operadores: = Exemplo: session_id = "session-123"

  • storeId (String): o ID da loja. Operadores: =, != Exemplo: storeId = "store-123"

  • sessionStartTime (carimbo de data/hora): o horário de início da sessão. Os carimbos de data/hora esperam uma string formatada em RFC-3339 (por exemplo, 2012-04-21T11:30:00-04:00). Operadores de compensação de UTC compatíveis: =, !=,

    , >=, <, <= Exemplo: sessionStartTime >= "2025-10-01T00:00:00Z"

  • outcomeLabel (string): o rótulo do resultado final da sessão. Operadores: =, != Exemplo: outcomeLabel = "SUCCESS"

  • outcomeGroupLabel (string): o marcador do grupo para o resultado da sessão. Operadores: =, != Exemplo: outcomeGroupLabel = "SUCCESS"

  • predictedFailureCategory (string): a categoria de falha prevista para a sessão na análise de intervenção. Operadores: =, != Exemplo: predictedFailureCategory = "Menu"

  • agent_utterances (string): texto falado pelo agente. Operador: : (tem token/pesquisa de texto completo). Exemplo: agent_utterances:"anything else"

  • user_utterances (String): texto falado pelo usuário. Operador: : (tem token/pesquisa de texto completo). Exemplo: user_utterances:"burger"

Operadores lógicos:

As condições podem ser combinadas usando AND, OR e NOT. Os parênteses () podem ser usados para agrupar expressões e controlar a ordem de avaliação. Exemplo: (user_utterances:"help" OR agent_utterances:"issue") AND storeId != "test-store" Exemplo: user_utterances:"order" AND sessionStartTime >= "2025-10-03T00:00:00Z"

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para [SessionRecordService.ListSessionRecords][].

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "sessionRecords": [
    {
      object (SessionRecord)
    }
  ],
  "nextPageToken": string
}
Campos
sessionRecords[]

object (SessionRecord)

A lista de registros de sessão.
nextPageToken

string

Um token, que pode ser enviado como pageToken para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para mais informações, consulte Authentication Overview.