REST Resource: projects.locations.collections.dataStores.sessions

Recurso: Session

Definição de proto de sessão externa.

Representação JSON 
{
  "name": string,
  "displayName": string,
  "state": enum (State),
  "userPseudoId": string,
  "turns": [
    {
      object (Turn)
    }
  ],
  "labels": [
    string
  ],
  "startTime": string,
  "endTime": string,
  "isPinned": boolean,
  "pendingAsyncAssistOperationId": string
}
Campos
name

string

Imutável. Nome totalmente qualificado projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*
displayName

string

Opcional. O nome de exibição da sessão.

Esse campo é usado para identificar a sessão na UI. Por padrão, o nome de exibição é o primeiro texto de consulta do turno na sessão.
state

enum (State)

O estado da sessão.
userPseudoId

string

Um identificador exclusivo para rastrear usuários.
turns[]

object (Turn)

Gira.
labels[]

string

Opcional. Os rótulos da sessão. Pode ser definido como filtro em "ListSessionsRequest".
startTime

string (Timestamp format)

Apenas saída. O horário em que a sessão começou.

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".
endTime

string (Timestamp format)

Apenas saída. O horário em que a sessão terminou.

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".
isPinned

boolean

Opcional. Se a sessão estiver fixada, ela vai aparecer na parte de cima da lista.
pendingAsyncAssistOperationId

string

Apenas saída. Nome completo do recurso de uma operação AsyncAssist em andamento para esta sessão, por exemplo, projects/*/locations/*/collections/*/engines/*/sessions/*/operations/*. Definido quando a operação começa e limpo quando ela termina.

Estado

Enumeração do estado da sessão.

Tipos enumerados
STATE_UNSPECIFIED Estado não especificado.
IN_PROGRESS A sessão está aberta no momento.

Turn

Representa um turno, incluindo uma consulta do usuário e uma resposta do serviço.

Representação JSON 
{
  "query": {
    object (Query)
  },
  "answer": string,
  "assistAnswer": string,
  "detailedAnswer": {
    object (Answer)
  },
  "detailedAssistAnswer": {
    object (AssistAnswer)
  },
  "queryConfig": {
    string: string,
    ...
  },
  "live": boolean
}
Campos
query

object (Query)

Opcional. A consulta do usuário. Não pode ser definido se esta vez estiver apenas regenerando uma resposta para uma vez diferente.
answer

string

Opcional. O nome do recurso da resposta à consulta do usuário.

Definido apenas se a geração de respostas (chamada da API /answer) ocorreu nesta vez.
assistAnswer

string

Apenas saída. O nome do recurso da resposta do Google Assistente à consulta do usuário.

Definido apenas se uma chamada de assistência (chamada de API /assist) ocorreu nesta vez.

Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assistAnswer}. Para receber todas as AssistAnswers de uma sessão, defina GetSessionRequest.include_answer_details como "true". Como alternativa, para receber um recurso AssistAnswer individual, use a API AssistAnswerService.GetAssistAnswer.
detailedAnswer

object (Answer)

Apenas saída. Na API ConversationalSearchService.GetSession, se GetSessionRequest.include_answer_details estiver definido como "true", esse campo será preenchido ao receber a sessão de consulta de resposta.
detailedAssistAnswer

object (AssistAnswer)

Apenas saída. Na API ConversationalSearchService.GetSession, se GetSessionRequest.include_answer_details estiver definido como verdadeiro, esse campo será preenchido ao receber a sessão do assistente.
queryConfig

map (key: string, value: string)

Opcional. Representa metadados relacionados à configuração da consulta, por exemplo, modelo e versão de LLM usados, parâmetros do modelo (temperatura, parâmetros de embasamento etc.). O prefixo "google." é reservado para funcionalidades desenvolvidas pelo Google.
live

boolean

Opcional. Indica se esta vez é uma vez ao vivo.

Métodos

create

 Cria uma sessão.

delete

 Exclui uma sessão.

get

 Recebe uma sessão.

list

 Lista todas as sessões pelo DataStore principal.

patch

 Atualiza uma sessão.