Add DOCUMENT_INTEGRITY_THRESHOLD_PERCENTAGE env in odin documentation #40
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds documentation for a new environment variable DOCUMENT_INTEGRITY_THRESHOLD_PERCENTAGE to the Odin service configuration section. The variable controls the integrity threshold for processed documents, with a default value of 80%.
Changes:
- Added a new section "6. Paramètres Avancés" in the Odin documentation
- Documented the
DOCUMENT_INTEGRITY_THRESHOLD_PERCENTAGEenvironment variable with description and default value
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | Variable | Description | Par défaut | | ||
| | :-------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------- | |
There was a problem hiding this comment.
The column header "Par défaut" is inconsistent with the rest of the document. Most sections with default values use "Valeur par défaut" as the column header (see sections 1, 2, 3, 6, and 10 in the Devana API section). Please change "Par défaut" to "Valeur par défaut" to maintain consistency throughout the documentation.
| | Variable | Description | Par défaut | | |
| | :-------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------- | | |
| | Variable | Description | Valeur par défaut | | |
| | :-------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------- | |
|
|
||
| | Variable | Description | Par défaut | | ||
| | :-------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------- | | ||
| | `DOCUMENT_INTEGRITY_THRESHOLD_PERCENTAGE` | Seuil de pourcentage pour vérifier l'intégrité des documents traités. Si le pourcentage de réussite est inférieur à cette valeur, le document est considéré comme corrompu ou incomplet. | `80` | |
There was a problem hiding this comment.
The default value 80 has inconsistent spacing. There are extra spaces between the value and the closing pipe character. This should be aligned consistently with other table entries in the document, using fewer spaces for proper alignment.
| | `DOCUMENT_INTEGRITY_THRESHOLD_PERCENTAGE` | Seuil de pourcentage pour vérifier l'intégrité des documents traités. Si le pourcentage de réussite est inférieur à cette valeur, le document est considéré comme corrompu ou incomplet. | `80` | | |
| | `DOCUMENT_INTEGRITY_THRESHOLD_PERCENTAGE` | Seuil de pourcentage pour vérifier l'intégrité des documents traités. Si le pourcentage de réussite est inférieur à cette valeur, le document est considéré comme corrompu ou incomplet. | `80` | |
| | :-------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------- | | ||
| | `NODE_EXTRA_CA_CERTS` | (Optionnel) Chemin d'accès à un fichier de certificats d'autorité (CA) supplémentaires. Utile pour les environnements d'entreprise utilisant des certificats TLS/SSL auto-signés. | `/certs/ca.crt` | | ||
|
|
||
|
|
There was a problem hiding this comment.
There is an extra blank line here. The document consistently uses a single blank line before new section headers. Line 297 should be removed to maintain consistency with the formatting pattern used throughout the document.
|
|
||
| | Variable | Description | Par défaut | | ||
| | :-------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------- | | ||
| | `DOCUMENT_INTEGRITY_THRESHOLD_PERCENTAGE` | Seuil de pourcentage pour vérifier l'intégrité des documents traités. Si le pourcentage de réussite est inférieur à cette valeur, le document est considéré comme corrompu ou incomplet. | `80` | |
There was a problem hiding this comment.
The description uses the term "pourcentage de réussite" (success percentage) without clearly explaining what metric is being measured. Consider clarifying what exactly constitutes success in this context. For example, is it the percentage of successfully extracted pages, the percentage of recognized text, or another metric? This would help users better understand how to configure this threshold appropriately.
| | `DOCUMENT_INTEGRITY_THRESHOLD_PERCENTAGE` | Seuil de pourcentage pour vérifier l'intégrité des documents traités. Si le pourcentage de réussite est inférieur à cette valeur, le document est considéré comme corrompu ou incomplet. | `80` | | |
| | `DOCUMENT_INTEGRITY_THRESHOLD_PERCENTAGE` | Seuil (en %) du taux de réussite des contrôles d'intégrité d'un document (par exemple : pages extraites et texte reconnu avec succès par rapport au nombre total de pages attendues). Si ce taux est inférieur à cette valeur, le document est considéré comme corrompu ou incomplet. | `80` | |
No description provided.