Microsoft Exchange - Amazon Kendra
Recursos compatíveisPré-requisitosInstruções de conexãoSaiba maisObservações

Microsoft Exchange

O Microsoft Exchange é uma ferramenta de colaboração corporativa para mensagens, reuniões e compartilhamento de arquivos. Se você for um usuário do Microsoft Exchange, poderá usar o Amazon Kendra para indexar a fonte de dados do Microsoft Exchange.

Você pode se conectar o Amazon Kendra à sua fonte de dados do Microsoft Exchange usando o console do Amazon Kendra e a API TemplateConfiguration.

Para solucionar problemas do conector da fonte de dados do Microsoft Exchange e do Amazon Kendra, consulte Solucionar problemas de origens de dados.

Recursos compatíveis

  • Mapeamentos de campos

  • Controle de acesso do usuário

  • Filtros de inclusão/exclusão

  • Sincronizações completas e incrementais de conteúdo

  • Nuvem privada virtual (VPC)

Pré-requisitos

Antes que você possa usar o Amazon Kendra para indexar a fonte de dados do Microsoft Exchange , faça essas alterações no Microsoft Exchange em suas contas da AWS.

No Microsoft Exchange, verifique se você:

  • Criou uma conta do Microsoft Exchange no Office 365.

  • Anotou o ID de inquilino do Microsoft 365. Encontre o ID de inquilino nas propriedades do portal do Azure Active Directory ou no aplicativo OAuth.

  • Configurou uma aplicação OAuth no portal do Azure e anotou o ID, o segredo ou as credenciais do cliente. Consulte mais informações no tutorial da Microsoft e no exemplo de registro de aplicação.

    nota

    Quando você cria ou registra uma aplicação no portal do Azure, o ID do segredo representa o valor real do segredo. Você deve anotar ou salvar o valor real do segredo imediatamente ao criar o segredo e a aplicação. É possível acessar o segredo selecionando o nome da aplicação no portal do Azure e acessando a opção de menu sobre certificados e segredos.

    É possível acessar o ID de cliente selecionando o nome da aplicação no portal do Azure e acessando a página de visão geral. O ID da aplicação (cliente) é o ID de cliente.

    nota

    É 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 recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).

  • Foram adicionadas as seguintes permissões para a aplicação conector:

    Microsoft Graph Office 365 Exchange Online

    • Mail.Read (Aplicativo)

    • Mail.readBasic (Aplicativo)

    • Mail.ReadBasic.all (Aplicativo)

    • Calendars.Read (Aplicativo)

    • User.Read.All (Aplicativo)

    • Contacts.Read (Aplicativo)

    • Notes.Read.All (Aplicativo)

    • Directory.Read.All (Aplicativo)

    • ews.accessAsUser.all (Delegado)

    		 full_access_as_app (Aplicativo)

  • Verifique se cada documento é exclusivo no Microsoft Exchange e outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. Os IDs de documentos são globais para um índice e devem ser exclusivos por índice.

No Conta da AWS, verifique se você:

  • Criou um índice do Amazon Kendra e, se estiver usando a API, anotou o ID do índice.

  • Criou uma função do IAM para a fonte de dados e, se estiver usando a API, anotou o ARN da função do IAM.

    nota

    Se você alterar o tipo de autenticação e as credenciais, deverá atualizar a função do IAM para acessar o ID secreto correto do AWS Secrets Manager.

  • Armazenou suas credenciais de autenticação do Microsoft Exchange em uma senha do AWS Secrets Manager e, se estiver usando a API, anotou o ARN da senha.

    nota

    Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. Não recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).

Se você não tiver uma função ou senha existente do IAM, poderá usar o console para criar uma nova função do IAM e um nova senha do Secrets Manager ao conectar a fonte de dados do Microsoft Exchange ao Amazon Kendra. Se você estiver usando a API, deverá fornecer o ARN de uma função da IAM e a senha Secrets Manager existentes e um ID de índice.

Instruções de conexão

Para conectar Amazon Kendra à sua fonte de dados do Microsoft Exchange, você deve fornecer os detalhes necessários da fonte de dados do Microsoft Exchange para que o Amazon Kendra possa acessar seus dados. Se você ainda não configurou o Microsoft Exchange para o Amazon Kendra, consulte Pré-requisitos.

Console

Para conectar o Amazon Kendra ao Microsoft Exchange

  1. Faça login no Console de gerenciamento da AWS e abra o console do Amazon Kendra.

  2. No painel de navegação esquerdo, escolha Índices e, em seguida, escolha o índice que deseja usar na lista de índices.

    nota

    Você pode escolher definir ou editar as configurações de Controle de acesso do usuário em Configurações do índice.

  3. Na página Introdução, escolha Adicionar fonte de dados.

  4. Na página Adicionar fonte de dados, escolha o Conector do Microsoft Exchange e Adicionar conector. Se estiver usando a versão 2 (se aplicável), escolha o conector do Microsoft Exchange com a tag “V2.0”.

  5. Na página Especar detalhes da fonte de dados, insira as seguintes informações:

    1. Em Nome e descrição, em Nome da fonte de dados: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.

    2. (Opcional) Descrição: insira uma descrição opcional para a fonte de dados.

    3. Em Idioma padrão: escolha um idioma para filtrar os documentos do índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.

    4. Em Tags, em Adicionar nova tag: inclua tags opcionais para pesquisar e filtrar os recursos ou monitorar os custos da AWS.

    5. Escolha Próximo.

  6. Na página Definir seção e segurança, insira as informações a seguir:

    1. ID de locatário: insira o ID de locatário do Microsoft 365. Encontre o ID de inquilino nas propriedades do portal do Azure Active Directory ou no aplicativo OAuth.

    2. Autorização: ative ou desative as informações da lista de controle de acesso (ACL) para seus documentos, caso tenha uma ACL e queira usá-la para controle de acesso. A ACL especifica quais documentos usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte Filtrar o contexto do usuário.

    3. Segredo do AWS Secrets Manager: escolha um segredo existente ou crie um segredo do Secrets Manager para armazenar as credenciais de autenticação do Microsoft Exchange. Se optar por criar uma nova senha, uma janela secreta do AWS Secrets Manager será aberta.

      1. Insira as seguintes informações em Criar uma janela de senha do AWS Secrets Manager:

        1. Senha: um nome para sua senha. O prefixo “AmazonKendra-Microsoft Exchange

        2. Em ID do cliente, Segredo do cliente: insira as credenciais de autenticação configuradas no Microsoft Exchange no portal do Azure.

      2. Salve e adicione o segredo.

    4. Nuvem privada virtual (VPC): você pode escolher usar uma VPC. Nesse caso, você deve adicionar sub-redes e grupos de segurança da VPC.

    5. Função do IAM: escolha uma função do IAM existente ou crie uma nova função do IAM para acessar as credenciais do repositório e indexar o conteúdo.

      nota

      Funções do IAM usadas para índices não podem ser usados para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha Criar uma nova função para evitar erros.

    6. Escolha Próximo.

  7. Na página Configurar configurações de sincronização, insira as seguintes informações:

    1. IDs de usuário: forneça os e-mails de usuários se quiser filtrar o conteúdo por determinados e-mails.

    2. Configuração adicional: especifique os tipos de conteúdo dos quais você deseja fazer crawling.

      • Tipos de entidade: você pode escolher fazer crawling de conteúdo do calendário, do OneNote ou dos contatos.

      • Crawling do calendário: insira as datas de início e término para fazer crawling do conteúdo entre determinadas datas.

      • Incluir e-mail: insira “para”, “de” e o assunto do e-mail para filtrar determinados e-mails dos quais você deseja fazer crawling.

      • Acesso a pastas compartilhadas: escolha ativar o crawling da lista de controle de acesso para o controle de acesso à sua fonte de dados do Microsoft Exchange.

      • Regex para domínios: adicione padrões de expressão regular para incluir ou excluir certos domínios de e-mail.

      • Padrões Regex: adicionar padrões de expressão regular para incluir ou excluir determinados arquivos.

    3. Modo de sincronização: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Ao sincronizar a fonte de dados com o Amazon Kendra pela primeira vez, é feito crawling de e indexação de todo o conteúdo por padrão. Você deve executar uma sincronização completa dos seus dados se o processo inicial falhar, mesmo que não escolha essa opção de modo de sincronização.

      • Sincronização total: indexa novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.

      • Sincronização nova e modificada: indexe somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

      • Sincronização nova, modificada e excluída: indexe somente o conteúdo novo, modificado e excluído sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

    4. Em Programação de execução de sincronização, em Frequência: escolha com que frequência sincronizar o conteúdo da fonte de dados e atualizar o índice.

    5. Escolha Próximo.

  8. Na página Definir mapeamentos de campo, insira as seguintes informações:

    1. Campos de fonte de dados padrão: selecione entre os campos da fonte de dados padrão gerados do Amazon Kendra que você deseja mapear para o seu índice.

      nota

      O conector da fonte de dados do Amazon Kendra Microsoft Exchange não é compatível com mapeamentos de campo personalizados.

    2. Escolha Próximo.

  9. Na página Revisar e criar, verifique se as informações inseridas estão corretas e selecione Adicionar fonte de dados. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página Fontes de dados depois que a fonte de dados for adicionada com sucesso.

API

Para conectar o Amazon Kendra ao Microsoft Exchange

Especifique um JSON do esquema da fonte de dados usando a API TemplateConfiguration. Você deve fornecer as seguintes informações:

  • Fonte de dados: especifique o tipo de fonte de dados como MSEXCHANGE quando você usa o esquema JSON TemplateConfiguration. Também especifique a fonte de dados como TEMPLATE quando você chama a API CreateDataSource.

  • ID do inquilino: encontre o ID de inquilino nas propriedades do portal do Azure Active Directory ou no aplicativo OAuth.

  • Modo de sincronização: especifique como o Amazon Kendra deve atualizar o índice quando o conteúdo da fonte de dados é alterado. Ao sincronizar a fonte de dados com o Amazon Kendra pela primeira vez, é feito crawling de e indexação de todo o conteúdo por padrão. Você deve executar uma sincronização completa dos seus dados se o processo inicial falhar, mesmo que não escolha essa opção de modo de sincronização. Escolha uma das seguintes opções:

    • FORCED_FULL_CRAWL para indexar novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.

    • FULL_CRAWL para indexar somente o conteúdo novo, modificado e excluído sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

    • CHANGE_LOG para indexar somente o conteúdo novo e modificado sempre que a fonte de dados é sincronizada com o índice. O Amazon Kendra pode usar o mecanismo da fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

  • Nome do recurso da Amazon (ARN) do segredo: forneça o nome do recurso da Amazon (ARN) de um segredo do Secrets Manager que contenha as credenciais de autenticação da conta do Microsoft Exchange. A senha deve conter uma estrutura JSON com as seguintes chaves:

    {
    "clientId": "client ID",
    "clientSecret": "client secret"
}

  • Função do IAM: especifique o RoleArn ao chamar o CreateDataSource para fornecer uma função do IAM com permissões para acessar a senha do Secrets Manager e chamar as APIs públicas necessárias para o conector do Microsoft Exchange e o Amazon Kendra. Para obter mais informações, consulte Funções do IAM para as fontes de dados do Microsoft Exchange.

Você também pode adicionar os seguintes recursos opcionais:

  • Nuvem privada virtual (VPC): especifique a VpcConfiguration quando ao chamar CreateDataSource. Para obter mais informações, consulte Configurar a Amazon Kendra para usar o Amazon VPC.

  • Filtros de inclusão e exclusão: especifique se deseja incluir ou excluir determinados tipos de conteúdo.

    nota

    A maioria das fontes de dados usa padrões de expressão regular, que são padrões de inclusão ou exclusão chamados de filtros. Se você especificar um filtro de inclusão, somente o conteúdo que corresponda ao filtro de inclusão será indexado. Qualquer documento que não corresponda ao filtro de inclusão não é indexado. Se especificar um filtro de inclusão e exclusão, os documentos que corresponderem ao filtro de exclusão não serão indexados, mesmo que correspondam ao filtro de inclusão.

  • Lista de controle de acesso (ACL): especifique se deve ser feito crawling das informações da ACL para seus documentos, caso tenha uma ACL e queira usá-la para controle de acesso. A ACL especifica quais documentos usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte Filtrar o contexto do usuário.

  • Mapeamentos de campo: escolha mapear os campos de fonte de dados do Microsoft Exchange para os campos de índice do Amazon Kendra. Para obter mais informações, consulte Mapeamento de campos de fonte de dados.

    nota

    É obrigatório definir o campo de corpo do documento ou equivalente para que o Amazon Kendra possa pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice _document_body. Todos os demais campos são opcionais.

Consulte uma lista de outras chaves JSON importantes a serem configuradas em Esquema do modelo do Microsoft Exchange.

Saiba mais

Para saber mais sobre a integração do Amazon Kendra com a fonte de dados do Microsoft Exchange, consulte:

Observações

  • Quando as listas de controle de acesso (ACLs) estão habilitadas, a opção “Sincronizar somente conteúdo novo ou modificado” não fica disponível devido às limitações de API do Microsoft Exchange. Em vez disso, recomendamos usar os modos “Sincronização completa” ou “Sincronização de conteúdo novo, modificado ou excluído” ou desativar as ACLs se precisar usar esse modo de sincronização.