Conectar-se ao Microsoft SharePoint para acessar sua base de conhecimento - Amazon Bedrock
Recursos compatíveisPré-requisitosConfiguração de conexão

Conectar-se ao Microsoft SharePoint para acessar sua base de conhecimento

O Microsoft SharePoint é um serviço colaborativo baseado na web para trabalhar em documentos, páginas da web, sites, listas e muito mais. Você pode se conectar à instância do SharePoint da 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 SharePoint está em versão de pré-visualização e está sujeito a alterações.

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

O Amazon Bedrock dá suporte à conexão com instâncias do SharePoint Online. O crawling de documentos do OneNote não é compatível no momento. 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 somente para aplicativo do SharePoint

Pré-requisitos

SharePoint (Online)

No SharePoint (Online), siga as etapas abaixo para usar a autenticação somente para aplicações do SharePoint:

  • Anotar os URLs do site do SharePoint Online. Por exemplo, https://yourdomain.sharepoint.com/sites/mysite. O URL deve começar com https e conter sharepoint.com. O URL do site deve ser o site do SharePoint real, e não sharepoint.com/ ou sites/mysite/home.aspx

  • Anotar o nome do domínio dos URLs da instância do SharePoint Online.

  • Copie o ID de locatário do Microsoft 365. Encontre o ID de locatário em “Properties” no portal do Microsoft Entra. Consulte mais detalhes em Find your Microsoft 365 tenant ID.

    nota

    Para ver uma aplicação de exemplo, consulte Register a client application in Microsoft Entra ID (anteriormente conhecido como Azure Active Directory) no site do Microsoft Learn.

  • Configure as credenciais somente para aplicações do SharePoint.

  • Copie o ID do cliente e o valor do segredo do cliente ao conceder permissão somente para aplicações do SharePoint. Para ter mais informações, consulte Granting access using SharePoint App-Only.

    nota

    Você não precisa configurar nenhuma permissão de API para o SharePoint App-Only. No entanto, você deve configurar as permissões da aplicação no SharePoint. Para ter mais informações sobre as permissões de aplicação necessárias, consulte Granting access using SharePoint App-Only na documentação da Microsoft.

Conta da AWS

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 se conectar à instância do SharePoint, você deve fornecer as informações de configuração necessárias para que o Amazon Bedrock possa acessar e rastrear os 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:

  • Page: título da página principal

  • Event: nome do evento

  • File: nome do arquivo com a extensão para anexos e todos os arquivos de documento

O crawling de documentos do OneNote não é compatível no momento.

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.

Ao usar a autenticação somente para aplicações do SharePoint, suas credenciais de autenticação secreta do AWS Secrets Manager precisa incluir estes pares de chave-valor:

  • clientId: ID do cliente associado à aplicação do SharePoint no Microsoft Entra.

  • clientSecret: segredo do cliente associado à aplicação do SharePoint no Microsoft Entra.

  • sharePointClientId: ID do cliente gerado ao registrar a aplicação do SharePoint para a autenticação somente para aplicações.

  • sharePointClientSecret: segredo do cliente gerado ao registrar a aplicação do SharePoint para a autenticação somente para aplicações.

nota

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

Console
Conectar uma instância do SharePoint à 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 SharePoint como fonte de dados.

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

  3. Forneça os URL/URLs do site do SharePoint. Por exemplo, para SharePoint Online, https://yourdomain.sharepoint.com/sites/mysite. O URL deve começar com https e conter sharepoint.com. O URL do site deve ser o site do SharePoint real, e não sharepoint.com/ ou sites/mysite/home.aspx

  4. Forneça o nome do domínio da instância do SharePoint.

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

  6. Forneça as informações de autenticação para se conectar à instância do SharePoint. Para autenticação somente para aplicações do SharePoint:

    1. Forneça o ID de locatário. É possível encontrar o ID de locatário nas propriedades do portal do Azure Active Directory.

    2. Acesse o AWS Secrets Manager para adicionar suas credenciais secretas ou use um nome do recurso da Amazon (ARN) existente para o segredo criado. Seu segredo deve conter o ID do cliente e o segredo do cliente do SharePoint gerados quando você registrou a autenticação somente para aplicações em nível de locatário ou de site, bem como o ID do cliente e o segredo do cliente do Entra gerados quando você registra a aplicação no Entra.

  7. (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:

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

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

Este é um exemplo de uma configuração para conexão ao SharePoint Online para a 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-agent create-data-source \
 --name "SharePoint Online connector" \
 --description "SharePoint Online data source connector for Amazon Bedrock to use content in SharePoint" \
 --knowledge-base-id "your-knowledge-base-id" \
 --data-source-configuration file://sharepoint-bedrock-connector-configuration.json \
 --data-deletion-policy "DELETE"

Conteúdo de sharepoint-bedrock-connector-configuration.json

{
    "sharePointConfiguration": {
        "sourceConfiguration": {
            "tenantId": "888d0b57-69f1-4fb8-957f-e1f0bedf64de",
            "hostType": "ONLINE",
            "domain": "yourdomain",
            "siteUrls": [
                "https://yourdomain.sharepoint.com/sites/mysite"
            ],
            "authType": "OAUTH2_SHAREPOINT_APP_ONLY_CLIENT_CREDENTIALS",
            "credentialsSecretArn": "arn:aws::secretsmanager:your-region:secret:AmazonBedrock-SharePoint"
        },
        "crawlerConfiguration": {
            "filterConfiguration": {
                "type": "PATTERN",
                "patternObjectFilter": {
                    "filters": [
                        {
                            "objectType": "File",
                            "inclusionFilters": [
                                ".*\\.pdf"
                            ],
                            "exclusionFilters": [
                                ".*private.*\\.pdf"
                            ]
                        }
                    ]
                }
            }
        }
    },
    "type": "SHAREPOINT"
}
Importante

A autenticação OAuth2.0 não é recomendada. Recomendamos usar a autenticação somente para aplicações do SharePoint.

Usando o OAuth 2.0, você pode autenticar e autorizar o acesso aos recursos do SharePoint para conectores do SharePoint integrados às bases de conhecimento.

Pré-requisitos

No SharePoint, para a autenticação OAuth 2.0, você deve:

  • Anotar os URLs do site do SharePoint Online. Por exemplo, https://yourdomain.sharepoint.com/sites/mysite. O URL deve começar com https e conter sharepoint.com. O URL do site deve ser o site do SharePoint real, e não sharepoint.com/ ou sites/mysite/home.aspx

  • Anotar o nome do domínio dos URLs da instância do SharePoint Online.

  • Copie o ID de locatário do Microsoft 365. Encontre o ID de locatário em “Properties” no portal do Microsoft Entra ou na aplicação OAuth.

    Anote o nome de usuário e a senha da conta do SharePoint administrativa e copie o ID do cliente e o valor do segredo do cliente ao registrar uma aplicação.

    nota

    Para ver uma aplicação de exemplo, consulte Register a client application in Microsoft Entra ID (anteriormente conhecido como Azure Active Directory) no site do Microsoft Learn.

  • Determinadas permissões de leitura são necessárias para se conectar ao SharePoint ao registrar uma aplicação.

    • SharePoint: AllSites.Read (delegado): ler itens em todos os conjuntos de sites

  • Talvez você precise desativar Padrões de segurança no portal do Azure usando um usuário administrador. Para obter mais informações sobre como gerenciar as configurações padrão de segurança no portal do Azure, consulte a documentação da Microsoft sobre como habilitar/desabilitar padrões de segurança.

  • Talvez você precise desativar a autenticação multifator (MFA) na conta do SharePoint, de maneira que o Amazon Bedrock não seja impedido de realizar crawling no conteúdo do SharePoint.

Para atender aos pré-requisitos, verifique se as etapas foram concluídas em Conta da AWS.

Credenciais de autenticação secreta

Com relação à configuração de conexão para o OAuth2.0, você pode executar as mesmas etapas para detecção automática dos campos principais do documento, filtros de inclusão/exclusão e sincronização incremental, conforme descrito em Configuração de conexão.

Para autenticação OAuth 2.0, suas credenciais de autenticação secreta no AWS Secrets Manager devem incluir estes pares de chave-valor.

  • username: nome de usuário do administrador do SharePoint

  • password: senha de administrador do SharePoint

  • clientId: ID do cliente da aplicação OAuth

  • clientSecret: segredo do cliente da aplicação OAuth

Conectar uma instância do SharePoint à base de conhecimento

Para conectar uma instância do SharePoint à base de conhecimento ao usar o OAuth 2.0:

  • (console) No console, siga as mesmas etapas descritas em Conectar uma instância do SharePoint à base de conhecimento. Quando você desejar fornecer as informações de autenticação para se conectar à instância do SharePoint.

    • Forneça o ID de locatário. É possível encontrar o ID de locatário nas propriedades do portal do Azure Active Directory.

    • Acesse o AWS Secrets Manager para adicionar suas credenciais de autenticação secreta ou use um nome do recurso da Amazon (ARN) existente para o segredo criado. O segredo deve conter o nome de usuário e a senha do administrador do SharePoint, além do ID do cliente da aplicação registrado e do segredo do cliente. Para ver uma aplicação de exemplo, consulte Register a client application in Microsoft Entra ID (anteriormente conhecido como Azure Active Directory) no site do Microsoft Learn.

  • (API) Veja a seguir um exemplo de uso da API CreateDataSource para criar uma fonte de dados com suas informações de conexão para o OAuth2.0.

    aws bedrock-agent create-data-source \
 --name "SharePoint Online connector" \
 --description "SharePoint Online data source connector for Amazon Bedrock to use content in SharePoint" \
 --knowledge-base-id "your-knowledge-base-id" \
 --data-source-configuration file://sharepoint-bedrock-connector-configuration.json \
 --data-deletion-policy "DELETE"

    Conteúdo de sharepoint-bedrock-connector-configuration.json

    {
    "sharePointConfiguration": {
        "sourceConfiguration": {
            "tenantId": "888d0b57-69f1-4fb8-957f-e1f0bedf64de",
            "hostType": "ONLINE",
            "domain": "yourdomain",
            "siteUrls": [
                "https://yourdomain.sharepoint.com/sites/mysite"
            ],
            "authType": "OAUTH2_CLIENT_CREDENTIALS",
            "credentialsSecretArn": "arn:aws::secretsmanager:your-region:secret:AmazonBedrock-SharePoint"
        },
        "crawlerConfiguration": {
            "filterConfiguration": {
                "type": "PATTERN",
                "patternObjectFilter": {
                    "filters": [
                        {
                            "objectType": "File",
                            "inclusionFilters": [
                                ".*\\.pdf"
                            ],
                            "exclusionFilters": [
                                ".*private.*\\.pdf"
                            ]
                        }
                    ]
                }
            }
        }
    },
    "type": "SHAREPOINT"
}