Method: projects.locations.collections.engines.assistants.assist

Ayuda al usuario con una consulta.

Solicitud HTTP

POST https://discoveryengine.googleapis.com/v1/{name=projects/*/locations/*/collections/*/engines/*/assistants/*}:assist

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta

Parámetros
name

string

Obligatorio. Es el nombre del recurso Assistant. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "query": {
    object (Query)
  },
  "session": string,
  "assistSkippingMode": enum (AssistSkippingMode),
  "fileIds": [
    string
  ],
  "userMetadata": {
    object (AssistUserMetadata)
  }
}
Campos
query

object (Query)

Es opcional. Es la consulta actual del usuario.

Solo se admite una consulta vacía si se proporcionan fileIds. En este caso, la respuesta se generará en función de esos archivos de contexto.
session

string

Es opcional. Es la sesión que se usará para la solicitud. Si se especifica, el asistente tiene acceso al historial de la sesión, y la consulta y la respuesta se almacenan allí.

Si se especifica - como el ID de la sesión o se deja vacío, se crea una sesión nueva con un ID generado automáticamente.

Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}
assistSkippingMode

enum (AssistSkippingMode)

Es opcional. Determina los casos en los que el asistente no responderá la consulta. Si se omite la respuesta, los motivos se mostrarán en AssistAnswer.assist_skipped_reasons dentro de AssistResponse.answer.
fileIds[]

string

Es opcional. Son los IDs de los archivos que se usarán para responder la solicitud. Cuando se sube un archivo, su ID se muestra en AddContextFileResponse.file_id.
userMetadata

object (AssistUserMetadata)

Es opcional. Es la información sobre el usuario que inicia la consulta.

Cuerpo de la respuesta

Respuesta para el método AssistantService.Assist.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON 
{
  "answer": {
    object (AssistAnswer)
  },
  "sessionInfo": {
    object (SessionInfo)
  },
  "assistToken": string,
  "invocationTools": [
    string
  ]
}
Campos
answer

object (AssistAnswer)

Es el recurso AssistAnswer generado en respuesta a la consulta.
sessionInfo

object (SessionInfo)

Es la información de la sesión.
assistToken

string

Es un ID único global que identifica el par solicitud-respuesta actual. Se usa para comentarios y asistencia.
invocationTools[]

string

Son los nombres de las herramientas que se invocaron.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • discoveryengine.assistants.assist

Para obtener más información, consulta la documentación de IAM.

AssistSkippingMode

Comportamientos de omisión disponibles para las solicitudes de asistencia.

Enums
ASSIST_SKIPPING_MODE_UNSPECIFIED Valor predeterminado. La respuesta se puede omitir si la consulta no busca asistencia.
REQUEST_ASSIST Solicita la respuesta del asistente. La respuesta aún se puede omitir si la consulta no pasa las verificaciones de políticas.

SessionInfo

Información sobre la sesión.

Representación JSON 
{
  "session": string,
  "queryId": string
}
Campos
session

string

Es el nombre de la sesión recién generada o continua.

Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}
queryId

string

Es el ID de la consulta que corresponde a esta llamada a la API de asistencia. Una sesión puede tener varios turnos, cada uno con un ID de consulta único.

Si especificas el nombre de la sesión y este ID de consulta en la llamada a la API de assistants.assist, la solicitud de asistencia se realiza en el contexto de los resultados de la búsqueda de esta llamada de búsqueda.