Conecte-se ao Confluence para obter sua base de conhecimento do Amazon Bedrock - Amazon Bedrock

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 do Amazon Bedrock

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. Você pode se conectar à sua instância do Confluence para sua base de conhecimento do Amazon Bedrock usando o console de AWS gerenciamento do Amazon Bedrock ou o (CreateDataSourceAPIconsulte Amazon Bedrock suportado e). SDKs 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 oferecem suporte a 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. Atualmente, somente o armazenamento vetorial Amazon OpenSearch Serverless 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

  • OAuthAutenticação 2.0, autenticação com token Confluence API

Pré-requisitos

No Confluence, verifique se você tem:

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

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

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

  • Certas permissões ou escopos de leitura devem ser habilitados para que seu aplicativo OAuth 2.0 se conecte ao Confluence.

    Confluência: API

    • offline_access

    • read:content:confluence — Exibir conteúdos detalhados

    • read:content-details:confluence — Visualizar detalhes do conteúdo

    • read:space-details:confluence — Exibir detalhes do espaço

    • read:audit-log:confluence — Exibir registros de auditoria

    • read:page:confluence — Exibir páginas

    • read:attachment:confluence — Visualize e baixe anexos de conteúdo

    • read:blogpost:confluence — Veja as postagens do blog

    • read:custom-content:confluence — Exibir conteúdo personalizado

    • read:comment:confluence — Ver comentários

    • read:template:confluence — Exibir modelos de conteúdo

    • read:label:confluence — Exibir rótulos

    • read:watcher:confluence — Veja os observadores de conteúdo

    • read:relation:confluence — Exibir relacionamentos entre entidades

    • read:user:confluence — Exibir detalhes do usuário

    • read:configuration:confluence — Exibir configurações do Confluence

    • read:space:confluence — Exibir detalhes do espaço

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

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

    • read:space.setting:confluence — Exibir configurações de espaço

    • read:analytics.content:confluence — Exibir análise de conteúdo

    • read:content.property:confluence — Exibir propriedades do conteúdo

    • read:content.metadata:confluence — Exibir resumos do conteúdo

    • read:inlinetask:confluence — Exibir tarefas

    • read:task:confluence — Exibir tarefas

    • read:whiteboard:confluence — Exibir quadros brancos

    • read:app-data:confluence — Leia dados do aplicativo

    • read:folder:confluence - Exibir pastas

    • read:embed:confluence - Exibir dados do Smart Link

Em sua AWS conta, certifique-se de:

  • Armazene suas credenciais de autenticação em um AWS Secrets Manager segredo e anote o Amazon Resource Name (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 à sua IAM função na base de conhecimento, consulte Permissões para acessar fontes de dados.

nota

Se você usa o console, pode adicionar seu segredo ou usar um segredo existente como parte da etapa de configuração da fonte de dados. AWS Secrets Manager A IAM função com todas as permissões necessárias pode ser criada para você como parte das etapas do console para criar uma base de conhecimento. Depois de configurar sua fonte de dados e outras configurações, a IAM função com todas as permissões necessárias é aplicada à sua 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 seu conteúdo incluir informações confidenciais, 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, você pode especificar um padrão de prefix/regular expression pattern to skip crawling any file that contains “private” in the file name. You could also specify an inclusion prefix/regular expressão de exclusão 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 PDF arquivos que contêm “privado” no nome do arquivo:”. *privado.*\\ .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. Especifique Re: Page/Blog Title

  • 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 sua fonte de dados é sincronizada com sua base de conhecimento. Amazon Bedrock pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e rastrear 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 sua fonte de dados com sua base de conhecimento, use StartIngestionJobAPIou selecione sua base de conhecimento no console e selecione 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: admin user email address of Atlassian account

  • password: Confluence API token

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

  • confluenceAppKey: app key

  • confluenceAppSecret: app secret

  • confluenceAccessToken: app access token

  • confluenceRefreshToken: app refresh token

nota

O token de acesso do Confluence OAuth2 4.0 tem um tempo 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 da tarefa de sincronização atual para a próxima tarefa de sincronização, o Amazon Bedrock exige permissões de gravação/colocação para suas credenciais secretas como parte de sua função na base de conhecimento. IAM

nota

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

Console
Conecte uma instância do Confluence à sua base de conhecimento
  1. Siga as etapas em Crie uma base de conhecimento nas bases de conhecimento 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 sua instância do Confluence. URL Por exemplo, para o Confluence Cloud,. https://example.atlassian.net O URL for Confluence Cloud deve ser a baseURL, terminando com. .atlassian.net

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

    • KMSchave para armazenamento transitório de dados. — Você pode criptografar os dados transitórios enquanto converte seus dados em incorporações com a chave padrão Chave gerenciada pela AWS ou sua própria chave. 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 vetoriais da sua fonte de dados que estão armazenadas no armazenamento vetorial por padrão ou optar por reter os dados do armazenamento vetorial.

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

    • Para autenticação básica, acesse AWS Secrets Manager para adicionar suas credenciais de autenticação secreta ou usar um Amazon Resource Name (ARN) existente para o segredo que você criou. Seu segredo deve conter o endereço de e-mail do usuário administrador da conta Atlassian como nome de usuário e um API token do Confluence no lugar de uma senha. Para obter informações sobre como criar um API token do Confluence, consulte Gerenciar API tokens para sua conta Atlassian no site da Atlassian.

    • Para a autenticação OAuth 2.0, acesse AWS Secrets Manager para adicionar suas credenciais de autenticação secreta ou usar um Amazon Resource Name (ARN) existente para o segredo que você criou. 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 Aplicativos OAuth 2.0 no site da Atlassian.

  6. (Opcional) Na seção Análise e fragmentação de conteúdo, você pode personalizar como 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 vetorial. Para ver as etapas restantes, retorne Crie uma base de conhecimento nas bases de conhecimento Amazon Bedrock e continue a partir da etapa após conectar sua 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 sua fonte de dados usando o API com o AWS CLI ou compatívelSDK, como Python. Depois de ligar CreateKnowledgeBase, você liga CreateDataSourcepara criar sua fonte de dados com suas informações de conexãodataSourceConfiguration.

Para saber mais sobre personalizações que você pode aplicar à ingestão incluindo o vectorIngestionConfiguration campo opcional, consulte. Personalizar a ingestão de 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" }