Gmail

PDFRSS

O Gmail é um cliente de e-mail desenvolvido pelo Google em que você pode enviar mensagens de e-mail com anexos de arquivos. As mensagens do Gmail podem ser classificadas e armazenadas na caixa de entrada do e-mail usando pastas e marcadores. Você pode usar Amazon Kendra para indexar suas mensagens de e-mail e anexos de mensagens. Você também pode configurar Amazon Kendra para incluir ou excluir mensagens de e-mail, anexos de mensagens e rótulos específicos para indexação.

Você pode se conectar Amazon Kendra à sua fonte de dados do Gmail usando o Amazon Kendra console e a TemplateConfigurationAPI.

Para solucionar problemas do conector da fonte de dados do Amazon Kendra Gmail, consulteSolucionar 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 de conteúdo completas e incrementais

• Nuvem privada virtual (VPC)

Pré-requisitos

Antes de poder usar Amazon Kendra para indexar sua fonte de dados do Gmail, faça essas alterações no Gmail e AWS nas contas.

No Gmail, verifique se você:

• Criou uma conta de administrador do Google Cloud Platform e um projeto do Google Cloud.

• Ativou a API do Gmail e a API do SDK Admin na conta de administrador.

• Criou uma conta de serviço e baixou uma chave privada JSON para o Gmail. Para obter informações sobre como criar e acessar a chave privada, consulte a documentação do Google Cloud sobre como criar uma chave de conta de serviço e as credenciais da conta de serviço.

• Copiou o e-mail da sua conta de administrador, o e-mail da sua conta de serviço e sua chave privada para usar como suas credenciais de autenticação.

  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 adicionados os seguintes escopos do Oauth (usando uma função de administrador) para o usuário e os diretórios compartilhados que você deseja indexar:

  • https://www.googleapis.com/auth/admin.directory.user.readonly

  • https://www.googleapis.com/auth/gmail.somente leitura

• Verifique se cada documento é exclusivo no Gmail e em 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. IDs Os documentos são globais para um índice e devem ser exclusivos por índice.

No seu Conta da AWS, verifique se você tem:

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

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

  nota

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

• Armazenou suas credenciais de autenticação do Gmail 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 IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e um novo Secrets Manager segredo ao conectar sua fonte de dados do Gmail a. Amazon Kendra Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.

Instruções de conexão

Para se conectar Amazon Kendra à sua fonte de dados do Gmail, você deve fornecer detalhes das suas credenciais do Gmail para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou o Gmail para Amazon Kendra, consultePré-requisitos.

Console

Para se conectar Amazon Kendra ao Gmail

1. Faça login no AWS Management Console e abra o Amazon Kendra console.

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 Conector do Gmail e, em seguida, escolha Adicionar conector. Se estiver usando a versão 2 (se aplicável), escolha o conector do Gmail 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 seus documentos para o í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 seus recursos ou monitorar seus AWS custos.

   5. Escolha Próximo.

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

   1. Autorização — Ative ou desative as informações da lista de controle de acesso (ACL) para seus documentos, se você tiver uma ACL e quiser usá-la para controle de acesso. A ACL especifica quais documentos os 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.

   2. Em Autenticação por AWS Secrets Manager segredo — Escolha um segredo existente ou crie um novo Secrets Manager segredo para armazenar suas credenciais de autenticação do Gmail. Se você optar por criar um novo segredo, uma janela AWS Secrets Manager secreta 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.

         2. E-mail do cliente: o e-mail do cliente copiado da conta de serviço do Google.

         3. E-mail da conta do administrador: o e-mail da conta do administrador que você gostaria de usar.

         4. Chave privada: a chave privada que você copiou da conta de serviço do Google.

         5. Salve e adicione seu segredo.

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

   4. IAM função — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.

      nota

      IAM as funções usadas para índices não podem ser usadas 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.

   5. Escolha Próximo.

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

   1. Para tipos de entidade — Escolha sincronizar anexos de mensagens.

   2. (Opcional) Em Configurações adicionais, insira as seguintes informações:

      1. Intervalo de datas — insira um intervalo de datas para especificar a data de início e término dos e-mails que você deseja rastrear.

      2. Domínios de e-mail — inclua ou exclua determinados e-mails com base nos domínios de e-mail “para”, “de”, “cc” e “bcc”.

      3. Palavras-chave nos assuntos — inclua ou exclua e-mails com base nas palavras-chave nos assuntos dos e-mails.

         nota

         Você também pode optar por incluir qualquer documento que corresponda a todas as palavras-chave do assunto inseridas

      4. Marcadores — Adicione padrões de expressão regular para incluir ou excluir determinados rótulos de e-mail.

      5. Anexos — Adicione padrões de expressão regular para incluir ou excluir determinados anexos de e-mail.

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

      • Sincronização completa: indexe todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados for sincronizada com seu índice.

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

      Importante

      Como não há uma API para atualizar mensagens do Gmail excluídas permanentemente, sincronize conteúdo novo, modificado ou excluído:

      • Não removerá mensagens que foram excluídas permanentemente do Gmail do seu índice Amazon Kendra

      • Não sincronizará alterações nas etiquetas de e-mail do Gmail

      Para sincronizar as alterações no rótulo da fonte de dados do Gmail e as mensagens de e-mail excluídas permanentemente com o índice do Amazon Kendra , execute rastreamentos completos periodicamente.

   4. Em Cronograma de execução de sincronização, em Frequência — Escolha com que frequência sincronizar o conteúdo da fonte de dados e atualizar seu í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 de fonte de dados padrão Amazon Kendra gerados que você deseja mapear para o seu índice.

      nota

      Amazon Kendra O conector de fonte de dados do Gmail não é compatível com a criação de campos de índice personalizados devido às limitações da API.

   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 se conectar Amazon Kendra ao Gmail

Você deve especificar um JSON do esquema da fonte de dados usando o TemplateConfigurationAPI. Você deve fornecer as seguintes informações:

• Fonte de dados — especifique o tipo de fonte de dados como GMAIL quando você usa o TemplateConfigurationEsquema JSON. Além disso, especifique a fonte de dados como TEMPLATE quando você chama o CreateDataSourceAPI.

• Modo de sincronização — especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos seus dados se a sincronização inicial falhar, mesmo que você não escolha a sincronização completa como opção de modo de sincronização. Escolha uma das seguintes opções:

  • FORCED_FULL_CRAWLpara indexar todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados é sincronizada com seu índice.

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

  Importante

  Como não há uma API para atualizar mensagens do Gmail excluídas permanentemente, sincronize conteúdo novo, modificado ou excluído:

  • Não removerá mensagens que foram excluídas permanentemente do Gmail do seu índice Amazon Kendra

  • Não sincronizará alterações nas etiquetas de e-mail do Gmail

  Para sincronizar as alterações no rótulo da fonte de dados do Gmail e as mensagens de e-mail excluídas permanentemente com seu Amazon Kendra índice, você deve executar rastreamentos completos periodicamente.

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

  {
      "adminAccountEmailId": "service account email",
      "clientEmailId": "user account email",
      "privateKey": "private key"
  }

• IAM role — Especifique RoleArn quando você liga CreateDataSource para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e ligar para o público necessário APIs para o conector do Gmail e. Amazon Kendra Para obter mais informações, consulte Funções do IAM para fontes de dados do Gmail.

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 Configurando Amazon Kendra para usar um Amazon VPC.

• Filtros de inclusão e exclusão — especifique se deseja incluir ou excluir determinados e-mails “para”, “de”, “cc”, “bcc”.

  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.

• Filtragem de contexto do usuário e controle de acesso —Amazon Kendra rastreia a lista de controle de acesso (ACL) de seus documentos, se você tiver uma ACL para seus documentos. 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 Gmail para os campos de índice do Amazon Kendra . Para obter mais informações, consulte Mapear campos de fonte de dados.

  nota

  O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo do corpo do documento na fonte de dados para o nome do campo de índice_document_body. Todos os demais campos são opcionais.

  nota

  Amazon Kendra O conector de fonte de dados do Gmail não é compatível com a criação de campos de índice personalizados devido às limitações da API.

Para obter uma lista de outras chaves JSON importantes a serem configuradas, consulte Gmail esquema de modelo.

Saiba mais

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

• Faça pesquisas inteligentes em e-mails no seu espaço de trabalho do Google usando o conector do Gmail para o Amazon Kendra.

Observações

• Como não há uma API para atualizar mensagens do Gmail excluídas permanentemente, uma FULL_CRAWL/Sincronização de conteúdo novo, modificado ou excluído:

  • Não removerá mensagens que foram excluídas permanentemente do Gmail do seu índice Amazon Kendra

  • Não sincronize alterações nas etiquetas de e-mail do Gmail

  Para sincronizar as alterações no rótulo da fonte de dados do Gmail e as mensagens de e-mail excluídas permanentemente com seu Amazon Kendra índice, você deve executar rastreamentos completos periodicamente.

• Amazon Kendra O conector de fonte de dados do Gmail não é compatível com a criação de campos de índice personalizados devido às limitações da API.