Creación de campos de documento personalizados

Puede crear atributos o campos personalizados para sus documentos en su índice de Amazon Kendra. Por ejemplo, puede crear un campo o atributo personalizado denominado “Departamento” con los valores de “RR. HH.”, “Ventas” y “Fabricación”. Si asigna estos campos o atributos personalizados al índice de Amazon Kendra, puede utilizarlos para filtrar los resultados de la búsqueda e incluir documentos en el atributo de departamento de “RR. HH.”, por ejemplo.

Para poder utilizar un campo o atributo personalizado, primero debe crear el campo en el índice. Utilice la consola para editar las asignaciones de campos de origen de datos y agregar un campo personalizado o utilice la API UpdateIndex para crear el campo del índice. No puede cambiar el tipo de dato del campo una vez que este se ha creado.

Para la mayoría de orígenes de datos, asignará los campos del origen de datos externo a los campos correspondientes en Amazon Kendra. Para obtener más información, consulte Asignación de campos de origen de datos. Para los orígenes de datos de S3, puede crear atributos o campos personalizados mediante un archivo de metadatos JSON.

Puede crear hasta 500 campos o atributos personalizados.

También puede utilizar los campos reservados o comunes de Amazon Kendra. Para obtener más información, consulte Atributos o campos del documento.

Actualización de campos de documento personalizados

Con la API UpdateIndex, se agregan campos o atributos personalizados mediante el parámetro DocumentMetadataConfigurationUpdates.

En el siguiente ejemplo de JSON se utiliza DocumentMetadataConfigurationUpdates para agregar al índice un campo denominado “Department”.

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

En las siguientes secciones se incluyen ejemplos para añadir campos o atributos personalizados mediante BatchPutDocument y para un origen de datos de Amazon S3.

Adición de atributos o campos personalizados con la API BatchPutDocument

Cuando utilice la API BatchPutDocument para agregar un documento al índice, se especifican campos o atributos personalizados como parte de Attributes. Puede añadir varios campos o atributos al llamar a la API. Puede crear hasta 500 campos o atributos personalizados. El siguiente ejemplo es un campo o atributo personalizado que agrega “Departamento” a un documento.

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

Adición de atributos o campos personalizados a un origen de datos de Amazon S3

Cuando se utilice un bucket de S3 como origen de datos para el índice, se agregan metadatos a los documentos con archivos de metadatos complementarios. Los archivos JSON de metadatos se colocan en una estructura de directorios paralela a los documentos. Para obtener más información, consulte Metadatos de documentos de S3.

Los campos o atributos personalizados se especifican en la estructura JSON de Attributes. Puede crear hasta 500 campos o atributos personalizados. Por ejemplo, en el siguiente ejemplo se utiliza Attributes para definir tres campos o atributos personalizados y un campo reservado.

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

En los pasos siguientes, se explica cómo agregar atributos personalizados a un origen de datos de Amazon S3.

Paso 1: creación de un índice de Amazon Kendra

Siga los pasos en Creación de un índice para crear su índice de Amazon Kendra.

Paso 2: actualización del índice para agregar campos de documentos personalizados

Después de crear un índice, tendrá que añadirle campos. En el siguiente procedimiento se muestra cómo agregar campos a un índice de mediante la consola y la CLI.

Console

Cómo crear campos de índice

1. Asegúrese de haber creado un índice.

2. A continuación, en el panel de navegación izquierdo, en Administración de datos, elija Definición de faceta.

3. En la Guía de configuración de campos del índice en Campos de índice, seleccione Agregar campo para agregar campos personalizados.

4. En el cuadro de diálogo Agregar campo de índice, haga lo siguiente:

   • Nombre de campo: agregue un nombre de campo.

   • Tipo de datos: seleccione el tipo de datos, ya sea Cadena, Lista de cadenas o Fecha.

   • Tipos de uso: seleccione los tipos de uso, ya sea Por facetas, Por búsqueda, Por visualización y Por orden.

     A continuación, seleccione Agregar.

   Repita el último paso para cualquier otro campo que desee asignar.

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
        }
    }
...
]"

Paso 3: creación de un origen de datos de Amazon S3 y asignación de campos de origen de datos a atributos personalizados

Para crear un origen de datos de Amazon S3 y asignarle campos, siga las instrucciones que se indican en Amazon S3.

Si usa la API, utilice el atributo fieldMappings en configuration cuando utilice la API CreateDataSource.

Para obtener una descripción general de cómo se asignan campos de orígenes de datos, consulte Asignación de campos de origen de datos.