Configuration YAML

Cette page documente la syntaxe et les options de configuration YAML pour l'API ParseMyFile.

Structure de base

Un fichier de configuration YAML se compose de la manière ci-dessous :

schemas:
  data: 
    type: object
    properties:
      nom_du_champ:
        type: string
        description: description du champ

Explication

Le fichier commence toujours par la section schemas suivi de data qui est obligatoirement un type object. Ceci défini la structure essentiel du document.

Ensuite, dans properties, on défini les champs que l'on souhaite extraire du fichier.

Chaque propriété doit obligatoirement avoir un typeet une desciption

Structure de base

schemas:
  data:
    type: object
    properties:
      nom_du_champ:
        type: string
        description: explication de comment récupérer cette information

Types de données supportés

Types de base

Type	Description	Exemple
string	Texte libre	"Jean Dupont"
double	Nombre décimal	123.45
integer	Nombre entier	42
date	Date (par defaut YYYY-MM-DD)	2025-09-10
object	Objet structuré	{ "nom": "Jean", "age": 30 }
array<object>	Tableau d'objets	[{ "produit": "Livre", "prix": 15.99 }]

Exemples de champs

Champ texte simple

schemas:
  data:
    type: object
    properties:
      nom:
        type: string
        description: nom du client

Champ numérique

schemas:
  data:
    type: object
    properties:
      montant:
        type: double
        description: montant total en euros
      quantite:
        type: integer
        description: quantité

Champ date

schemas:
  data:
    type: object
    properties:
      date_facture:
        type: string
        description: date d'émission de la facture (format YYYY-MM-DD)

Tableau d'objets

schemas:
  data:
    type: object
    properties:
      produits:
        type: array<object>
        description: liste des produits
        items:
          type: object
          properties:
            nom:
              type: string
              description: nom du produit
            prix:
              type: double
              description: prix du produit

Exemples complets

Configuration pour une facture

schemas:
  data:
    type: object
    properties:
      numero_facture:
        type: string
        description: numéro de facture
      date_facture:
        type: string
        description: date d'émission (format YYYY-MM-DD)
      client_nom:
        type: string
        description: nom du client
      client_adresse:
        type: string
        description: adresse du client
      montant_total:
        type: double
        description: montant total TTC en euros
      tva:
        type: double
        description: taux de TVA en pourcentage

Configuration pour un formulaire

schemas:
  data:
    type: object
    properties:
      titre_formulaire:
        type: string
        description: titre du formulaire
      nom:
        type: string
        description: nom de famille
      prenom:
        type: string
        description: prénom
      email:
        type: string
        description: adresse email
      telephone:
        type: string
        description: numéro de téléphone
      rue:
        type: string
        description: numéro et nom de rue
      code_postal:
        type: string
        description: code postal
      ville:
        type: string
        description: ville
      pays:
        type: string
        description: pays

Configuration pour un contrat

schemas:
  data:
    type: object
    properties:
      titre_contrat:
        type: string
        description: titre du contrat
      parties_contractantes:
        type: string
        description: noms des parties contractantes
      date_debut:
        type: string
        description: date de début du contrat (format YYYY-MM-DD)
      date_fin:
        type: string
        description: date de fin du contrat (format YYYY-MM-DD)
      montant:
        type: double
        description: montant du contrat en euros

Bonnes pratiques

1. Nommage des champs

• Utilisez des noms descriptifs et cohérents
• Évitez les caractères spéciaux et espaces
• Utilisez le snake_case pour les noms de champs

2. Types de données

• Utilisez string pour les textes libres
• Utilisez double pour les montants et nombres décimaux
• Utilisez integer pour les quantités et nombres entiers
• Utilisez datepour les dates
• Utilisez array<object> pour les listes structurées

3. Descriptions

• Ajoutez des descriptions claires pour chaque champ
• Indiquez les formats attendus (ex: format YYYY-MM-DD pour les dates)
• Précisez les unités quand nécessaire (ex: "en euros")

4. Structure

• Organisez les champs de manière logique
• Utilisez des objets imbriqués pour les données liées
• Groupez les champs similaires

Validation de la configuration

Avant d'utiliser votre configuration YAML, vérifiez :

1. Syntaxe YAML : Validez la syntaxe avec un parser YAML
2. Structure : Vérifiez que le fichier commence par schemas: puis data:
3. Types valides : Assurez-vous que les types utilisés sont supportés
4. Descriptions : Vérifiez que chaque champ a une description claire
5. Cohérence : Assurez-vous que la structure correspond aux données attendues