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

Recurso: Sesión

Es la definición del arquetipo de sesión externa.

Representación JSON 
{
  "name": string,
  "displayName": string,
  "state": enum (State),
  "userPseudoId": string,
  "turns": [
    {
      object (Turn)
    }
  ],
  "labels": [
    string
  ],
  "startTime": string,
  "endTime": string,
  "isPinned": boolean
}
Campos
name

string

Inmutable. Nombre completamente calificado projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*
displayName

string

Opcional. Es el nombre visible de la sesión.

Este campo se usa para identificar la sesión en la IU. De forma predeterminada, el nombre visible es el texto de la primera pregunta de la sesión.
state

enum (State)

Es el estado de la sesión.
userPseudoId

string

Es un identificador único para hacer un seguimiento de los usuarios.
turns[]

object (Turn)

Giros
labels[]

string

Opcional. Son las etiquetas de la sesión. Se puede establecer como filtro en ListSessionsRequest.
startTime

string (Timestamp format)

Solo salida. Es la fecha y hora en que se inició la sesión.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Solo salida. Fecha y hora en que finalizó la sesión.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
isPinned

boolean

Opcional. Indica si la sesión está fijada. Si lo está, se mostrará en la parte superior de la lista de sesiones.

Métodos

addContextFile

 Sube un archivo de contexto para usarlo como fuente de las llamadas de asistencia dentro de la sesión.

create

 Crea una sesión.

delete

 Borra una sesión.

get

 Obtiene una sesión.

list

 Enumera todas las sesiones por su DataStore principal.

patch

 Actualiza una sesión.