> For the complete documentation index, see [llms.txt](https://dataset-generation-doc.gitbook.io/dataset-generation-doc/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://dataset-generation-doc.gitbook.io/dataset-generation-doc/yaml/comment-generer-un-champ-sur-un-dataset.md).

# Comment générer un champ sur un dataset

La forme de la génération d'un champ sur un dataset est toujours la même.

```yaml
// Exemple de champs générés

- fieldName : Nom du champ
  type : integer
  rules:
    range :
      min: 12
      max: 22
      
- fieldName : email field
  fakerType : email
  domain : "free.fr" # Ce paramètre est un paramètre de la fonction fakerType
  
```

### FieldName

Le champ « fieldName » est obligatoire et permet de nommer le champ. Il tolère les espaces, les accents et les caractères spéciaux.

### Type et FakerType

type : Pour les types simples (integer, string, boolean, etc.)

fakerType : Pour générer automatiquement des données (e.g. email, company, firstname)

```yaml
fakerType : email
domain : 'test.com'
```

{% hint style="info" %}
Les fakerType peuvent prendre des paramètres conçus par leurs fonctions comme le cas ci dessus. Cela ne concerne que les cas de bases (voir menu ci-dessus ainsi que le lien vers la documentation officielle de [Faker python](https://faker.readthedocs.io/en/stable/providers.html))
{% endhint %}

{% tabs %}
{% tab title="type" %}

| type    |
| ------- |
| integer |
| float   |
| string  |
| array   |
| object  |
| boolean |
| id      |

{% endtab %}

{% tab title="fakerType" %}
TBD
{% endtab %}
{% endtabs %}

{% hint style="warning" %}
Avec le champ "type", uniquement la clé "rules" permet d'ajouter des paramètres de range sur certaines valeurs que nous verrons plus tard dans la documentation.
{% endhint %}

### Rules

Liste des types compatibles avec Rules (voir la doc [Rules et Range](/dataset-generation-doc/interactive-blocks.md))

1. float&#x20;
2. integer
3. boolean
4. string

Le champ rules est un paramètre optionnel, permettant d'ajouter des paramètres aux types de bases présent dans la liste type ci-dessus.
