Drupal - Amazon Kendra

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

Drupal

O Drupal é um sistema de gerenciamento de conteúdo de código aberto (CMS) que pode ser usado para criar sites e aplicativos da Web. Você pode usar Amazon Kendra para indexar o seguinte no Drupal:

  • Conteúdo: artigos, páginas básicas, blocos básicos, tipos de conteúdo definidos pelo usuário, tipos de blocos definidos pelo usuário, tipos de conteúdo personalizados e tipos de blocos personalizados

  • Comentário: para qualquer tipo de conteúdo e tipo de bloco

  • Anexos: para qualquer tipo de conteúdo e tipo de bloco

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

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

Atributos compatíveis

Amazon Kendra O conector de fonte de dados Drupal oferece suporte aos seguintes recursos:

  • Mapeamentos de campos

  • Filtragem de contexto 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 Drupal, faça essas alterações no Drupal e nas contas. AWS

No Drupal, verifique se você:

  • Criou uma conta do Drupal (Standard) Suite e um usuário com função de administrador.

  • Copiou o nome do site do Drupal e configurou um URL de host. Por exemplo, https:///<hostname><drupalsitename>.

  • Credenciais básicas de autenticação configuradas contendo um nome de usuário (nome de usuário de login do site do Drupal) e senha (senha do site do Drupal).

  • Recomendado: configurou um token de credencial do OAuth 2.0. Use esse token junto com a concessão de senha do Drupal, o ID do cliente, a senha do cliente, o nome de usuário (nome de usuário de login do site do Drupal) e senha (senha do site do Drupal) para se conectar ao Amazon Kendra.

  • As seguintes permissões foram adicionadas à sua conta do Drupal usando uma função de administrador:

    • administrar blocos

    • administrar blocos_exibição de conteúdo

    • administrar blocos_campos de conteúdo

    • administrar blocos_exibição de formulário de conteúdo

    • administrar visualizações

    • visualizar endereços de e-mail do usuário

    • ver conteúdo próprio não publicado

    • ver revisões da página

    • ver revisões do artigo

    • ver todas as revisões

    • ver o tema de administração

    • acessar conteúdo

    • visão geral do conteúdo do acesso

    • acessar comentários

    • pesquisar conteúdo

    • visão geral dos arquivos de acesso

    • acessar links contextuais

    nota

    Se houver tipos de conteúdo definidos pelo usuário, tipos de blocos definidos pelo usuário ou se quaisquer visualizações e blocos forem adicionados ao site do Drupal, eles deverão receber acesso de administrador.

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 Drupal 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 Secrets Manager segredo ao conectar sua fonte de dados do Drupal 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 Drupal, você deve fornecer detalhes de suas credenciais do Drupal para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou o Drupal para Amazon Kendra ver. Pré-requisitos

Console

Para se conectar Amazon Kendra ao Drupal

  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 Drupal e, em seguida, escolha Adicionar conector. Se estiver usando a versão 2 (se aplicável), escolha o conector Drupal 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. Em Fonte, para URL do host: o URL do host do site do Drupal. Por exemplo, https:///<hostname><drupalsitename>.

    2. Para o Local do certificado SSL, insira o caminho para o certificado SSL armazenado em um bucket do Amazon S3 .

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

    4. Para a Autenticação, escolha entre Autenticação básica e Autenticação Oauth 2.0 com base no seu caso de uso.

    5. AWS Secrets Manager segredo — Escolha um segredo existente ou crie um novo Secrets Manager segredo para armazenar suas credenciais de autenticação do Drupal. 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. Se você escolher a Autenticação básica, digite uma senha, o Nome de usuário (nome de usuário do site do Drupal) e a Senha (senha do site do Drupal) que você copiou e escolha Salvar e adicionar senha.

        2. Se você escolheu a Autenticação OAuth 2.0, insira uma senha, Nome de usuário (nome de usuário do site do Drupal), Senha (senha do site do Drupal), ID do cliente e Senha do cliente gerados na conta do Drupal e escolha Salvar e adicionar senha.

      2. Escolha Salvar.

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

    7. Rastreador de identidade — especifique se deseja ativar o rastreador Amazon Kendra de identidade. O rastreador de identidade usa as informações da lista de controle de acesso (ACL) dos seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a filtragem de contexto Amazon Kendra do usuário dos resultados da pesquisa. Caso contrário, se o rastreador de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a PutPrincipalMappingAPI para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.

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

    9. Escolha Próximo.

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

    1. Em Sincronizar escopo, escolha uma das opções a seguir:

      nota

      Ao escolher rastrear Artigos, Páginas básicas e Blocos básicos, os campos padrão serão sincronizados automaticamente. Você também pode optar por sincronizar comentários, anexos, campos personalizados e outras entidades personalizadas.

      1. Para Selecionar entidades:

        • Artigos: escolha se deseja rastrear Artigos, seus comentários em Comentários e Anexos.

        • Páginas básicas: escolha se deseja rastrear as Páginas básicas, seus comentários em Comentários e Anexos.

        • Blocos básicos: escolha se deseja rastrear os Blocos básicos, seus comentários em Comentários e Anexos.

        • Também é possível adicionar Tipos de conteúdo personalizados e Blocos personalizados.

    2. Para Opções de configuração opcionais:

      • Para o padrão Regex, adicione padrões de expressão regular para incluir ou excluir títulos de entidades e nomes de arquivos específicos. Você pode adicionar até 100 padrões.

    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.

    4. Em Cronograma de execução da sincronização, em Frequência, escolha com que frequência o Amazon Kendra será sincronizado com a fonte de dados.

    5. Escolha Próximo.

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

    1. Para Conteúdo, Comentários e Anexos — Selecione entre os campos da fonte de dados padrão Amazon Kendra gerados que você deseja mapear para o seu índice.

    2. Adicionar campo: para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.

    3. 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 Drupal

Você deve especificar 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 DRUPAL quando você usa o esquema TemplateConfigurationJSON. Além disso, especifique a fonte de dados como TEMPLATE quando você chama a 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.

    • CHANGE_LOGpara indexar somente conteúdo novo e modificado 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.

  • 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 que você criou na sua conta do Drupal.

    Se você usar uma autenticação básica, a senha deverá conter uma estrutura JSON com as seguintes chaves:

    { "username": "user name", "password": "password" }

    Para usar a autenticação OAuth 2.0, a senha é armazenada em uma estrutura JSON com as seguintes chaves:

    { "username": "user name", "password": "password", "clientId": "client id", "clientSecret": "client secret" }
    nota
    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).

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

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

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

  • Filtros de inclusão e exclusão: você pode especificar se deseja incluir conteúdo, comentários e anexos. Você também pode especificar padrões de expressão regular para incluir ou excluir conteúdos, comentários e anexos.

    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.

  • Rastreador de identidade — especifique se deseja ativar o rastreador Amazon Kendra de identidade. O rastreador de identidade usa as informações da lista de controle de acesso (ACL) dos seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a filtragem de contexto Amazon Kendra do usuário dos resultados da pesquisa. Caso contrário, se o rastreador de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a PutPrincipalMappingAPI para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.

  • Mapeamentos de campo: escolha mapear os campos de fonte de dados do Drupal 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.

Para ver uma lista de outras chaves JSON importantes a serem configuradas, consulte Esquema de modelos do Drupal.

Observações

  • As APIs do Drupal não têm limites oficiais de controle de utilização.

  • Os SDKs Java não estão disponíveis para o Drupal.

  • Os dados do Drupal só podem ser obtidos usando as APIs JSON nativas.

  • Os tipos de conteúdo não associados a nenhuma visualização do Drupal não podem ser rastreados.

  • Você precisa de acesso de administrador para rastrear dados do dos Blocos do Drupal.

  • Não há API JSON disponível para criar o tipo de conteúdo definido pelo usuário usando verbos HTTP.

  • O corpo do documento e os comentários para Artigos, Páginas básicas, Blocos básicos, tipo de conteúdo definido pelo usuário e tipo de bloco definido pelo usuário são exibidos no formato HTML. Se o conteúdo HTML não estiver bem formado, as tags relacionadas ao HTML aparecerão no corpo do documento e nos comentários e ficarão visíveis nos resultados da pesquisa do Amazon Kendra .

  • Os tipos de conteúdo e os tipos de bloco sem descrição ou corpo não serão Amazon Kendra incorporados. Somente comentários e anexos desses tipos de conteúdo ou bloco serão inseridos em seu índice. Amazon Kendra