View a markdown version of this page

Integração da base de conhecimento do Atlassian Confluence Cloud - Amazon Quick

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

Integração da base de conhecimento do Atlassian Confluence Cloud

Use a integração da base de conhecimento do Atlassian Confluence Cloud para indexar o conteúdo do Confluence para que os agentes do Amazon Quick possam pesquisar e responder perguntas sobre ele. O Amazon Quick oferece suporte a controles de acesso opcionais em nível de documento (ACLs) para bases de conhecimento do Confluence. Quando ativado, os usuários só veem as respostas dos documentos que estão autorizados a acessar no Confluence. Para obter mais informações, consulte Controles de acesso em nível de documento.

Antes de começar

Verifique se você tem o seguinte antes de configurar a integração.

Se você planeja ativar os controles de acesso em nível de documento, você deve fornecer as credenciais de administrador da Atlassian durante a configuração. Essas credenciais permitem que o Amazon Quick acesse todas as informações de usuários e grupos, independentemente das configurações individuais de visibilidade de e-mail. Sem as credenciais de administrador, a opção ACL não está disponível durante a criação da base de conhecimento. Para fornecer as credenciais de administrador, você precisa do seguinte do administrador da sua organização Atlassian:

  • Chave da API de administração da Atlassian — Uma sequência alfanumérica gerada no portal de administração da Atlassian.

  • ID da organização (UUID) — O identificador exclusivo da sua organização Atlassian. Você pode encontrar isso na URL do seu navegador quando estiver conectado ao portal de administração:admin.atlassian.com/o/orgId.

  • ID do diretório (UUID) — O identificador exclusivo do seu diretório de usuários. Recupere esse valor usando a API Atlassian Admin Workspace.

Para obter etapas detalhadas para obter essas credenciais, consulteObtenha as credenciais de administrador da Atlassian.

Configurar a integração da base de conhecimento

O assistente de configuração tem três etapas: autenticação, criação da base de conhecimento e configurações adicionais.

Autentique sua conta

  1. No console do Amazon Quick, escolha Integrações.

  2. Em Conhecimento, escolha Atlassian Confluence Cloud e escolha o botão Adicionar (mais “+”).

  3. Na caixa de diálogo Criar base de conhecimento do Confluence, em Método de autenticação, escolha uma conta conectada existente no menu suspenso Nome ou escolha Adicionar conta para criar uma nova conexão.

  4. Se você estiver adicionando uma nova conta, preencha os seguintes campos:

    • Nome — Um nome descritivo para sua conexão.

    • Descrição (opcional) — Notas sobre a conexão.

    • URL do Confluence — O URL do seu site da Atlassian (por exemplo,). https://your-site.atlassian.net

  5. (Opcional) Em Gerenciamento de ACL, selecione Usar credenciais de administrador da Atlassian para fornecer as credenciais de administrador da Atlassian. Quando selecionado, insira o seguinte:

    • Chave de API — A chave de API de administração da Atlassian.

    • OrganizationID (UUID) — Seu ID da organização Atlassian.

    • ID do diretório (UUID) — Seu ID do diretório de usuários da Atlassian.

    Importante

    As credenciais de administrador da Atlassian são necessárias para ativar os controles de acesso em nível de documento () ACLs em Configurações adicionais. Sem credenciais de administrador, a opção ACL está desativada. As credenciais de administrador não podem ser adicionadas após a criação da base de conhecimento. Para obter as etapas para obter essas credenciais, consulteObtenha as credenciais de administrador da Atlassian.

  6. Escolha Próximo.

  7. Preencha o pop-up de autenticação do Confluence Cloud que aparece. Analise as permissões solicitadas e escolha Aceitar para autorizar o Amazon Quick a acessar seu conteúdo do Confluence.

Crie a base de conhecimento

  1. Em Criar base de conhecimento, insira um nome para sua base de conhecimento.

  2. (Opcional) Insira uma descrição com notas sobre como a base de conhecimento será usada.

  3. Em Confluence URLs, cole os espaços, blogs ou páginas URLs do Confluence que você deseja incluir. Escolha Adicionar após cada URL.

    nota

    URLs que seguem a estrutura https://company.atlassian.net/wiki/spaces/space-key/overview são tratados como página URLs, não como espaço URLs. Para indexar um espaço inteiro, use o URL do espaço sem /overview (por exemplo,https://company.atlassian.net/wiki/spaces/space-key).

  4. Escolha Avançar: Configurações adicionais para definir controles de acesso e opções de indexação, ou escolha Criar para criar a base de conhecimento com as configurações padrão.

Definir configurações adicionais

  1. Para ativar os controles de acesso no nível do documento, selecione Controlar o acesso ao documento com. ACLs Essa opção só está disponível se você tiver fornecido as credenciais de administrador da Atlassian no método de autenticação. Quando ativado, o Amazon Quick sincroniza as listas de controle de acesso do Confluence e verifica as permissões de cada usuário no momento da consulta. Para obter mais informações sobre como os controles de acesso funcionam, consulteControles de acesso em nível de documento.

    Se você não habilitar ACLs, o acesso será controlado no nível da base de conhecimento. Qualquer pessoa que tenha acesso à base de conhecimento pode obter insights de todo o conteúdo contido nela. Quando ACLs ativados, o acesso é controlado no nível do documento. Os usuários que têm acesso à base de conhecimento só veem respostas de documentos que estão autorizados a acessar no Confluence.

    Importante

    O gerenciamento de ACL não pode ser alterado após a criação da base de conhecimento. Se precisar alterar essa configuração, você deverá criar uma nova base de conhecimento.

    nota

    Se você não forneceu as credenciais de administrador da Atlassian no método de autenticação, essa opção será desativada. Para ativar ACLs, escolha Voltar ou cancelar o assistente e comece novamente com uma conta conectada que inclua credenciais de administrador.

  2. Em Conteúdo multimídia, tamanho do arquivo e padrões de arquivo, configure as seguintes opções de indexação conforme necessário:

    • Conteúdo visual em documentos — indexe conteúdo visual, como imagens e gráficos incorporados em documentos.

    • Arquivos de áudio — indexa anexos de arquivos de áudio.

    • Arquivos de vídeo — indexa anexos de arquivos de vídeo.

    • Tamanho máximo de arquivo único — O tamanho máximo de arquivo para anexos individuais (padrão: 50 MB).

  3. Escolha Criar.

Tipos de conteúdo compatíveis

  • Páginas e postagens de blog do Confluence

  • Anexos da página e da postagem do blog

Quando você adiciona uma URL de espaço do Confluence, o Amazon Quick rastreia todas as páginas e postagens de blog dentro desse espaço. Para ver os tipos de arquivos anexos e os limites de tamanho compatíveis, consulteLimites de tamanho e conteúdo do arquivo.

Gerencie bases de conhecimento

Edite as bases de conhecimento existentes

  1. No console do Amazon Quick, escolha Bases de conhecimento.

  2. Selecione sua base de conhecimento do Confluence Cloud na lista.

  3. Escolha o ícone de três pontos em Ações e escolha Editar base de conhecimento.

  4. Atualize suas configurações conforme necessário e escolha Salvar.

Solução de problemas

Para editar, compartilhar ou excluir sua integração, consulteGerenciando integrações existentes.

Para solução de problemas gerais da base de conhecimento, incluindo problemas de sincronização e documentos ausentes, consulteBases de conhecimento sobre solução de.

Autorização de OAuth aplicativo bloqueada

Sintomas:

  • Mensagem de erro: “O administrador do seu site deve autorizar este aplicativo para o site instance-name .atlassian.net antes que o aplicativo possa acessar sua conta.”

  • Escolher Aceitar na caixa de diálogo de consentimento não tem efeito.

Causa:

O administrador do site da Atlassian bloqueou os aplicativos instalados pelo usuário OAuth . Quando essa configuração está habilitada, somente o administrador do site ou da organização pode autorizar novos aplicativos de terceiros.

Etapas de resolução:

Use uma das opções a seguir para resolver esse problema.

  • Opção 1 (recomendada): o administrador autoriza o aplicativo diretamente

    1. Um administrador do site da Atlassian navega até o Amazon Quick e inicia uma nova configuração da base de conhecimento com o Confluence Cloud.

    2. Como o administrador tem permissões no nível do site, uma tela de consentimento limpa aparece sem o erro.

    3. O administrador escolhe Aceitar para instalar o aplicativo.

    Depois que o administrador autorizar o aplicativo, todos os outros usuários do site poderão se conectar sem problemas.

  • Opção 2: permitir temporariamente aplicativos instalados pelo usuário — um administrador acessaadmin.atlassian.com, navega até Apps, Atlassian Apps e escolhe o link para aplicativos de terceiros e do Marketplace. Em Configurações, encontre Aplicativos instalados pelo usuário e alterne para permitir aplicativos do usuário. Depois que o usuário autorizar o Amazon Quick, alterne a configuração para bloquear os aplicativos do usuário.

Importante

A autorização do administrador se aplica por site da Atlassian, não por organização. Se sua empresa tiver vários sites (por exemplo, team-a.atlassian.net eteam-b.atlassian.net), cada site exigirá uma autorização separada.

nota

Enquanto os aplicativos instalados pelo usuário estão desbloqueados (Opção 2), qualquer usuário no site pode autorizar qualquer aplicativo. OAuth Reative o bloqueio imediatamente após a conexão do usuário.

O pop-up de autenticação falha

Sintomas:

  • O pop-up de autenticação não aparece ou fecha imediatamente.

  • O pop-up aparece, mas não consegue concluir o OAuth fluxo.

Etapas de resolução:

  1. Verifique se seu navegador permite pop-ups do domínio do console Amazon Quick.

  2. Verifique se sua instância do Confluence Cloud pode ser acessada pela sua rede.

  3. Tente usar um navegador diferente ou limpar o cache do navegador.

Conteúdo ausente na base de conhecimento

Sintomas:

  • A sincronização da base de conhecimento é concluída, mas o conteúdo esperado não é indexado.

  • Os resultados da pesquisa não incluem conteúdo de espaços ou páginas específicos.

  • Somente um documento é indexado em um espaço inteiro.

Etapas de resolução:

  1. Verifique se o usuário do Confluence Cloud que se autenticou tem acesso aos espaços e páginas que você selecionou durante a configuração.

  2. Verifique se os tipos de conteúdo selecionados são compatíveis (páginas, publicações do blog e anexos).

  3. Analise a seleção de conteúdo na configuração da sua base de conhecimento para confirmar se os espaços e páginas corretos estão incluídos.

  4. Verifique o sufixo no Confluence URLs . /overview URLs que terminam com /wiki/spaces/space-key/overview são tratados como um URL de página única, não como um espaço completo. Se você pretendia indexar todo o espaço, use o URL do espaço sem /overview (por exemplo,https://company.atlassian.net/wiki/spaces/space-key).

Problemas relacionados à ACL

Nenhum resultado da base de conhecimento habilitada para ACL

  • Verifique se o usuário final fez login no Confluence quando solicitado durante a primeira consulta. O login é necessário para a verificação da permissão em tempo real.

  • Verifique se o usuário final tem acesso ao conteúdo relevante do Confluence em sua instância do Confluence.

Documentos ignorados durante a sincronização

  • Se os relatórios de sincronização mostrarem itens com status IGNORADO, verifique se o usuário autenticador tem acesso aos espaços e páginas do Confluence incluídos na base de conhecimento.

  • Para obter mais informações sobre como verificar o acesso a documentos, consulteVerifique o acesso ao documento (verificação da ACL).