Quip - Amazon Kendra
Características admitidasRequisitos previosInstrucciones de conexiónMás información

Quip

nota

El conector Quip seguirá siendo totalmente compatible con los clientes actuales hasta el 31 de mayo de 2026. Si bien este conector ya no está disponible para los nuevos usuarios, los usuarios actuales pueden seguir utilizándolo sin interrupciones. Estamos evolucionando continuamente nuestra cartera de conectores para ofrecer soluciones más escalables y personalizables. Para futuras integraciones, le recomendamos que explore el marco de conectores personalizados de Amazon Kendra[1], diseñado para que sea compatible con una gama más amplia de casos de uso empresariales con mayor flexibilidad.

Quip es un software de productividad colaborativa que ofrece capacidades de creación de documentos en tiempo real. Amazon Kendra se puede usar para indexar carpetas, archivos, comentarios de archivos, salas de chat y archivos adjuntos de Quip.

Puede conectar Amazon Kendra a su origen de datos de Quip mediante la consola de Amazon Kendra y la API QuipConfiguration.

Para solucionar problemas del conector de origen de datos de Quip de Amazon Kendra, consulte Solución de problemas con los orígenes de datos.

Características admitidas

El conector de origen de datos de Quip de Amazon Kendra admite las siguientes características:

  • Asignaciones de campos

  • Control de acceso de usuarios

  • Filtros de inclusión/exclusión

  • Nube privada virtual (VPC)

Requisitos previos

Antes de poder utilizar Amazon Kendra para indexar el origen de datos de Quip, realice estos cambios en sus cuentas de Quip y AWS.

En Quip, asegúrese de que:

  • Tiene una cuenta de Quip con permisos administrativos.

  • Ha creado credenciales de autenticación de Quip que incluyen un token de acceso personal. El token se utiliza como su credencial de autenticación almacenada en un secreto de AWS Secrets Manager. Consulte la Documentación de Quip sobre la autenticación para obtener más informació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 copiado el dominio de su sitio de Quip. Por ejemplo, https://quip-company.quipdomain.com/browse, donde quipdomain es el dominio.

  • Ha comprobado que cada documento es único en Quip 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 su Cuenta de AWS, asegúrese de que:

  • Ha creado un índice de Amazon Kendra y, si usa la API, ha anotado el ID del índice.

  • Ha creado un rol de IAM para el origen de datos y, si usa la API, ha anotado el ARN del rol de IAM.

    nota

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

  • Ha guardado sus credenciales de autenticación de Quip 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 tiene un rol o secreto de IAM existente, puede usar la consola para crear un nuevo rol de IAM y secreto de Secrets Manager al conectar el origen de datos de Quip a Amazon Kendra. Si utiliza la API, debe proporcionar el ARN de un rol de IAM y un secreto de Secrets Manager existentes y un ID de índice.

Instrucciones de conexión

Para conectar Amazon Kendra al origen de datos de Quip, debe proporcionar los detalles necesarios del origen de datos de Quip para que Amazon Kendra pueda acceder a los datos. Si aún no ha configurado Quip para Amazon Kendra, consulte Requisitos previos.

Console

Para conectar Amazon Kendra a Quip

  1. Inicie sesión en Consola de administración de AWS y abra la consola de Amazon Kendra.

  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 Agregar origen de datos, seleccione el Conector de Quip y, a continuación, seleccione Agregar conector. Si usa la versión 2 (si corresponde), elija el Conector de Quip 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 Idioma predeterminado: elija 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 Agregar nueva etiqueta: incluya etiquetas opcionales para buscar y filtrar los recursos o hacer un seguimiento de los costos de AWS.

    5. Elija Siguiente.

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

    1. Nombre de dominio de Quip: introduzca el Quip que ha copiado de la cuenta de Quip.

    2. Secreto de AWS Secrets Manager: elija un secreto existente o cree un nuevo secreto de Secrets Manager para almacenar sus credenciales de autenticación de Quip. Si decide crear un secreto nuevo, se abrirá una ventana de secreto de AWS Secrets Manager.

      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. El prefijo “AmazonKendra-Quip-” se añade automáticamente al nombre del secreto.

        2. Token de Quip: introduzca el acceso personal de Quip configurado en Quip.

      2. Agregue y guarde el 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. Rol de IAM: elija un rol de IAM existente o cree un nuevo rol de IAM para acceder a las credenciales del repositorio y al contenido del índice.

      nota

      Los roles de IAM utilizados para los índices no se pueden usar para los orígenes 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. Agregar los ID de carpeta de Quip para rastrear: los ID de las carpetas de Quip que desea rastrear.

      nota

      Para rastrear una carpeta raíz, incluidas todas las subcarpetas y documentos que contiene, agregue el ID de la carpeta raíz. Para rastrear subcarpetas específicas, añada los ID de las subcarpetas específicas.

    2. Configuración adicional (tipos de contenido): introduzca los tipos de contenido que desee rastrear.

    3. Patrones regex: patrones de expresiones regulares para incluir o excluir determinados archivos. Puede agregar hasta 100 patrones.

    4. En Programación de ejecución de sincronización, en Frecuencia: elija la frecuencia con la que desea sincronizar el contenido del origen de datos y actualizar el índice.

    5. Elija Siguiente.

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

    1. Seleccione entre los campos de origen de datos predeterminados generados que desee asignar al índice de Amazon Kendra.

    2. Agregar campo: para agregar campos de origen de datos personalizados para crear un nombre de campo de índice al que asignarlos y el tipo de datos del campo.

    3. 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 conectar Amazon Kendra a Quip

Debe especificar lo siguiente mediante la API QuipConfiguration:

  • Dominio del sitio de Quip: por ejemplo, https://quip-company.quipdomain.com/browse, donde quipdomain es el dominio.

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

    {
    "accessToken": "token"
}

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

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

  • Nube privada virtual (VPC): especifique VpcConfiguration como parte de la configuración del origen de datos. Consulte Configuración de Amazon Kendra para utilizar una VPC.

  • Filtros de inclusión y exclusión: especifique si desea incluir o excluir determinados archivos.

    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.

  • Carpetas: especifique las carpetas y subcarpetas de Quip que desee indexar

    nota

    Para rastrear una carpeta raíz, incluidas todas las subcarpetas y documentos que contiene, introduzca el ID de la carpeta raíz. Para rastrear subcarpetas específicas, añada los ID de las subcarpetas específicas.

  • Archivos adjuntos, salas de chat, comentarios de archivos: elija si desea incluir el rastreo de los archivos adjuntos, el contenido de las salas de chat y los comentarios de los archivos.

  • Filtrado de contexto de usuario y control de acceso: Amazon Kendra rastrea la lista de control de acceso (ACL) para los documentos, si tiene una ACL para los documentos. 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 Quip 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 los documentos es obligatorio para que Amazon Kendra busque en los documentos. Debe asignar el nombre del campo del cuerpo del documento en el origen de datos al nombre del campo de índice _document_body. Todos los demás campos son opcionales.

Más información

Para obtener más información acerca de la integración de Amazon Kendra con el origen de datos de Quip, consulte: