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 usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

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)
  },
  "languageCode": string,
  "webGroundingEnabled": boolean,
  "dataStoreSpecs": [
    {
      object (DataStoreSpec)
    }
  ],
  "assistGenerationConfig": {
    object (AssistGenerationConfig)
  },
  "googleSearchGroundingEnabled": boolean
}
Campos
query

object (Query)

Opcional. Es la consulta del usuario actual.

Solo se admite la búsqueda vacía si se proporciona fileIds. En este caso, la respuesta se generará en función de esos archivos de contexto.
session

string

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 búsqueda y la respuesta se almacenan allí.

Si se especifica - como el ID de 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)

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

string

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)

Opcional. Es información sobre el usuario que inicia la búsqueda.
languageCode

string

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

boolean

Opcional. Si se establece como verdadero, 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. Son especificaciones que definen los DataStores para filtrar en una llamada de búsqueda y las configuraciones de esos almacenes de datos. Esto solo se considera para los Engines con varios almacenes de datos.

Si no se configura este campo, se usarán todos los almacenes de datos del motor, excepto cuando ignoreDataStores se establece como verdadero.
assistGenerationConfig

object (AssistGenerationConfig)

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

boolean

Opcional. Obsoleto. Utiliza webGroundingEnabled en lugar de esta función.

Cuerpo de la respuesta

Respuesta del 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
}
Campos
answer

object (AssistAnswer)

Es el recurso AssistAnswer que se genera en respuesta a la búsqueda.
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 brindar comentarios y asistencia.

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.readwrite
  • https://www.googleapis.com/auth/discoveryengine.assist.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

Son los comportamientos de omisión disponibles para las solicitudes de asistencia.

Enums
ASSIST_SKIPPING_MODE_UNSPECIFIED Valor predeterminado. Se puede omitir la respuesta si la búsqueda no requiere asistencia.
REQUEST_ASSIST Solicita la respuesta del asistente. Aun así, es posible que se omita la respuesta si la búsqueda no supera las verificaciones de políticas.

SessionInfo

Es 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

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

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