Conecte-se ao Confluence para obter sua base de conhecimento - Amazon Bedrock
Recursos compatíveisPré-requisitosConfiguração de conexão

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

Conecte-se ao Confluence para obter sua base de conhecimento

O Confluence da Atlassian é uma ferramenta colaborativa de gerenciamento de trabalho projetada para compartilhar, armazenar e trabalhar no planejamento de projetos, no desenvolvimento de software e no gerenciamento de produtos. É possível conectar-se à instância do Confluence de sua base de conhecimento do Amazon Bedrock usando o Console de Gerenciamento da AWS para o Amazon Bedrock ou a API CreateDataSource (consulte os SDKs compatíveis com o Amazon Bedrock e a AWS CLI).

nota

O conector de fonte de dados do Confluence está em versão de prévia e está sujeito a alterações.

As fontes de dados do Confluence não aceitam dados multimodais, como tabelas, gráficos, diagramas ou outras imagens.

O Amazon Bedrock é compatível com a conexão com instâncias do Confluence Cloud. No momento, somente o armazenamento de vetores do Amazon OpenSearch Sem Servidor está disponível para uso com essa fonte de dados.

Há limites para quantos arquivos e MB por arquivo podem ser rastreados. Consulte Quotas for knowledge bases.

Recursos compatíveis

  • Detecção automática dos campos de documento principais

  • Filtros de conteúdo de inclusão/exclusão

  • Sincronizações de conteúdo incrementais para conteúdo adicionado, atualizado e excluído

  • Autenticação OAuth 2.0, autenticação com token da API Confluence

Pré-requisitos

No Confluence, verifique se você tem:

  • Anote o URL da instância do Confluence. Por exemplo, para o Confluence Cloud, https://example.atlassian.net. O URL do Confluence Cloud deve ser o URL base, terminando com .atlassian.net.

  • Configure as credenciais básicas de autenticação contendo um nome de usuário (e-mail da conta de administrador) e senha (token da API do Confluence) para permitir que o Amazon Bedrock se conecte à instância do Confluence Cloud. Para obter informações sobre como criar um token da API Confluence, consulte Manage API tokens for your Atlassian account no site da Atlassian.

  • (Opcional) Configure uma aplicação OAuth 2.0 com credenciais de uma chave da aplicação, um segredo da aplicação, um token de acesso e um token de atualização. Para obter mais informações, consulte OAuth 2.0 apps no site da Atlassian.

  • Determinadas permissões ou escopos de leitura devem estar habilitados para que a aplicação OAuth 2.0 se conecte ao Confluence.

    API do Confluence:

    • offline_access

    • read:content:confluence: visualizar conteúdos detalhados.

    • read:content-details:confluence: visualizar detalhes do conteúdo.

    • read:space-details:confluence: visualizar detalhes do espaço.

    • read:audit-log:confluence: visualizar registros de auditoria.

    • read:page:confluence: visualizar páginas.

    • read:attachment:confluence: visualizar e baixar anexos de conteúdo.

    • read:blogpost:confluence: visualizar publicações de blog.

    • read:custom-content:confluence: visualizar conteúdo personalizado.

    • read:comment:confluence: visualizar comentários.

    • read:template:confluence: visualizar modelos de conteúdo.

    • read:label:confluence: visualizar rótulos.

    • read:watcher:confluence: visualizar monitoradores de conteúdo.

    • read:relation:confluence: visualizar relações entre entidades.

    • read:user:confluence: visualizar detalhes do usuário.

    • read:configuration:confluence: visualizar configurações do Confluence.

    • read:space:confluence: visualizar detalhes do espaço.

    • read:space.property:confluence: visualizar propriedades do espaço.

    • read:user.property:confluence: visualizar propriedades do usuário.

    • read:space.setting:confluence: visualizar configurações do espaço.

    • read:analytics.content:confluence: visualizar analytics de conteúdo.

    • read:content.property:confluence: visualizar propriedades do conteúdo.

    • read:content.metadata:confluence: visualizar resumos de conteúdo.

    • read:inlinetask:confluence: visualizar tarefas.

    • read:task:confluence: visualizar tarefas.

    • read:whiteboard:confluence: visualizar quadros brancos.

    • read:app-data:confluence: ler dados da aplicação.

    • read:folder:confluence: visualizar pastas

    • read:embed:confluence: visualizar dados do Smart Link.

Na conta da AWS, não se esqueça de:

  • Armazenar as credenciais de autenticação em um segredo do AWS Secrets Manager e anotar o nome do recurso da Amazon (ARN) do segredo. Seguir as instruções de Configuração da conexão nesta página para incluir os pares de chave-valor que devem ser incluídos no segredo.

  • Incluir as permissões necessárias para se conectar à fonte de dados na política de perfil/permissões do AWS Identity and Access Management (IAM) da base de conhecimento. Para obter informações sobre as permissões necessárias para que essa fonte de dados seja adicionada ao perfil do IAM da base de conhecimento, consulte Permissions to access data sources.

nota

Se usar o console, você poderá ir ao AWS Secrets Manager para adicionar o segredo ou usar um segredo existente como parte da etapa de configuração da fonte de dados. O perfil do IAM com todas as permissões necessárias pode ser criado para você como parte das etapas do console para criação de uma base de conhecimento. Depois que você tiver definido a fonte de dados e as outras configurações, o perfil do IAM com todas as permissões necessárias será aplicado à base de conhecimento específica.

É recomendável atualizar ou alternar regularmente suas credenciais e senhas. Forneça somente o nível de acesso necessário para sua própria segurança. Não é recomendável reutilizar credenciais e senhas em fontes de dados.

Configuração de conexão

Para conectar-se à instância do Confluence, forneça as informações de configuração necessárias para que o Amazon Bedrock possa acessar e rastrear seus dados. Você também deve seguir os Pré-requisitos.

Um exemplo de configuração dessa fonte de dados está incluído nesta seção.

Para obter mais informações sobre a detecção automática dos campos de documento, filtros de inclusão/exclusão, sincronização incremental, credenciais de autenticação de segredos e como eles funcionam, selecione o seguinte:

O conector da fonte de dados detecta e rastreia automaticamente todos os campos de metadados principais dos documentos ou do conteúdo. Por exemplo, o conector da fonte de dados pode rastrear o corpo do documento equivalente aos documentos, o título do documento, a data de criação ou de modificação do documento ou outros campos principais que possam ser aplicados aos documentos.

Importante

Se o conteúdo incluir informações confidenciais, o Amazon Bedrock poderá responder usando informações confidenciais.

Você pode aplicar operadores de filtragem aos campos de metadados para ajudar a aumentar ainda mais a relevância das respostas. Por exemplo, o documento “epoch_modification_time” ou o número de segundos transcorridos desde 1.º de janeiro de 1970, quando o documento foi atualizado pela última vez. Você pode filtrar os dados mais recentes, em que “epoch_modification_time” é maior que um determinado número. Para obter mais informações sobre os operadores de filtragem que podem ser aplicados aos campos de metadados, consulte Metadados e filtragem.

É possível incluir ou excluir o crawling de determinado conteúdo. Por exemplo, é possível especificar um prefixo/padrão de expressão regular para ignorar o crawling de qualquer arquivo que contenha “privado” no nome do arquivo. Também é possível especificar um prefixo de inclusão/padrão de expressão regular para incluir determinadas entidades de conteúdo ou tipos de conteúdo. Se você especificar um filtro de inclusão e de exclusão e ambos corresponderem a um documento, o filtro de exclusão terá precedência e o documento não será rastreado.

Um exemplo de um padrão de expressão regular para excluir ou filtrar arquivos PDF que contêm “privado” no nome do arquivo: “.*private.*\\.pdf”

É possível aplicar filtros de inclusão/exclusão nos seguintes tipos de conteúdo:

  • Space: chave de espaço exclusiva

  • Page: título da página principal

  • Blog: título do blog principal

  • Comment: comentários que pertencem a uma determinada página ou blog. Especificar Re: Título da página/blog

  • Attachment: nome do arquivo anexado com sua extensão

O conector da fonte de dados rastreia conteúdo novo, modificado e excluído sempre que a fonte de dados for sincronizada com a base de conhecimento. O Amazon Bedrock pode usar o mecanismo de fonte de dados para rastrear alterações no conteúdo e o conteúdo que foi alterado desde a última sincronização. Ao sincronizar a fonte de dados com a base de conhecimento pela primeira vez, todo o conteúdo é rastreado por padrão.

Para sincronizar a fonte de dados com a base de conhecimento, use a API StartIngestionJob ou selecione a base de conhecimento no console e escolha Sincronizar na seção de visão geral da fonte de dados.

Importante

Todos os dados que você sincroniza na fonte de dados ficam disponíveis para qualquer pessoa com permissões bedrock:Retrieve para recuperá-los. Isso também pode incluir quaisquer dados com permissões de fonte de dados controladas. Para obter mais informações, consulte Knowledge base permissions.

(Se estiver usando autenticação básica) Suas credenciais de autenticação secreta do AWS Secrets Manager devem incluir esses pares de chave-valor:

  • username: endereço de e-mail do usuário administrador da conta da Atlassian

  • password: token da API Confluence

(Se estiver usando a autenticação OAuth 2.0) Suas credenciais de autenticação secreta do AWS Secrets Manager devem incluir esses pares de chave-valor:

  • confluenceAppKey: chave da aplicação

  • confluenceAppSecret: segredo da aplicação

  • confluenceAccessToken: token de acesso da aplicação

  • confluenceRefreshToken: token de atualização da aplicação

nota

O token de acesso do Confluence OAuth2.0 tem um prazo de expiração padrão de 60 minutos. Se esse token expirar enquanto a fonte de dados estiver em sincronização (trabalho de sincronização), o Amazon Bedrock usará o token de atualização fornecido para regenerar esse token. Essa regeneração atualiza os tokens de acesso e de atualização. Para manter os tokens atualizados do trabalho de sincronização atual até o próximo trabalho de sincronização, o Amazon Bedrock exige permissões de gravação/colocação para suas credenciais secretas como parte do perfil do IAM da sua base de conhecimento.

nota

O segredo no AWS Secrets Manager deve usar a mesma região da base de conhecimento.

Console
Conectar uma instância do Confluence à base de conhecimento

  1. Siga as etapas em Crie uma base de conhecimento conectando-se a uma fonte de dados nas Bases de Conhecimento do Amazon Bedrock e escolha o Confluence como fonte de dados.

  2. Forneça um nome e uma descrição opcional para a fonte de dados.

  3. Forneça o URL da instância do Confluence. Por exemplo, para o Confluence Cloud, https://example.atlassian.net. O URL do Confluence Cloud deve ser o URL base, terminando com .atlassian.net.

  4. Na seção Configurações avançadas, você pode, opcionalmente, configurar o seguinte:

    • Chave do KMS para armazenamento de dados temporário. – Você pode criptografar os dados temporários enquanto converte seus dados em incorporações com a Chave gerenciada pela AWS padrão ou sua própria chave do KMS. Para obter mais informações, consulte Criptografia de armazenamento de dados temporário durante a ingestão de dados.

    • Política de exclusão de dados: você pode excluir as incorporações de vetores da sua fonte de dados que estão armazenadas no armazenamento de vetores por padrão ou optar por reter os dados do armazenamento de vetores.

  5. Forneça as informações de autenticação para conectar-se à instância do Confluence:

    • Para autenticação básica, acesse o AWS Secrets Manager para adicionar suas credenciais de autenticação secreta ou usar um nome do recurso da Amazon (ARN) existente para o segredo criado. O segredo deve conter o endereço de e-mail do usuário administrador da conta da Atlassian como o nome de usuário e um token da API Confluence no lugar de uma senha. Para obter informações sobre como criar um token da API Confluence, consulte Manage API tokens for your Atlassian account no site da Atlassian.

    • Para autenticação OAuth 2.0, acesse o AWS Secrets Manager para adicionar as credenciais de autenticação secreta ou usar um nome do recurso da Amazon (ARN) existente para o segredo criado. O segredo deve conter a chave da aplicação Confluence, o segredo da aplicação, o token de acesso e o token de atualização. Para obter mais informações, consulte OAuth 2.0 apps no site da Atlassian.

  6. (Opcional) Na seção Análise e fragmentação de conteúdo, você pode personalizar a forma de analisar e fragmentar seus dados. Consulte os seguintes recursos para saber mais sobre essas personalizações:

  7. Opte por usar filtros/padrões de expressões normais para incluir ou excluir determinado conteúdo. Caso contrário, todo o conteúdo padrão será rastreado.

  8. Continue escolhendo um modelo de incorporação e um armazenamento de vetores. Para ver as etapas restantes, retorne a Crie uma base de conhecimento conectando-se a uma fonte de dados nas Bases de Conhecimento do Amazon Bedrock e continue após a etapa de conexão da fonte de dados.

API

Veja um exemplo de uma configuração para conexão ao Confluence Cloud da base de conhecimento do Amazon Bedrock. Você configura a fonte de dados usando a API com a AWS CLI ou o SDK compatível, como o Python. Depois de chamar CreateKnowledgeBase, você chama CreateDataSource para criar a fonte de dados com suas informações de conexão em dataSourceConfiguration.

Para saber mais sobre personalizações que você pode aplicar à ingestão incluindo o campo opcional vectorIngestionConfiguration, consulte Personalizar a ingestão para uma fonte de dados.

AWS Command Line Interface

aws bedrock create-data-source \
 --name "Confluence Cloud/SaaS connector" \
 --description "Confluence Cloud/SaaS data source connector for Amazon Bedrock to use content in Confluence" \
 --knowledge-base-id "your-knowledge-base-id" \
 --data-source-configuration file://confluence-bedrock-connector-configuration.json \
 --data-deletion-policy "DELETE" \
 --vector-ingestion-configuration '{"chunkingConfiguration":[{"chunkingStrategy":"FIXED_SIZE","fixedSizeChunkingConfiguration":[{"maxTokens":"100","overlapPercentage":"10"}]}]}'

confluence-bedrock-connector-configuration.json
{
    "confluenceConfiguration": {
        "sourceConfiguration": {
            "hostUrl": "https://example.atlassian.net",
            "hostType": "SAAS",
            "authType": "OAUTH2_CLIENT_CREDENTIALS",
            "credentialsSecretArn": "arn:aws::secretsmanager:your-region:secret:AmazonBedrock-Confluence"
        },
        "crawlerConfiguration": {
            "filterConfiguration": {
                "type": "PATTERN",
                "patternObjectFilter": {
                    "filters": [
                        {
                            "objectType": "Attachment",
                            "inclusionFilters": [
                                ".*\\.pdf"
                            ],
                            "exclusionFilters": [
                                ".*private.*\\.pdf"
                            ]
                        }
                    ]
                }
            }
        }
    },
    "type": "CONFLUENCE"
}