REST Resource: projects.locations.collections.dataStores.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,
  "pendingAsyncAssistOperationId": string
}
Campos
name

string

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

string

Es 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 del usuario en 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

Es 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 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. Fecha y 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. Si lo está, se mostrará en la parte superior de la lista de sesiones.
pendingAsyncAssistOperationId

string

Solo salida. Nombre completo del recurso de una operación de 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.

Estado

Es una enumeración del estado de la sesión.

Enums
STATE_UNSPECIFIED El estado no se especifica.
IN_PROGRESS La sesión está abierta en este momento.

Turno

Representa un turno, incluida una búsqueda del usuario y una respuesta del servicio.

Representación JSON 
{
  "query": {
    object (Query)
  },
  "answer": string,
  "assistAnswer": string,
  "detailedAnswer": {
    object (Answer)
  },
  "detailedAssistAnswer": {
    object (AssistAnswer)
  },
  "queryConfig": {
    string: string,
    ...
  },
  "live": boolean
}
Campos
query

object (Query)

Es opcional. Es la consulta del usuario. Es posible que no se establezca si este turno solo regenera una respuesta a un turno diferente.
answer

string

Es opcional. Es el nombre del recurso de la respuesta a la búsqueda del usuario.

Solo se configura si la generación de respuestas (llamada a la API de /answer) ocurrió en este turno.
assistAnswer

string

Solo salida. Es el nombre del recurso de la respuesta de Asistente a la búsqueda del usuario.

Solo se establece si se realizó una llamada de asistencia (llamada a la API de /assist) en este turno.

Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assistAnswer}. Para obtener todas las respuestas de AssistAnswers para una sesión, establece GetSessionRequest.include_answer_details como verdadero. Como alternativa, para obtener un recurso de AssistAnswer individual, usa la API de AssistAnswerService.GetAssistAnswer.
detailedAnswer

object (Answer)

Solo salida. En la API de ConversationalSearchService.GetSession, si GetSessionRequest.include_answer_details se establece como verdadero, este campo se completará cuando se obtenga la sesión de consulta de respuesta.
detailedAssistAnswer

object (AssistAnswer)

Solo salida. En la API de ConversationalSearchService.GetSession, si GetSessionRequest.include_answer_details se establece como verdadero, este campo se propagará cuando se obtenga la sesión del asistente.
queryConfig

map (key: string, value: string)

Es opcional. Representa los metadatos relacionados con la configuración de la búsqueda, por ejemplo, el modelo y la versión del LLM que se usaron, los parámetros del modelo (temperatura, parámetros de fundamentación, etcétera). El prefijo "google." está reservado para la funcionalidad desarrollada por Google.
live

boolean

Es opcional. Indica si este giro es en vivo.

Métodos

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.