REST Resource: projects.locations.collections.engines.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.

Métodos

addContextFile

 Carrega um ficheiro de contexto para usar como origem para as chamadas de assistência na sessão.

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.