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

Ayuda al usuario con una consulta.

Solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación a gRPC.

Parámetros de ruta

Parámetros
name

string

Obligatorio. Nombre de recurso de Assistant. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos que presentan la siguiente estructura:

Representación JSON 
{
  "query": {
    object (Query)
  },
  "session": string,
  "assistSkippingMode": enum (AssistSkippingMode),
  "fileIds": [
    string
  ],
  "userMetadata": {
    object (AssistUserMetadata)
  },
  "languageCode": string,
  "webGroundingEnabled": boolean,
  "dataStoreSpecs": [
    {
      object (DataStoreSpec)
    }
  ],
  "assistGenerationConfig": {
    object (AssistGenerationConfig)
  },
  "googleSearchGroundingEnabled": boolean
}
Campos
query

object (Query)

Opcional. Consulta del usuario actual.

Las consultas vacías solo se admiten si se proporcionan fileIds. En este caso, la respuesta se generará a partir de esos archivos de contexto.
session

string

Opcional. La sesión que se va a usar en la solicitud. Si se especifica, el asistente tiene acceso al historial de la sesión, y la consulta y la respuesta se almacenan ahí.

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

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

enum (AssistSkippingMode)

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

string

Opcional. Los IDs de los archivos que se usarán para responder a la solicitud. Al subir un archivo, su ID se devuelve en AddContextFileResponse.file_id.
userMetadata

object (AssistUserMetadata)

Opcional. Información sobre el usuario que inicia la consulta.
languageCode

string

Opcional. Idioma que se usará para responder si no se puede detectar el idioma. También se usa como idioma de los mensajes de error creados por las acciones, independientemente de los resultados de la detección de idiomas.
webGroundingEnabled

boolean

Opcional. Si se le asigna el valor "true", se habilita la fundamentación con la búsqueda web. Solo funciona si Assistant.web_grounding_type es [WEB_GROUNDING_TYPE_GOOGLE_SEARCH][] o [WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH][].
dataStoreSpecs[]

object (DataStoreSpec)

Opcional. Especificaciones que definen los DataStore por los que se va a filtrar en una llamada de búsqueda y las configuraciones de esos almacenes de datos. Esto solo se tiene en cuenta en los Engines con varios almacenes de datos.

Si no se define este campo, se usarán todos los almacenes de datos del motor, excepto cuando ignoreDataStores tenga el valor true.
assistGenerationConfig

object (AssistGenerationConfig)

Opcional. Configuración de la generación a nivel de solicitud. Se usa para anular la configuración de generación predeterminada a nivel del motor.
googleSearchGroundingEnabled
(deprecated)

boolean

Opcional. Obsoleto. En su lugar, usa webGroundingEnabled.

Cuerpo de la respuesta

Respuesta del método AssistantService.Assist.

Si la solicitud se realiza correctamente, el cuerpo de la respuesta proporciona datos con la siguiente estructura:

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

object (AssistAnswer)

El recurso AssistAnswer generado en respuesta a la consulta.
sessionInfo

object (SessionInfo)

Información de la sesión.
assistToken

string

Un ID único global que identifica el par de solicitud y respuesta actual. Se usa para enviar comentarios y recibir asistencia.

Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

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

Permisos de IAM

Requiere el siguiente permiso de gestión de identidades y accesos en el recurso name:

  • discoveryengine.assistants.assist

Para obtener más información, consulta la documentación de gestión de identidades y accesos.

AssistSkippingMode

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

Enumeraciones
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 se puede omitir si la consulta no supera las comprobaciones de las políticas.

SessionInfo

Información sobre la sesión.

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

string

Nombre de la sesión recién generada o continuada.

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

string

ID de consulta que corresponde a esta llamada a la API de asistencia. Una sesión puede tener varias interacciones, cada una 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 assistants.assist, la solicitud de asistencia se producirá en el contexto de los resultados de búsqueda de esta llamada de búsqueda.