View a markdown version of this page

Conecte uma fonte de dados do Confluence - 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 uma fonte de dados do Confluence

Depois de configurar a autenticação e armazenar suas credenciais em AWS Secrets Manager segredo, crie a fonte de dados do Confluence em sua base de conhecimento. Esta página descreve como criar a fonte de dados com a Console de gerenciamento da AWS ou a API, seguida por uma referência para os parâmetros do conector que você pode configurar.

nota

Conclua primeiro a configuração da autenticação. Consulte Configurar a autenticação básica para o Confluence ou Configurar a autenticação OAuth 2.0 para o Confluence. Você precisa do ARN secreto e da URL do host do Confluence.

Crie a fonte de dados

Console
Para conectar o Confluence à sua base de conhecimento gerenciada
  1. Em Fonte de dados, forneça um nome para sua fonte de dados.

  2. Selecione Confluence no menu suspenso da fonte de dados.

  3. Em Fonte, insira seu URL do Confluence (por exemplo,https://example.atlassian.net).

  4. Em Autenticação, selecione Autenticação básica ou Autenticação OAuth 2.0.

  5. Selecione ou crie um AWS Secrets Manager segredo para armazenar suas credenciais.

  6. (Opcional, somente autenticação básica) Para ativar o controle de acesso em nível de documento, selecione Controlar o acesso a documentos com ACLs. O segredo que você selecionar deve incluir adminApiKeyorganizationId, directoryId e. Essa opção não pode ser alterada após a criação. Para obter detalhes, consulte Document-level controles de acesso.

  7. (Opcional) Expanda o escopo da sincronização para escolher quais tipos de entidade rastrear (páginas, blogs, anexos de páginas, anexos de blog, espaços arquivados, páginas arquivadas, espaços pessoais).

  8. (Opcional) Expanda URLs de entidades para usar a URL-based filtragem para sincronizar espaços, páginas e blogs específicos do Confluence.

  9. (Opcional) Expanda o padrão regex de tipos MIME para incluir ou excluir tipos específicos de MIME.

API

Para criar uma fonte de dados do Confluence, envie uma CreateDataSourcesolicitação com um endpoint de tempo de construção do Agents for Amazon Bedrock. O AWS Command Line Interface exemplo a seguir cria uma fonte de dados que usa a autenticação básica. Para usar o OAuth 2.0 em vez disso, authType mude para. OAUTH2 Para ativar o controle de acesso em nível de documento, defina comoaclEnabled. true Para obter uma descrição de cada campo, consulte a referência de parâmetros do conector a seguir.

aws bedrock-agent create-data-source \ --name "Confluence-connector" \ --knowledge-base-id "your-knowledge-base-id" \ --data-source-configuration file://confluence-managed-connector.json

O confluence-managed-connector.json arquivo contém o seguinte:

{ "type": "MANAGED_KNOWLEDGE_BASE_CONNECTOR", "managedKnowledgeBaseConnectorConfiguration": { "connectorParameters": { "type": "CONFLUENCE", "version": "1", "aclEnabled": false, "connectionConfiguration": { "secretArn": "arn:aws:secretsmanager:us-west-2:123456789012:secret:bedrock-confluence-basic-creds", "type": "SAAS", "authType": "BASIC", "hostUrl": "https://example.atlassian.net" }, "dataEntityConfiguration": { "crawlPage": true, "crawlBlog": true, "crawlPageAttachment": true, "crawlBlogAttachment": true }, "filterConfiguration": { "inclusionSpaceKeys": ["ENG", "DOCS"] } } } }

Para bases de conhecimento gerenciadas, CreateDataSource é assíncrono: o status da fonte de dados muda de CREATING para AVAILABLE quando a operação é concluída.

Parâmetros do conector

A configuração da fonte de dados usa os seguintes parâmetros do conector. Para se conectar ao Confluence, especifique CONFLUENCE como tipo de conector. connectorParameters Para os campos que são agrupados connectorParameters (como deletionProtectionConfiguration emediaExtractionConfiguration), consulteConectar uma fonte de dados.

Defina ACLEnabled explicitamente

Se você omitiraclEnabled, o padrão dependerá deauthType: o BASIC padrão é e OAUTH2 o true padrão é. false Como a configuração da ACL é permanente após a criação da fonte de dados, defina aclEnabled explicitamente para que a fonte de dados tenha o comportamento de controle de acesso que você deseja. Para obter detalhes, consulte Document-level controles de acesso.

connectionConfiguration
Campo Obrigatório Descrição
secretArn Sim O ARN do AWS Secrets Manager segredo que contém suas credenciais do Confluence.
type Sim O tipo de implantação do Confluence. Definido como SAAS. Não há suporte para o Confluence Server e o Data Center.
authType Sim O tipo de autenticação. Defina como BASIC ouOAUTH2. Consulte Métodos de autenticação.
hostUrl Sim O URL base da sua instância do Confluence Cloud (por exemplo,https://example.atlassian.net).
dados EntityConfiguration (opcional)
Campo Obrigatório Description
crawlPage Não Se as páginas devem ser rastreadas.
crawlBlog Não Se as postagens do blog devem ser rastreadas.
crawlPageAttachment Não Se os anexos da página devem ser rastreados. Rastejou somente quando também crawlPage está. true
crawlBlogAttachment Não Se os anexos das postagens do blog devem ser rastreados. Rastejou somente quando também crawlBlog está. true
crawlArchivedSpace Não Se os espaços arquivados devem ser rastreados.
crawlArchivedPage Não Se as páginas arquivadas devem ser rastreadas.
crawlPersonalSpace Não Se deve vasculhar espaços pessoais.
Configuração do filtro (opcional)
Campo Obrigatório Description
inclusionSpaceKeys Não Teclas de espaço a serem incluídas.
inclusionSpaceUrls Não URLs de espaço a serem incluídos.
inclusionMimeTypes Não Tipos de MIME a serem incluídos.
exclusionMimeTypes Não Tipos de MIME a serem excluídos.
maxFileSizeInMegaBytes Não Tamanho máximo, em megabytes, de qualquer arquivo que o conector ingere. Forneça como uma string numérica (por exemplo,"500"). O padrão é "500".
Ativado para ACL (opcional)
Campo Obrigatório Description
aclEnabled Não Se o controle de acesso em nível de documento está ativado. trueDefina como habilitar ou false desabilitar. Se você omitir esse campo, o padrão dependerá deauthType: o BASIC padrão étrue; OAUTH2 o padrão é. false A ACL ativada BASIC exige um segredo que inclua as credenciais de administrador da organização Atlassian. Você não pode alterar essa configuração depois de criar a fonte de dados. Para obter detalhes, consulte Document-level controles de acesso.

Alterar o método de autenticação

Você pode alterar o método de autenticação de uma fonte de dados (por exemplo, de OAuth 2.0 para Basic) atualizando a fonte de dados com o novo authType e um segredo que contém as credenciais correspondentes, usando a UpdateDataSourceoperação ou o. Console de gerenciamento da AWS A configuração de controle de acesso em nível de documento é corrigida quando você cria uma fonte de dados, portanto, para adicionar ou remover ACLs, você deve criar uma nova fonte de dados.

Próximas etapas

Depois de criar a fonte de dados, sincronize-a para ingerir conteúdo em sua base de conhecimento. Para obter detalhes, consulte Sincronizar uma fonte de dados. Para filtrar os resultados da consulta por permissões do usuário, consulteDocument-level controles de acesso.