Criação de campos de documentos personalizados

É possível criar campos ou atributos para documentos no índice do Amazon Kendra. Por exemplo, você pode criar um campo ou atributo personalizado chamado “Departamento” com os valores de “RH”, “Vendas” e “Fabricação”. Se mapear esses atributos ou campos personalizados para o índice do Amazon Kendra, você poderá usá-los ao filtrar os resultados da pesquisa para incluir documentos pelo atributo de departamento de “RH”, por exemplo.

Antes de usar um campo ou atributo personalizado, você deve primeiramente criar o campo no índice. Use o console para editar os mapeamentos de campo da fonte de dados e adicionar um campo personalizado ou use a API UpdateIndex. Você não pode alterar o tipo de dados do campo depois de criar o campo.

Para a maioria das fontes de dados, você mapeia campos na fonte de dados externa para os campos correspondentes emAmazon Kendra. Para obter mais informações, consulte Mapeamento de campos de fonte de dados. Para origens dos dados do S3, você pode criar campos ou atributos personalizados usando um arquivo de metadados JSON.

Crie até 500 campos ou atributos personalizados.

Você também pode usar os campos reservados ou comuns do Amazon Kendra. Para obter mais informações, consulte Campos ou atributos personalizados.

Atualizar campos de documentos personalizados

Com a API UpdateIndex, você adiciona campos ou atributos personalizados usando o parâmetro DocumentMetadataConfigurationUpdates.

O exemplo de JSON a seguir usa DocumentMetadataConfigurationUpdates para adicionar um campo chamado “Departamento” ao índice.

"DocumentmetadataConfigurationUpdates": [
   {
       "Name": "Department",
       "Type": "STRING_VALUE"
   }
]

As seções a seguir incluem exemplos de como adicionar campos ou atributos personalizados usando BatchPutDocument e de uma fonte de dados do Amazon S3.

Adicionar atributos ou campos personalizados com a API BatchputDocument

Ao usar a API BatchputDocument para adicionar um documento ao seu índice, você especifica campos ou atributos personalizados como parte do Attributes. Você pode adicionar vários campos ou atributos ao chamar a API. Crie até 500 campos ou atributos personalizados. O exemplo a seguir é um campo ou atributo personalizado que adiciona “Departamento” a um documento.

"Attributes": 
    {
        "Department": "HR",
        "_category": "Vacation policy"
    }

Adicionar atributos ou campos personalizados a uma fonte de dados do Amazon S3

Ao usar um bucket do S3 como fonte de dados para o índice, você adiciona metadados aos documentos com arquivos de metadados complementares. Você coloca os arquivos JSON de metadados em uma estrutura de diretórios paralela aos documentos. Para mais informações, consulte metadados de documento do S3.

Você especifica campos ou atributos personalizados na estrutura Attributes JSON. Crie até 500 campos ou atributos personalizados. Por exemplo, o exemplo a seguir usa Attributes para definir três campos ou atributos personalizados e um campo reservado.

"Attributes": {
        "brand": "Amazon Basics",
        "price": 1595,
        "_category": "sports",
        "subcategories": ["outdoors", "electronics"]
    }

As etapas a seguir explicam como adicionar atributos personalizados a uma fonte de dados do Amazon S3.

Etapa 1: criar um índice do Amazon Kendra

Siga as etapas de Como criar um índice para criar o índice do Amazon Kendra.

Etapa 2: atualizar o índice para adicionar campos de documentos personalizados

Depois de criar um índice, adicione campos a ele. O procedimento a seguir mostra como adicionar campos a um índice do usando o console e a CLI.

Console

Como criar campos de índice

1. Certifique-se de ter criado um índice.

2. Então, no menu de navegação esquerdo, em Gerenciamento de dados, escolha Definição de faceta.

3. No Guia de configurações do campo Índice, em Campos de índice, escolha Adicionar campo para adicionar campos personalizados.

4. Na caixa de diálogo Adicionar campo de índice, faça o seguinte:

   • Nome do campo: adicione um nome de campo.

   • Tipo de dados: selecione o tipo de dados, seja String, Lista de strings ou Data.

   • Tipos de uso: selecione os tipos de uso, sejam eles facetáveis, pesquisáveis, exibíveis e classificáveis.

     Depois, selecione Adicionar.

   Repita a última etapa para qualquer outro campo que você queira mapear.

CLI

aws kendra update-index  \
--region $region \
--endpoint-url $endpoint \
--application-id $applicationId \
--index-id $indexId  \
--document-metadata-configuration-updates \
"[
    {
        "Name": "string",
        "Type": "STRING_VALUE"|"STRING_LIST_VALUE"|"LONG_VALUE"|"DATE_VALUE",
        "Relevance": {
            "Freshness": true|false,
            "Importance": integer,
            "Duration": "string",
            "RankOrder": "ASCENDING"|"DESCENDING",
            "ValueImportanceMap": {"string": integer
            ...}
    },
    "Search": {
        "Facetable": true|false,
        "Searchable": true|false,
        "Displayable": true|false,
        "Sortable": true|false
        }
    }
...
]"

Etapa 3: criar uma fonte de dados do Amazon S3 e mapear campos da fonte de dados para atributos personalizados

Para criar uma fonte de dados do Amazon S3 e mapear campos para ela, siga as instruções em Amazon S3.

Se você estiver usando a API, use o atributo fieldMappings em configuration ao usar a API CreateDataSource.

Consulte uma visão geral de como os campos da fonte de dados são mapeados em Mapeando campos de fontes de dados.