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

Recurso: sessão

Definição do 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
}
Campos
name

string

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

string

Opcional. O nome a apresentar da sessão.

Este campo é usado para identificar a sessão na IU. Por predefinição, o nome a apresentar é o texto da primeira consulta na sessão.
state

enum (State)

O estado da sessão.
userPseudoId

string

Um identificador exclusivo para acompanhar os utilizadores.
turns[]

object (Turn)

Viragens.
labels[]

string

Opcional. As etiquetas da sessão. Pode ser definido como filtro em ListSessionsRequest.
startTime

string (Timestamp format)

Apenas saída. A hora em que a sessão começou.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". 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. A hora em que a sessão terminou.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". 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 está fixada, a sessão fixada é apresentada na parte superior da lista de sessões.

Estado

Enumeração do estado da sessão.

Enumerações
STATE_UNSPECIFIED O estado não está especificado.
IN_PROGRESS A sessão está atualmente aberta.

Ative ou desative

Representa uma interação, incluindo uma consulta do utilizador 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,
    ...
  }
}
Campos
query

object (Query)

Opcional. A consulta do utilizador. Pode não ser definido se esta interação estiver apenas a regenerar uma resposta a uma interação diferente
answer

string

Opcional. O nome do recurso da resposta à consulta do utilizador.

Só é definido se a geração de respostas (chamada API /answer) tiver ocorrido neste turno.
assistAnswer

string

Apenas saída. O nome do recurso da resposta do Assistente à consulta do utilizador.

Apenas definido se tiver ocorrido uma chamada de assistência (chamada da API /assist) neste turno.

Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assistAnswer}. Para receber todas as respostas do Assistente para uma sessão, defina GetSessionRequest.include_answer_details como verdadeiro. Em alternativa, para obter 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 verdadeiro, este campo é preenchido quando obtém a sessão de consulta de respostas.
detailedAssistAnswer

object (AssistAnswer)

Apenas saída. Na API ConversationalSearchService.GetSession, se GetSessionRequest.include_answer_details estiver definido como verdadeiro, este campo é preenchido quando obtém a sessão do assistente.
queryConfig

map (key: string, value: string)

Opcional. Representa metadados relacionados com a configuração da consulta, por exemplo, o modelo e a versão do MDG usados, os parâmetros do modelo (temperatura, parâmetros de fundamentação, etc.). O prefixo "google." está reservado para funcionalidades desenvolvidas pela Google.

Consulta

Define uma consulta introduzida pelo utilizador.

Representação JSON 
{
  "queryId": string,

  // Union field content can be only one of the following:
  "text": string
  // End of list of possible types for union field content.
}
Campos
queryId

string

Apenas saída. ID exclusivo da consulta.
Campo de união content. Consultar conteúdo. content só pode ser uma das seguintes opções:
text

string

Texto simples.

Métodos

create

 Cria uma sessão.

delete

 Elimina uma sessão.

get

 Obtém uma sessão.

list

 Apresenta todas as sessões pelo respetivo elemento principal DataStore.

patch

 Atualiza uma sessão.