Zendesk - Amazon Kendra
Atributos compatíveisPré-requisitosInstruções de conexãoSaiba mais

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Zendesk

O Zendesk é um sistema de gerenciamento de relacionamento com o cliente que ajuda as empresas a automatizar e aprimorar as interações de suporte ao cliente. Você pode usar Amazon Kendra para indexar seus tickets de suporte do Zendesk, comentários do ticket, anexos do ticket, artigos da central de ajuda, comentários de artigos, anexos de comentários de artigos, tópicos da comunidade do Guide, publicações da comunidade e comentários de publicações da comunidade.

Você pode filtrar pelo nome da organização se quiser indexar tickets que estejam somente dentro de uma organização específica. Você também pode escolher definir uma data de rastreamento para quando quiser começar a rastrear dados do Zendesk.

Você pode se conectar Amazon Kendra à sua fonte de dados do Zendesk usando o Amazon Kendra console e a TemplateConfigurationAPI.

Para solucionar problemas do conector da fonte de dados do Amazon Kendra Zendesk, consulteSolucionar problemas de origens de dados.

Atributos compatíveis

Amazon Kendra O conector de fonte de dados do Zendesk é compatível com os seguintes recursos:

  • Mapeamentos de campos

  • Controle de acesso do usuário

  • Filtros de inclusão/exclusão

  • Registro de alterações, sincronizações completas e incrementais de conteúdo

  • Nuvem privada virtual (VPC)

Pré-requisitos

Antes de poder usar Amazon Kendra para indexar sua fonte de dados do Zendesk, faça essas alterações em seu Zendesk e AWS em suas contas.

No , verifique se você:

  • Criou uma conta administrativa da Zendesk Suite (Profissional/Empresarial).

  • Anotou o URL de host do Zendesk. Por exemplo, https://{sub-domain}.zendesk.com/.

    nota

    (Local/servidor) Amazon Kendra verifica se as informações do endpoint incluídas são iguais às informações do endpoint especificadas nos AWS Secrets Manager detalhes de configuração da fonte de dados. Isso ajuda a proteger contra o problema de assistência confusa, que é um problema de segurança em que um usuário não tem permissão para realizar uma ação, mas usa o Amazon Kendra como proxy para acessar a senha configurada e realizar a ação. Se você alterar posteriormente as informações do endpoint, crie uma nova senha para sincronizar essas informações.

  • Configurou um token OAuth 2.0 contendo um ID do cliente, segredo do cliente, nome de usuário e senha. O token OAuth 2.0 é necessário para ser usado como suas credenciais de autenticação. Consulte a documentação do Zendesk sobre a configuração de tokens OAuth 2.0 para obter mais informações.

    nota

    Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. Não recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).

  • O seguinte escopo OAuth 2.0 foi adicionado:

    • leitura

  • Opcional: instalou um certificado SSL para permitir a conexão ao Amazon Kendra .

  • Verificou se cada documento é exclusivo no Zendesk e outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. Os IDs de documentos são globais para um índice e devem ser exclusivos por índice.

No seu Conta da AWS, verifique se você tem:

  • Criou um Amazon Kendra índice e, se estiver usando a API, anotei o ID do índice.

  • Criou uma IAM função para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.

    nota

    Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.

  • Armazenou suas credenciais de autenticação de em uma senha do AWS Secrets Manager e, se estiver usando a API, anotou o ARN da senha.

    nota

    Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. Não recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).

Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e um Secrets Manager segredo ao conectar sua fonte de dados do Zendesk a. Amazon Kendra Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.

Instruções de conexão

Para se conectar Amazon Kendra à sua fonte de dados do Zendesk, você deve fornecer os detalhes necessários da sua fonte de dados do Zendesk para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou o Zendesk para Amazon Kendra, consultePré-requisitos.

Console

Para se conectar Amazon Kendra ao Zendesk

  1. Faça login no AWS Management Console e abra o Amazon Kendra console.

  2. No painel de navegação esquerdo, escolha Índices e, em seguida, escolha o índice que deseja usar na lista de índices.

    nota

    Você pode escolher definir ou editar as configurações de Controle de acesso do usuário em Configurações do índice.

  3. Na página Introdução, escolha Adicionar fonte de dados.

  4. Na página Adicionar fonte de dados, escolha Conector Zendesk e, em seguida, escolha Adicionar conector. Se estiver usando a versão 2 (se aplicável), escolha o conector Zendesk com a tag “V2.0".

  5. Na página Especar detalhes da fonte de dados, insira as seguintes informações:

    1. Em Nome e descrição, em Nome da fonte de dados: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.

    2. (Opcional) Descrição: insira uma descrição opcional para a fonte de dados.

    3. Em Idioma padrão — Escolha um idioma para filtrar seus documentos para o índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.

    4. Em Tags, em Adicionar nova tag — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.

    5. Escolha Próximo.

  6. Na página Definir seção e segurança, insira as informações a seguir:

    1. URL do Zendesk: insira o URL do Zendesk. Por exemplo, https://{sub-domain}.zendesk.com/.

    2. Autorização — Ative ou desative as informações da lista de controle de acesso (ACL) para seus documentos, se você tiver uma ACL e quiser usá-la para controle de acesso. A ACL especifica quais documentos os usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte Filtrar o contexto do usuário.

    3. AWS Secrets Manager segredo — Escolha um segredo existente ou crie um novo Secrets Manager segredo para armazenar suas credenciais de autenticação do Zendesk. Se optar por criar uma nova senha, uma janela secreta do AWS Secrets Manager será aberta.

      1. Insira as seguintes informações em Criar uma janela de senha do AWS Secrets Manager :

        1. Senha: um nome para sua senha. O prefixo 'AmazonKendra-Zendesk' é adicionado automaticamente ao seu nome secreto.

        2. Em ID do cliente, segredo do cliente, nome de usuário, senha — insira os valores da credencial de autenticação configurados no Zendesk.

      2. Salve e adicione seu segredo.

    4. Nuvem privada virtual (VPC): você pode escolher usar uma VPC. Nesse caso, você deve adicionar sub-redes e grupos de segurança da VPC.

    5. Rastreador de identidade — especifique se deseja ativar o rastreador Amazon Kendra de identidade. O rastreador de identidade usa as informações da lista de controle de acesso (ACL) dos seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a filtragem de contexto Amazon Kendra do usuário dos resultados da pesquisa. Caso contrário, se o rastreador de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a PutPrincipalMappingAPI para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.

    6. IAM função — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.

      nota

      IAM as funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha Criar uma nova função para evitar erros.

    7. Escolha Próximo.

  7. Na página Configurar configurações de sincronização, insira as seguintes informações:

    1. Selecionar conteúdo — Selecione os tipos de conteúdo que você deseja rastrear desde tickets até artigos da central de ajuda, tópicos da comunidade e muito mais.

    2. Nome da organização — Insira os nomes da organização da Zendesk para filtrar o conteúdo.

    3. Data de início da sincronização — insira a data a partir da qual você deseja começar a rastrear seu conteúdo.

    4. Padrões Regex: adicionar padrões de expressão regular para incluir ou excluir determinados arquivos. Você pode adicionar até 100 padrões.

    5. Modo de sincronização: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos seus dados se a sincronização inicial falhar, mesmo que você não escolha a sincronização completa como opção de modo de sincronização.

      • Sincronização completa: indexe todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados for sincronizada com seu índice.

      • Sincronização nova e modificada: indexe somente conteúdo novo e modificado sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

      • Sincronização nova, modificada e excluída: indexe somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

    6. Em Sincronização, cronograma de execução para frequência — Escolha com que frequência sincronizar o conteúdo da fonte de dados e atualizar seu índice.

    7. Escolha Próximo.

  8. Na página Definir mapeamentos de campo, insira as seguintes informações:

    1. Campos de fonte de dados padrão — Selecione entre os campos de fonte de dados padrão Amazon Kendra gerados que você deseja mapear para o seu índice.

    2. Adicionar campo: para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.

    3. Escolha Próximo.

  9. Na página Revisar e criar, verifique se as informações inseridas estão corretas e selecione Adicionar fonte de dados. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página Fontes de dados depois que a fonte de dados for adicionada com sucesso.

API

Para se conectar Amazon Kendra ao Zendesk

Você deve especificar um JSON do esquema da fonte de dados usando a TemplateConfigurationAPI. Você deve fornecer as seguintes informações:

  • Fonte de dados — especifique o tipo de fonte de dados como ZENDESK quando você usa o esquema TemplateConfigurationJSON. Também especifique a fonte de dados como TEMPLATE quando você chama a CreateDataSourceAPI.

  • URL do host: forneça o URL do host como parte da configuração da conexão ou dos detalhes do endpoint do repositório. Por exemplo, https://yoursubdomain.zendesk.com.

  • Registro de alterações — Se Amazon Kendra deve usar o mecanismo de registro de alterações da fonte de dados do Zendesk para determinar se um documento deve ser atualizado no índice.

    nota

    Use o log de alterações se o Amazon Kendra não quiser digitalizar todos os documentos. Se seu registro de alterações for grande, talvez leve Amazon Kendra menos tempo para digitalizar os documentos na fonte de dados do Zendesk do que para processar o registro de alterações. Se estiver sincronizando a fonte de dados do Zendesk com o índice pela primeira vez, todos os documentos serão digitalizados.

  • Nome de recurso secreto da Amazon (ARN) — Forneça o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contenha as credenciais de autenticação da sua conta do Zendesk. A senha deve conter uma estrutura JSON com as seguintes chaves:

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

  • IAM função — Especifique RoleArn quando você liga CreateDataSource para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e para chamar as APIs públicas necessárias para o conector do Zendesk e. Amazon Kendra Para obter mais informações, consulte Funções do IAM para as fontes de dados do Zendesk.

Você também pode adicionar os seguintes recursos opcionais:

  • Nuvem privada virtual (VPC): especifique a VpcConfiguration quando ao chamar CreateDataSource. Para ter mais informações, consulte Configurando Amazon Kendra para usar um Amazon VPC.

  • Tipos de documento/conteúdo — especifique se deseja rastrear:

    • Tíquetes de suporte, comentários de tíquetes e/ou anexos de comentários de tickets

    • Artigos da central de ajuda, anexos de artigos e comentários de artigos

    • Tópicos, publicações ou comentários da comunidade do guia

  • Filtros de inclusão e exclusão — especifique se deseja incluir ou excluir determinado conteúdo do Slack. Se você usar o token do bot como parte das credenciais do Slack, adicione o token do bot ao canal que deseja indexar. Você não pode indexar mensagens diretas e mensagens de grupo usando um token de bot.

    nota

    A maioria das fontes de dados usa padrões de expressão regular, que são padrões de inclusão ou exclusão chamados de filtros. Se você especificar um filtro de inclusão, somente o conteúdo que corresponda ao filtro de inclusão será indexado. Qualquer documento que não corresponda ao filtro de inclusão não é indexado. Se especificar um filtro de inclusão e exclusão, os documentos que corresponderem ao filtro de exclusão não serão indexados, mesmo que correspondam ao filtro de inclusão.

  • Filtragem de contexto do usuário e controle de acesso —Amazon Kendra rastreia a lista de controle de acesso (ACL) de seus documentos, se você tiver uma ACL para seus documentos. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte Filtrar o contexto do usuário.

  • Mapeamentos de campo: escolha mapear os campos de fonte de dados do Zendesk para os campos de índice do Amazon Kendra . Para obter mais informações, consulte Mapear campos de fonte de dados.

    nota

    O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo do corpo do documento na fonte de dados para o nome do campo de índice_document_body. Todos os demais campos são opcionais.

Para ver uma lista de outras chaves JSON importantes a serem configuradas, consulte Esquema de modelo do Zendesk.

Saiba mais

Para saber mais sobre a integração Amazon Kendra com sua fonte de dados do Zendesk, consulte: