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

Recurso: Sesión

Definición del protocolo 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 completo projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*
displayName

string

Opcional. Nombre visible de la sesión.

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

enum (State)

Estado de la sesión.
userPseudoId

string

Identificador único para monitorizar a los usuarios.
turns[]

object (Turn)

Turnos.
labels[]

string

Opcional. Etiquetas de la sesión. Se puede definir como filtro en ListSessionsRequest.
startTime

string (Timestamp format)

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

Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "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 de salida. Hora en la que finalizó la sesión.

Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
isPinned

boolean

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

Estado

Enumeración del estado de la sesión.

Enumeraciones
STATE_UNSPECIFIED El estado no se ha especificado.
IN_PROGRESS La sesión está abierta.

Activar

Representa una conversación, que incluye una consulta 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,
    ...
  }
}
Campos
query

object (Query)

Opcional. La consulta del usuario. Puede que no se defina si este turno solo regenera una respuesta a un turno diferente.
answer

string

Opcional. Nombre de recurso de la respuesta a la consulta del usuario.

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

string

Solo de salida. Nombre de recurso de la respuesta del Asistente a la consulta del usuario.

Solo se define si se ha producido una llamada de asistencia (llamada a la API /assist) en este turno.

Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assistAnswer}. Para obtener todas las respuestas del Asistente de una sesión, asigna el valor true a GetSessionRequest.include_answer_details. También puedes usar la API AssistAnswerService.GetAssistAnswer para obtener un recurso AssistAnswer concreto.
detailedAnswer

object (Answer)

Solo de salida. En la API ConversationalSearchService.GetSession, si GetSessionRequest.include_answer_details se establece en true, este campo se rellenará al obtener la sesión de consulta de respuesta.
detailedAssistAnswer

object (AssistAnswer)

Solo de salida. En la API ConversationalSearchService.GetSession, si GetSessionRequest.include_answer_details se establece en true, este campo se rellenará al obtener la sesión del asistente.
queryConfig

map (key: string, value: string)

Opcional. Representa los metadatos relacionados con la configuración de la consulta, como el modelo y la versión de LLM utilizados, los parámetros del modelo (temperatura, parámetros de fundamentación, etc.). El prefijo "google." está reservado para las funciones desarrolladas por Google.

Consulta

Define una consulta introducida por el usuario.

Representación JSON 
{
  "queryId": string,

  // Union field content can be only one of the following:
  "text": string
  // End of list of possible types for union field content.
}
Campos
queryId

string

Solo de salida. ID único de la consulta.
Campo de unión content. Contenido de la consulta. content solo puede ser una de estas dos opciones:
text

string

Texto sin formato.

Métodos

create

 Crea una sesión.

delete

 Elimina una sesión.

get

 Obtiene una sesión.

list

 Muestra todas las sesiones por su DataStore principal.

patch

 Actualiza un recurso Session.