Criação de campos de documentos personalizados

Você pode criar atributos ou campos personalizados para seus documentos no seu índice Amazon Kendra. Por exemplo, você pode criar um campo ou atributo personalizado chamado “Departamento” com os valores de “RH”, “Vendas” e “Fabricação”. Se você mapear esses campos ou atributos personalizados para o seu índice Amazon Kendra, você pode usá-los para filtrar os resultados da pesquisa e incluir documentos pelo atributo de departamento “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 para adicionar um campo personalizado ou use a UpdateIndexAPI para criar o campo de índice. Você não pode alterar o tipo de 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 em Amazon Kendra. Para obter mais informações, consulte Mapear 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 campos Amazon Kendra reservados ou comuns. Para obter mais informações, consulte Campos ou atributos personalizados.

Atualização de 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 para adicionar atributos ou campos personalizados usando BatchPutDocumente para uma fonte de dados do Amazon S3.

Tópicos

• Adicionar atributos ou campos personalizados com a BatchPutDocument API
• Adicionar atributos ou campos personalizados a uma fonte de dados do Amazon S3

Adicionar atributos ou campos personalizados com a BatchPutDocument API

Ao usar a BatchPutDocumentAPI para adicionar um documento ao seu índice, você especifica campos ou atributos personalizados como parte doAttributes. 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 orientam você a adicionar atributos personalizados a uma fonte de dados do Amazon S3.

Tópicos

• Etapa 1: criar um índice do Amazon Kendra
• Etapa 2: atualizar o índice para adicionar campos de documentos personalizados
• Etapa 3: Crie uma fonte de dados do Amazon S3 e mapeie os campos da fonte de dados para atributos personalizados

Etapa 1: criar um índice do Amazon Kendra

Siga as etapas Criar um índice para criar seu índice Amazon Kendra.

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

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

Console

Para criar campos de índice

1. Verifique se você criou um índice.

2. Em seguida, no menu de navegação à esquerda, 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, String list ou Data.

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

     Em seguida, 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: Crie uma fonte de dados do Amazon S3 e mapeie os 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 fieldMappings atributo abaixo configuration ao usar a CreateDataSourceAPI.

Para obter uma visão geral de como os campos da fonte de dados são mapeados, consulteMapeando campos de fontes de dados.