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

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.

Zendesk

Zendesk es un sistema de gestión de relaciones con los clientes que ayuda a las empresas a automatizar y mejorar las interacciones de atención al cliente. Puede usarlo Amazon Kendra para indexar los tickets de soporte de Zendesk, los comentarios de los tickets, los archivos adjuntos de los tickets, los artículos del centro de ayuda, los comentarios de los artículos, los archivos adjuntos a los comentarios de los artículos, los temas de la comunidad, las publicaciones de la comunidad y los comentarios de las publicaciones de la comunidad.

Puede filtrar por nombre de organización si quiere indexar los tickets que solo están dentro de una organización específica. También puede elegir establecer una fecha de rastreo para comenzar a rastrear los datos de Zendesk.

Puede conectarse Amazon Kendra a su fuente de datos de Zendesk mediante la Amazon Kendra consola y la TemplateConfigurationAPI.

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

Características admitidas

Amazon Kendra El conector de fuente de datos de Zendesk admite las siguientes funciones:

  • Asignaciones de campo

  • Control de acceso de usuarios

  • Filtros de inclusión/exclusión

  • El registro de cambios y las sincronizaciones de contenido completas e incrementales

  • Nube privada virtual (VPC)

Requisitos previos

Antes de poder utilizarla Amazon Kendra para indexar la fuente de datos de Zendesk, realice estos cambios en su cuenta de Zendesk y en sus cuentas. AWS

En Zendesk, asegúrese de que:

  • Creó una cuenta administrativa de Zendesk Suite (Professional/Enterprise).

  • Apuntó la URL de su servidor de Zendesk. Por ejemplo, https://{sub-domain}.zendesk.com/.

    nota

    (local o en el servidor) Amazon Kendra comprueba si la información de punto final incluida AWS Secrets Manager es la misma que la información de punto final especificada en los detalles de configuración de la fuente de datos. Esto ayuda a evitar el problema del suplente confuso, que es un problema de seguridad en el que un usuario no tiene permiso para realizar una acción, pero utiliza Amazon Kendra como proxy para acceder al secreto configurado y realizar la acción. Si más adelante cambia la información de punto de conexión, debe crear un nuevo secreto para sincronizar esta información.

  • Se configuró un token de OAuth 2.0 que contiene un ID de cliente, un secreto de cliente, un nombre de usuario y una contraseña. Es necesario utilizar el token de OAuth 2.0 como credenciales de autenticación. Consulte la documentación de Zendesk sobre la configuración de los tokens de OAuth 2.0 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).

  • Se agregó el siguiente ámbito de OAuth 2.0:

    • leer

  • Opcional: se instaló un certificado SSL para permitir a Amazon Kendra la conexión.

  • Marcó que cada documento es único en Zendesk y en otras Origen de datos que planea usar 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 el suyo Cuenta de AWS, asegúrese 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 Zendesk 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 IAM rol o secreto existente, puede usar la consola para crear un nuevo IAM rol y un Secrets Manager secreto al conectar su fuente de datos de Zendesk. 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 conectarse Amazon Kendra a su fuente de datos de Zendesk, debe proporcionar los detalles necesarios de su fuente de datos de Zendesk para que Amazon Kendra pueda acceder a sus datos. Si aún no ha configurado Zendesk para Amazon Kendra, consulte. Requisitos previos

Console

Para conectarse Amazon Kendra a Zendesk

  1. Inicie sesión en la Amazon Kendra consola AWS Management Console y ábrala.

  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 fuente de datos, elija el conector de Zendesk y, a continuación, elija Agregar conector. Si usa la versión 2 (si corresponde), elija el conector de Zendesk 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: 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 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. URL de Zendesk: introduzca la URL de su cuenta de Zendesk. Por ejemplo, https://{sub-domain}.zendesk.com/.

    2. 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.

    3. AWS Secrets Manager secreto: elija un secreto existente o cree uno nuevo Secrets Manager para almacenar sus credenciales de autenticación de Zendesk. 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-Zendesk» se agrega automáticamente a su nombre secreto.

        2. Para el ID de cliente, el secreto del cliente, el nombre de usuario y la contraseña: introduzca los valores de las credenciales de autenticación configurados en Zendesk.

      2. Guarde y añada su secreto.

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

    5. Rastreador de identidad: especifique si se debe activar el rastreador Amazon Kendra de identidad. El rastreador de identidades utiliza la información de la lista de control de acceso (ACL) de los documentos para filtrar los resultados de la búsqueda en función del acceso del usuario o de su grupo a los documentos. Si tiene una ACL para sus documentos y decide utilizarla, también puede optar por activar el rastreador de identidades para configurar el filtrado Amazon Kendra de los resultados de búsqueda según el contexto del usuario. De lo contrario, si el rastreador de identidades está desactivado, se pueden realizar búsquedas públicas en todos los documentos. Si quieres usar el control de acceso para tus documentos y el rastreador de identidad está desactivado, también puedes usar la PutPrincipalMappingAPI para cargar información de acceso de usuarios y grupos para filtrar el contexto de los usuarios.

    6. IAM rol: elija un IAM rol existente o cree 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.

    7. Elija Siguiente.

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

    1. Seleccione el contenido: seleccione los tipos de contenido que desea rastrear desde los tickets, los artículos del centro de ayuda, los temas de la comunidad y mucho más.

    2. Nombre de la organización: introduzca los nombres de las organizaciones de Zendesk para filtrar el contenido.

    3. Fecha de inicio de la sincronización: introduzca la fecha a partir de la cual quiere empezar a rastrear el contenido.

    4. Patrones regex: añada patrones de expresiones regulares para incluir o excluir determinados archivos. Puede agregar hasta 100 patrones.

    5. 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 con 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 seleccionas 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 y modificada: indexe solo el contenido nuevo y modificado 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.

      • 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.

    6. Calendario de ejecución sincronizado para la frecuencia: elija la frecuencia con la que desea sincronizar el contenido de la fuente de datos y actualizar el índice.

    7. 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.

    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 conectarse Amazon Kendra a Zendesk

Debe especificar un JSON del esquema de la fuente de datos mediante la TemplateConfigurationAPI. Debe proporcionar la siguiente información:

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

  • URL del host: proporcione la URL de su host de Zendesk como parte de la configuración de la conexión o de los detalles del punto de conexión del repositorio. Por ejemplo, https://yoursubdomain.zendesk.com.

  • Registro de cambios: si se Amazon Kendra debe usar el mecanismo de registro de cambios de la fuente de datos de Zendesk para determinar si un documento debe actualizarse en el índice.

    nota

    Utilice el registro de cambios si no quiere que Amazon Kendra digitalice todos los documentos. Si el registro de cambios es grande, es posible que se tarde Amazon Kendra menos en escanear los documentos de la fuente de datos de Zendesk que en procesar el registro de cambios. Si está sincronizando el origen de datos de Zendesk con su índice por primera vez, se escanean todos los documentos.

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

    {
    "hostUrl": "https://yoursubdomain.zendesk.com",
    "clientId": "client ID",
    "clientSecret": "Zendesk client secret",
    "userName": "Zendesk user name",
    "password": "Zendesk password"
}

  • 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 Zendesk y. Amazon Kendra Para obtener más información, consulte las IAM funciones de los orígenes de datos de Zendesk.

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.

  • Tipos de documentos o contenido: especifique si desea rastrear:

    • Tickets de soporte, comentarios de tickets y/o archivos adjuntos de comentarios de tickets

    • Artículos del centro de ayuda, anexos y comentarios de artículos

    • Guía los temas, las publicaciones o los comentarios de la comunidad

  • Filtros de inclusión y exclusión: especifican si se debe incluir o excluir determinado contenido de Slack. Si utiliza un token de bot como parte de sus credenciales de autenticación de Slack, deberá añadir el token de bot al canal que desee indexar. No puede indexar mensajes directos y mensajes de grupo utilizando un token de bot.

    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 por contexto de usuario y control de acceso:Amazon Kendra rastrea la lista de control de acceso (ACL) de tus documentos, si tienes 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 Zendesk 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.

Para ver una lista de otras claves JSON importantes que debe configurar, consulte el esquema de plantillas de Zendesk.

Más información

Para obtener más información sobre la integración Amazon Kendra con la fuente de datos de Zendesk, consulte: