

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

# Création de champs de document personnalisés
<a name="custom-attributes"></a>

**Note**  
La prise en charge des fonctionnalités varie en fonction du type d'index et de l'API de recherche utilisés. Pour savoir si cette fonctionnalité est prise en charge pour le type d'index et l'API de recherche que vous utilisez, consultez la section [Recherche d'index.](https://docs.aws.amazon.com/kendra/latest/dg/hiw-index.html#index-searching)

Vous pouvez créer des attributs ou des champs personnalisés pour vos documents dans votre index Amazon Kendra. Par exemple, vous pouvez créer un champ ou un attribut personnalisé appelé « Département » avec les valeurs « RH », « Ventes » et « Fabrication ». Si vous associez ces champs ou attributs personnalisés à votre index Amazon Kendra, vous pouvez les utiliser pour filtrer les résultats de recherche afin d'inclure des documents en fonction de l'attribut « département RH », par exemple.

Avant de pouvoir utiliser un champ ou un attribut personnalisé, vous devez d'abord créer le champ dans l'index. Utilisez la console pour modifier les mappages de champs de source de données afin d'ajouter un champ personnalisé ou utilisez l'[UpdateIndex](https://docs.aws.amazon.com/kendra/latest/APIReference/API_UpdateIndex.html)API pour créer le champ d'index. Vous ne pouvez pas modifier le type de données du champ une fois que vous l'avez créé.

Pour la plupart des sources de données, vous mappez les champs de la source de données externe aux champs correspondants de Amazon Kendra. Pour plus d’informations, consultez [Mappage des champs de source de données](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). Pour les sources de données S3, vous pouvez créer des champs ou des attributs personnalisés à l'aide d'un fichier de métadonnées JSON.

Vous pouvez créer jusqu'à 500 champs ou attributs personnalisés.

Vous pouvez également utiliser des champs Amazon Kendra réservés ou communs. Pour plus d'informations, consultez la section [Attributs ou champs du document](https://docs.aws.amazon.com/kendra/latest/dg/hiw-document-attributes.html).

**Topics**
+ [Mise à jour des champs de document personnalisés](#update-attributes)

## Mise à jour des champs de document personnalisés
<a name="update-attributes"></a>

Avec l'`UpdateIndex`API, vous pouvez ajouter des champs ou des attributs personnalisés à l'aide du `DocumentMetadataConfigurationUpdates` paramètre.

L’exemple JSON suivant utilise `DocumentMetadataConfigurationUpdates` pour ajouter un champ appelé « Département » à l’index.

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

Les sections suivantes incluent des exemples d'ajout d'attributs ou de champs personnalisés à l'aide de [BatchPutDocument](https://docs.aws.amazon.com/kendra/latest/APIReference/API_BatchPutDocument.html)et pour une source de données Amazon S3.

**Topics**
+ [Ajouter des attributs ou des champs personnalisés avec l' BatchPutDocument API](#custom-attributes-batch)
+ [Ajouter des attributs ou des champs personnalisés à une source Amazon S3 de données](#custom-attributes-s3)

### Ajouter des attributs ou des champs personnalisés avec l' BatchPutDocument API
<a name="custom-attributes-batch"></a>

Lorsque vous utilisez l'[BatchPutDocument](https://docs.aws.amazon.com/kendra/latest/APIReference/API_BatchPutDocument.html)API pour ajouter un document à votre index, vous spécifiez des champs ou des attributs personnalisés dans le cadre de`Attributes`. Vous pouvez ajouter plusieurs champs ou attributs lorsque vous appelez l'API. Vous pouvez créer jusqu'à 500 champs ou attributs personnalisés. L’exemple suivant présente un champ ou un attribut personnalisé qui ajoute « Département » à un document.

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

### Ajouter des attributs ou des champs personnalisés à une source Amazon S3 de données
<a name="custom-attributes-s3"></a>

Lorsque vous utilisez un compartiment S3 comme source de données pour votre index, vous ajoutez des métadonnées aux documents avec des fichiers de métadonnées associés. Placez les fichiers JSON de métadonnées dans une structure de répertoire parallèle à celle de vos documents. Pour plus d’informations, consultez [Métadonnées du document S3](https://docs.aws.amazon.com/kendra/latest/dg/s3-metadata.html).

Spécifiez des champs ou des attributs personnalisés dans la structure JSON `Attributes`. Vous pouvez créer jusqu'à 500 champs ou attributs personnalisés. Par exemple, l'exemple suivant permet `Attributes` de définir trois champs ou attributs personnalisés et un champ réservé.

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

Les étapes suivantes vous expliquent comment ajouter des attributs personnalisés à une source de données Amazon S3.

**Topics**
+ [Étape 1 : Création d'un index Amazon Kendra](#custom-attributes-s3-1)
+ [Étape 2 : Mettre à jour l'index pour ajouter des champs de document personnalisés](#custom-attributes-s3-2)
+ [Étape 3 : créer une source de données Amazon S3 et mapper les champs de la source de données à des attributs personnalisés](#custom-attributes-s3-3)

#### Étape 1 : Création d'un index Amazon Kendra
<a name="custom-attributes-s3-1"></a>

Suivez les étapes ci-dessous [Création d’un index](create-index.md) pour créer votre index Amazon Kendra.

#### Étape 2 : Mettre à jour l'index pour ajouter des champs de document personnalisés
<a name="custom-attributes-s3-2"></a>

Après avoir créé un index, vous y ajoutez des champs. La procédure suivante montre comment ajouter des champs à un index à l'aide de la console et de la CLI.

------
#### [ Console ]

**Pour créer des champs d'index**

1. Assurez-vous d'avoir [créé un index](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html).

1. Ensuite, dans le menu de navigation de gauche, dans **Gestion des données**, choisissez **Définition des facettes**.

1. Dans **le guide des paramètres** des **champs d'index**, dans Champs d'index, choisissez **Ajouter un champ** pour ajouter des champs personnalisés.

1. Dans la boîte de dialogue **Ajouter un champ d'index**, procédez comme suit :
   + **Nom du champ** — Ajoutez un nom de champ.
   + **Type de données** : sélectionnez le type de données, qu'il s'agisse d'**une chaîne****, d'une liste** de chaînes ou d'une **date**.
   + **Types d'utilisation** **: sélectionnez les types d'utilisation, qu'ils soient **facetables**, **consultables, affichables** **ou triables**.**

     Ensuite, sélectionnez **Ajouter**.

   Répétez la dernière étape pour tous les autres champs que vous souhaitez mapper.

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

------

#### Étape 3 : créer une source de données Amazon S3 et mapper les champs de la source de données à des attributs personnalisés
<a name="custom-attributes-s3-3"></a>

Pour créer une source de données Amazon S3 et y associer des champs, suivez les instructions figurant dans[Amazon S3](data-source-s3.md).

Si vous utilisez l'API, utilisez l'`fieldMappings`attribut ci-dessous `configuration` lorsque vous utilisez l'[CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html)API.

Pour une vue d'ensemble de la façon dont les champs de source de données sont mappés, voir[Mappage de champs de source de données](field-mapping.md).