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

Recurso: Session

Definición externa del proto de sesión.

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

Es opcional. 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 primer texto de consulta de la sesión.

state

enum (State)

El estado de la sesión.

userPseudoId

string

Un identificador único para hacer un seguimiento de los usuarios.

turns[]

object (Turn)

Turnos.

labels[]

string

Es opcional. Las etiquetas de la sesión. Se pueden establecer como filtro en ListSessionsRequest.

startTime

string (Timestamp format)

Solo salida. La hora en que se inició la sesión.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. 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. La hora en que finalizó la sesión.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. 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

Es opcional. Indica si la sesión está fijada. Las sesiones fijadas se mostrarán en la parte superior de la lista de sesiones.

Métodos

addContextFile

Sube un archivo de contexto para usarlo como fuente para 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 superior.

patch

Actualiza una sesión.