Gmail - Amazon Kendra
Características admitidasRequisitos previosInstrucciones de conexiónMás informaciónNotas

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Gmail

Gmail es un cliente de correo desarrollado por Google a través del cual se pueden enviar mensajes de correo electrónico con archivos adjuntos. Los mensajes de Gmail se pueden ordenar y almacenar en la bandeja de entrada del correo electrónico mediante carpetas y etiquetas. Puedes usarlo Amazon Kendra para indexar tus mensajes de correo electrónico y sus archivos adjuntos. También puede configurarlo Amazon Kendra para incluir o excluir mensajes de correo electrónico, archivos adjuntos de mensajes y etiquetas específicos para su indexación.

Puedes conectarte Amazon Kendra a tu fuente de datos de Gmail mediante la Amazon Kendra consola y la TemplateConfigurationAPI.

Para solucionar problemas del conector de fuentes de datos de Amazon Kendra Gmail, consultaSolución de problemas con los orígenes de datos.

Características admitidas

  • Asignaciones de campo

  • Control de acceso de usuarios

  • Filtros de inclusión/exclusión

  • Sincronizaciones de contenido completas e incrementales

  • Nube privada virtual (VPC)

Requisitos previos

Antes de poder utilizarla Amazon Kendra para indexar tu fuente de datos de Gmail, realiza estos cambios en Gmail y en tus AWS cuentas.

En Gmail, asegúrese de que:

  • Ha creado una cuenta de administrador de Google Cloud Platform y un proyecto de Google Cloud.

  • Ha activado la API de Gmail y la API del SDK de administración en su cuenta de administrador.

  • Ha creado una cuenta de servicio y descargado una clave privada JSON para la cuenta de Gmail. Para obtener información sobre cómo crear una clave privada y acceder a ella, consulte la documentación de Google Cloud sobre cómo Crear una clave de cuenta de servicio y las Credenciales de una cuenta de servicio.

  • Copiaste el correo electrónico de tu cuenta de administrador, el correo de tu cuenta de servicio y tu clave privada para utilizarlos como credenciales de autenticación.

    nota

    Le recomendamos que actualice o modifique con regularidad las credenciales y el secreto. Por su propia seguridad, proporcione solo el nivel de acceso necesario. No se recomienda volver a utilizar las credenciales y los datos secretos en varios orígenes de datos ni en las versiones 1.0 y 2.0 del conector (si procede).

  • Ha añadido los siguientes ámbitos de OAuth (con un rol de administrador) para su usuario y los directorios compartidos que quiere indexar:

    • https://www.googleapis.com/auth/admin.directory.user.readonly

    • https://www.googleapis.com/auth/gmail.readonly

  • Ha comprobado que cada documento es único en Gmail y en otros orígenes de datos que vaya a utilizar para el mismo índice. Cada origen de datos que desee utilizar para un índice no debe contener el mismo documento en varios orígenes de datos. Los ID de documento son globales para un índice y deben ser únicos por índice.

En tu Cuenta de AWS, asegúrate de tener:

  • Creó un Amazon Kendra índice y, si usa la API, anotó el ID del índice.

  • Creó un IAM rol para su fuente de datos y, si usa la API, anotó el ARN del IAM rol.

    nota

    Si cambias el tipo de autenticación y las credenciales, debes actualizar tu IAM rol para acceder al ID AWS Secrets Manager secreto correcto.

  • Ha guardado sus credenciales de autenticación de Gmail en un secreto de AWS Secrets Manager y, si utiliza la API, ha anotado el ARN del secreto.

    nota

    Le recomendamos que actualice o modifique con regularidad las credenciales y el secreto. Por su propia seguridad, proporcione solo el nivel de acceso necesario. No se recomienda volver a utilizar las credenciales y los datos secretos en varios orígenes de datos ni en las versiones 1.0 y 2.0 del conector (si procede).

Si no tienes ningún IAM rol o secreto existente, puedes usar la consola para crear un nuevo IAM rol y un Secrets Manager secreto al conectar tu fuente de datos de Gmail Amazon Kendra. Si utiliza la API, debe proporcionar el ARN de un IAM rol y un Secrets Manager secreto existentes y un ID de índice.

Instrucciones de conexión

Para conectarte Amazon Kendra a tu fuente de datos de Gmail, debes proporcionar los detalles de tus credenciales de Gmail para que Amazon Kendra puedas acceder a tus datos. Si aún no has configurado Gmail para Amazon Kendra, consultaRequisitos previos.

Console

Para conectarte Amazon Kendra a Gmail

  1. Inicia sesión en la Amazon Kendra consola AWS Management Console y ábrela.

  2. En el panel de navegación izquierdo, elija Índices y, a continuación, elija el índice que desee usar de la lista de índices.

    nota

    Puede elegir configurar o editar los ajustes de Control de acceso de usuarios en la Configuración del índice.

  3. En la página Introducción, seleccione Agregar origen de datos.

  4. En la página Añadir fuente de datos, selecciona el conector de Gmail y, a continuación, selecciona Añadir conector. Si utilizas la versión 2 (si corresponde), selecciona el conector de Gmail con la etiqueta «V2.0».

  5. En la página Especificar detalles del origen de datos, introduzca la siguiente información:

    1. En Nombre y descripción, en Nombre del origen de datos: introduzca un nombre para el origen de datos. Puede incluir guiones, pero no espacios.

    2. (Opcional) Descripción: introduzca una descripción opcional para el origen de datos.

    3. En el idioma predeterminado: elige un idioma para filtrar los documentos para el índice. A menos que especifique lo contrario, el idioma predeterminado es el inglés. El idioma especificado en los metadatos del documento anula el idioma seleccionado.

    4. En Etiquetas, para añadir una nueva etiqueta: incluya etiquetas opcionales para buscar y filtrar sus recursos o realizar un seguimiento de sus AWS costes.

    5. Elija Siguiente.

  6. En la página Definir acceso y seguridad, introduzca la siguiente información:

    1. Autorización: active o desactive la información de la lista de control de acceso (ACL) de sus documentos, si tiene una ACL y desea utilizarla para el control de acceso. La ACL especifica a qué documentos pueden acceder los usuarios y los grupos. La información de la ACL se utiliza para filtrar los resultados de búsqueda en función del acceso del usuario o su grupo a los documentos. Para obtener más información, consulte Filtrado de contexto de usuario.

    2. En Autenticación por AWS Secrets Manager secreto: elige un secreto existente o crea uno nuevo Secrets Manager para almacenar tus credenciales de autenticación de Gmail. Si decides crear un secreto nuevo, se abrirá una ventana AWS Secrets Manager secreta.

      1. Introduzca la siguiente información en la ventana Crear un secreto de AWS Secrets Manager :

        1. Nombre del secreto: un nombre para su secreto.

        2. Correo electrónico del cliente: el correo electrónico del cliente que copió de su cuenta de servicio de Google.

        3. Correo electrónico de la cuenta de administrador: el correo electrónico de la cuenta de administrador que quiere usar.

        4. Clave privada: la clave privada que copió de su cuenta de servicio de Google.

        5. Guarda y añade tu secreto.

    3. Nube privada virtual (VPC): puede optar por utilizar una VPC. Si es así, debe agregar Subredes y Grupos de seguridad de VPC.

    4. IAM rol: elige un IAM rol existente o crea uno nuevo IAM para acceder a las credenciales del repositorio y al contenido del índice.

      nota

      IAM los roles utilizados para los índices no se pueden usar para las fuentes de datos. Si no está seguro de si un rol existente se utiliza para un índice o para las preguntas frecuentes, elija Crear un nuevo rol para evitar errores.

    5. Elija Siguiente.

  7. En la página Configurar ajustes de sincronización, introduzca la siguiente información:

    1. Para los tipos de entidad: elija sincronizar los archivos adjuntos de los mensajes.

    2. (Opcional) En Configuración adicional, introduzca la siguiente información:

      1. Intervalo de fechas: introduce un intervalo de fechas para especificar la fecha de inicio y finalización de los correos electrónicos que deseas rastrear.

      2. Dominios de correo electrónico: incluye o excluye determinados correos electrónicos según los dominios de correo «para», «desde», «cc» y «bcc».

      3. Palabras clave en los asuntos: incluya o excluya los correos electrónicos en función de las palabras clave de sus asuntos de correo electrónico.

        nota

        También puede optar por incluir cualquier documento que coincida con todas las palabras clave del asunto que haya introducido.

      4. Etiquetas: añada patrones de expresiones regulares para incluir o excluir determinadas etiquetas de correo electrónico.

      5. Archivos adjuntos: añada patrones de expresiones regulares para incluir o excluir determinados archivos adjuntos de correo electrónico.

    3. Modo de sincronización: elija cómo desea actualizar el índice cuando cambie el contenido del origen de datos. Al sincronizar la fuente de datos Amazon Kendra por primera vez, todo el contenido se rastrea e indexa de forma predeterminada. Debes realizar una sincronización completa de los datos si la sincronización inicial ha fallado, incluso si no eliges la sincronización completa como opción de modo de sincronización.

      • Sincronización completa: indexa todo el contenido de forma inmediata y reemplaza el contenido existente cada vez que la fuente de datos se sincronice con el índice.

      • Sincronización nueva, modificada o eliminada: indexe solo el contenido nuevo, modificado y eliminado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.

      importante

      Como no hay una API para actualizar los mensajes de Gmail eliminados permanentemente, el contenido nuevo, modificado o eliminado se sincroniza:

      • No eliminará de tu Amazon Kendra índice los mensajes que se hayan eliminado permanentemente de Gmail

      • No sincronizará los cambios en las etiquetas de correo de Gmail

      Para sincronizar los cambios en las etiquetas del origen de datos de Gmail y los mensajes de correo electrónico eliminados permanentemente con el índice de Amazon Kendra , debe realizar rastreos completos de forma periódica.

    4. Calendario de ejecución sincronizado, para Frecuencia: elige la frecuencia con la que deseas sincronizar el contenido de la fuente de datos y actualizar el índice.

    5. Elija Siguiente.

  8. En la página Establecer asignaciones de campos, especifique la siguiente información:

    1. Campos de fuente de datos predeterminados: seleccione entre los campos de fuente de datos predeterminados Amazon Kendra generados que desee asignar a su índice.

      nota

      Amazon Kendra El conector de fuentes de datos de Gmail no admite la creación de campos de índice personalizados debido a las limitaciones de la API.

    2. Elija Siguiente.

  9. En la página Revisar y crear, compruebe que la información que ha introducido es correcta y, a continuación, seleccione Añadir origen de datos. También puede elegir editar la información desde esta página. El origen de datos aparecerá en la página Orígenes de datos una vez que el origen de datos se haya agregado correctamente.

API

Para conectarse Amazon Kendra a Gmail

Debe especificar un JSON del esquema del origen de datos mediante la API TemplateConfiguration. Debe proporcionar la siguiente información:

  • Fuente de datos: especifique el tipo de fuente de datos como GMAIL cuando utiliza el esquema TemplateConfigurationJSON. Especifique también la fuente de datos TEMPLATE al llamar a la CreateDataSourceAPI.

  • Modo de sincronización: especifique cómo Amazon Kendra debe actualizarse el índice cuando cambie el contenido de la fuente de datos. Al sincronizar la fuente de datos Amazon Kendra por primera vez, todo el contenido se rastrea e indexa de forma predeterminada. Debes realizar una sincronización completa de los datos si la sincronización inicial ha fallado, incluso si no eliges la sincronización completa como opción de modo de sincronización. Puede elegir entre las siguientes opciones:

    • FORCED_FULL_CRAWLpara indexar todo el contenido de forma actualizada, sustituyendo el contenido existente cada vez que la fuente de datos se sincronice con el índice.

    • FULL_CRAWLpara indexar solo el contenido nuevo, modificado y eliminado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.

    importante

    Como no hay una API para actualizar los mensajes de Gmail eliminados permanentemente, el contenido nuevo, modificado o eliminado se sincroniza:

    • No eliminará de tu Amazon Kendra índice los mensajes que se hayan eliminado permanentemente de Gmail

    • No sincronizará los cambios en las etiquetas de correo de Gmail

    Para sincronizar los cambios en la etiqueta de la fuente de datos de Gmail y los mensajes de correo electrónico eliminados permanentemente con tu Amazon Kendra índice, debes realizar rastreos completos de forma periódica.

  • Nombre secreto del recurso de Amazon (ARN): proporciona el nombre del recurso de Amazon (ARN) de un Secrets Manager secreto que contenga las credenciales de autenticación de tu cuenta de Gmail. El secreto se almacena en una estructura JSON con las siguientes claves:

    {
    "adminAccountEmailId": "service account email",
    "clientEmailId": "user account email",
    "privateKey": "private key"
}

  • IAM rol: especifique RoleArn cuándo llama CreateDataSource para proporcionar un IAM rol con permisos para acceder a su Secrets Manager secreto y para llamar a las API públicas requeridas para el conector de Gmail y. Amazon Kendra Para obtener más información, consulte Roles de IAM para orígenes de datos de Gmail.

También puede añadir las siguientes características opcionales:

  • Nube privada virtual (VPC): especifique a VpcConfiguration cuándo llamar a CreateDataSource. Para obtener más información, consulte Configuración Amazon Kendra para usar un Amazon VPC.

  • Filtros de inclusión y exclusión: especifica si deseas incluir o excluir determinados correos electrónicos «para», «de», «cc» o «bcc».

    nota

    La mayoría de los orígenes de datos utilizan patrones de expresiones regulares, que son patrones de inclusión o exclusión denominados filtros. Si especifica un filtro de inclusión, solo se indexará el contenido que coincida con el filtro de inclusión. Los documentos que no coincidan con el filtro de inclusión no se indexan. Si especifica un filtro de inclusión y exclusión, los documentos que coincidan con el filtro de exclusión no se indexarán, aunque coincidan con el filtro de inclusión.

  • Filtrado contextual de usuario y control de acceso:Amazon Kendra rastrea la lista de control de acceso (ACL) de sus documentos, si tiene una ACL para ellos. La información de la ACL se utiliza para filtrar los resultados de búsqueda en función del acceso del usuario o su grupo a los documentos. Para obtener más información, consulte Filtrado de contexto de usuario.

  • Asignaciones de campos: elija asignar los campos del origen de datos de Gmail a los campos de índice de Amazon Kendra . Para obtener más información, consulte Asignación de campos de origen de datos.

    nota

    El campo del cuerpo del documento o el cuerpo del documento equivalente de sus documentos es obligatorio Amazon Kendra para poder buscarlos. Debe asignar el nombre del campo del cuerpo del documento en la fuente de datos al nombre del campo de índice_document_body. Todos los demás campos son opcionales.

    nota

    Amazon Kendra El conector de fuentes de datos de Gmail no admite la creación de campos de índice personalizados debido a las limitaciones de la API.

Para obtener una lista de otras claves JSON importantes que debe configurar, consulte el Esquema de plantilla de Gmail.

Más información

Para obtener más información sobre la integración Amazon Kendra con tu fuente de datos de Gmail, consulta:

Notas

  • Como no hay una API para actualizar los mensajes de Gmail eliminados permanentemente, una FULL_CRAWL/Sincronización de contenido nuevo, modificado o eliminado:

    • No eliminará de tu Amazon Kendra índice los mensajes que se hayan eliminado permanentemente de Gmail

    • No sincronizarán los cambios en las etiquetas de correo de Gmail

    Para sincronizar los cambios en la etiqueta de la fuente de datos de Gmail y los mensajes de correo electrónico eliminados permanentemente con tu Amazon Kendra índice, debes realizar un rastreo completo de forma periódica.

  • Amazon Kendra El conector de fuentes de datos de Gmail no admite la creación de campos de índice personalizados debido a las limitaciones de la API.