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

Recurso: Session

Definición de proto 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,
  "pendingAsyncAssistOperationId": string
}
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 texto de la primera 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)

Gira

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 comenzó 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. La sesión fijada se mostrará en la parte superior de la lista de sesiones.

pendingAsyncAssistOperationId

string

Solo salida. Nombre completo del recurso de una operación AsyncAssist en curso para esta sesión, p.ej., projects/*/locations/*/collections/*/engines/*/sessions/*/operations/*. Se establece cuando comienza la operación y se borra cuando finaliza.

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.

listSessionFileMetadata

Enumera los metadatos de todos los archivos de la sesión actual.

patch

Actualiza una sesión.

recommendQuestions

Obtiene preguntas recomendadas para la sesión determinada.

removeContextFile

Quita un archivo de contexto de una sesión.

selectContextFiles

Selecciona los archivos de contexto que se usarán en una sesión.

validateUserAuthorization

Valida un flujo de consentimiento de autenticación descendente de OAuth de 3 segmentos (3LO) de A2A después de que el usuario regresa de la pantalla de consentimiento de terceros y finaliza la credencial descendente con el Administrador de autenticación.