# Type Id

* string 
* integer
* float
* bool
* date
* id
* array / object

Le type id est un type qui permet de générer un identifiant unique incluant des paramètres de personnalisation. Il est utile nottament pour pour l'utilsation de Pattern (fonctionnalité permettant de créer plusieurs lignes avec un même id dans le but de reproduire un comportement d"utilisation....).

Pour générer un champs id sur un dataset cela prend toujours la même forme

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

- fieldName : Idcar
  type : id
  #paramètre optionnel 
  includeLetters: true
  includeNumbers: true
  includeSpecialChars: false
  start_by : "ID_test"
      
  
```

{% hint style="info" %}
**includeLetters** ->*booléen* (true , false) ce paramètre précise si l'id doit contenir des lettres
{% endhint %}

{% hint style="info" %}
**includeNumbers** -> *bolléen* (true, false) ce paramètre précise si l'id doit contenir des chiffres
{% endhint %}

{% hint style="info" %}
**includeSpecialChars** -> *bolléen* (true, false) ce paramètre précise si l'id doit contenir des caractères spéciaux
{% endhint %}

## Utilisation du Pattern

Pattern est un des 5 modules permettant de créer du réalisme au sein du dataset voir la page réalisme.

Pour plus dinfo allez sur la page pattern.

ur générer un champs id sur un dataset cela prend toujours la même forme

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

- fieldName : Idcar
  type : id
  # paramètre optionnel 
  includeLetters: true
  includeNumbers: true
  includeSpecialChars: false
  start_by : "ID_test"
  
  # pattern
  pattern : type # à supprimer
  pattern_max_cycle : 15
  pattern_part_of_dataset : 0.7

```

Pour permettre de générer un dataset ou un id peux être présent sur plusieurs lignes exemple (transaction bancaire), on utilise pattern.

{% hint style="info" %}
**pattern** -*>(booléen)* à terme il sera soit supprimé car ne servant rien soit un booléen sera mis à la place. Ce paramètre prend en valeur type mais ne sert à rien
{% endhint %}

{% hint style="info" %}
**pattern\_max\_cycle** *->(integer)* donne le nombre maximum de répétition d'un id ex 3 alors l'id ne sera présent que 3 fois maximum dans le dataset
{% endhint %}

{% hint style="info" %}
**pattern\_part\_of\_dataset** *->(float min:0 , max:1)  donne la aprt du dataset ayant des id pouvant être dupliqué. Si vous souhaitez que seulement 10% du datset contienne des id dupliqué alors* pattern\_part\_of\_dataset 0.1
{% endhint %}

 


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://dataset-generation-doc.gitbook.io/dataset-generation-doc/yaml/type-id.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.