Comment utiliser IronOCR avec GitHub Copilot

Curtis Chau
Curtis Chau
Mis à jour : 9 octobre 2026

.NET équipes avec des solutions Visual Studio établies pour la capture de documents, la comptabilité fournisseurs, le traitement des réclamations ou la gestion des dossiers n'ont pas besoin de changer d'éditeur pour évaluer GitHub Copilot, car il prend en charge leurs flux de travail existants.

Copilot fonctionne dans Visual Studio, VS Code, JetBrains IDEs, et sur GitHub.com. IronOCR traite la reconnaissance localement dans .NET.

Pour des détails sur les modèles d'IronOCR pour les photographies et l'écriture manuscrite, consultez le guide de lecture des photos et le guide de l'écriture manuscrite.

Démarrage rapide
NuGetInstaller avec NuGet

PM > Install-Package IronOcr

Installez IronOCR en exécutant la commande ci-dessus dans la console du gestionnaire de packages NuGet, ou recherchez le package dans le gestionnaire de packages NuGet.

Dans votre IDE actuel, indiquez ce que la méthode doit retourner et toute valeur par défaut que le modèle devrait rappeler autrement.

Add a ReadDeliveryNote method to Imports/DeliveryNotes.cs that uses IronOCR (the
IronOcr NuGet package, namespace IronOcr) to read a scanned delivery note and
return both its text and the barcode values found in the same pass. Barcode
reading is off by default, so switch it on before the read. Take the license key
from the IRONOCR_LICENSE_KEY environment variable, never inline. Then build and
fix any errors.
Text

Définissez IRONOCR_LICENSE_KEY dans l'environnement de départ de l'éditeur, et voyez le guide de la clé de licence pour d'autres lieux pour conserver la clé. Sans cela, la première lecture s'arrête à la vérification de la licence, et Copilot ne peut pas exécuter le code OCR qu'il écrit.



Où Copilot s'inscrit-il dans un projet déjà en cours sous Visual Studio ?

Utilisez le chat en ligne pour une modification d'un fichier IronOCR. Passez au mode agent lorsque la modification s'étend sur plusieurs fichiers, car il peut construire le projet et exécuter le code OCR lui-même. L'agent cloud sur GitHub prend un problème assigné et renvoie une demande de tirage.

Comment définir des conventions IronOCR pour Copilot ?

Validez les conventions IronOCR en tant que .github/copilot-instructions.md, que Copilot Chat, le mode agent et l'agent cloud lisent. Les complétions en ligne l'ignorent.

# Copilot instructions

## OCR

- Use IronOCR for all OCR work. The NuGet package is IronOcr on Windows and
  IronOcr.Linux on Linux and Docker. The namespace is IronOcr. Do not add
  another OCR engine or a cloud OCR service.
- Documentation: https://ironsoftware.com/ocr/csharp/llms.txt
  Skill file: https://ironsoftware.com/ocr/csharp/skill.md
- Target the IronOcr version pinned in Directory.Packages.props. Do not upgrade
  it as part of an unrelated change.
- Never inline a license key. Read it from configuration or the
  IRONOCR_LICENSE_KEY environment variable.
- Always dispose OcrInput with a using block.
- Barcode reading is off by default. Set Configuration.ReadBarCodes only where needed.
- Apply only the image filters that fix a visible defect.
- Do not invent IronOCR API names. If a member is uncertain, say so and cite
  the documentation rather than guessing.

## Testing

- Every OCR change must be run against pages with known values.
- Assert on extracted fields. Never assert on the full text of a page.

## Pull requests

- Say which IronOCR APIs the change introduces, and link the page for each.
- If the OCR tests fail, check the runner environment before changing code
  that the issue did not ask you to touch.
Markdown

Comment donner à un dossier ses propres règles linguistiques OCR ?

Les paramètres d'IronOCR varient souvent selon la source, comme les factures de fournisseurs allemands et les scans d'entrepôt en anglais. Mettez les règles allemandes dans .github/instructions/ocr-german.instructions.md. Copilot applique ce fichier conjointement avec celui du dépôt chaque fois que le fichier sur lequel il travaille correspond au modèle de chemin en haut du fichier allemand.

---
applyTo: "Imports/De/**"
---

- Invoices in this folder are German. Set Language = OcrLanguage.German and add
  English with AddSecondaryLanguage(OcrLanguage.English) for supplier names.
- German comes from the IronOcr.Languages.German NuGet package. Language packs
  keep their own version numbers, so never align this one with IronOcr.
- Amounts use German formatting, such as 1.234,56. Parse them with the de-DE culture.
Markdown

Un échantillon en allemand lu avec le pack allemand le plus récent, 2020.11.2, et l'anglais comme langue secondaire a retourné "Gesamtbetrag: 3.271,07 EUR" avec une confiance de 96,6 sur cette ligne.

Qu'est-ce qui rend un problème sur lequel l'agent cloud peut agir ?

Un problème qui ne signale que des totaux de factures incorrects laisse l'agent cloud trouver le fichier en faute, les scans affectés et les totaux corrects.

Title: Totals misread on rotated scans from the warehouse scanner

**Files:** Imports/InvoiceReader.cs, Imports/ImportJob.cs
**IronOcr version:** as pinned in Directory.Packages.props
**Framework:** .NET 8

**Expected:** Every invoice in TestData/warehouse/ returns the total recorded in
TestData/warehouse/expected.csv, with line confidence of at least 80.

**Actual:** About a third of warehouse scans return totals with one wrong digit.
The pages are rotated a few degrees and have speckle. Invoices from the email
inbox read correctly. No exception is thrown.

**Constraints:** Keep the Total due parsing as it is. Do not change the public
signature of InvoiceReader.ReadTotal. No new packages.

**Acceptance:** Existing tests pass, plus a new test that reads every scan in
TestData/warehouse/ and matches expected.csv.
Markdown

La note indiquant que les factures envoyées par email se lisent correctement dirige l'enquête vers la qualité du scan plutôt que le parsing.

Pourquoi les tests de l'agent cloud échouent-ils sur un projet IronOCR ?

Par défaut, l'agent cloud construit et teste sur un runner Ubuntu Linux éphémère. Le package IronOcr ne livre que des runtimes natifs Windows, donc le runner a besoin de IronOcr.Linux. Un workflow de configuration à .github/workflows/copilot-setup-steps.yml, avec son seul travail nommé copilot-setup-steps, comble cet écart une fois intégré à la branche par défaut.

Write .github/workflows/copilot-setup-steps.yml for this repository.

The job must be named copilot-setup-steps exactly, or it is ignored. Trigger it
manually, and on push and pull request limited to that one file path.

Run it on ubuntu-latest with read access to repository contents. Check out the
repository, set up the .NET SDK for the version this project targets, install
the native dependencies IronOCR needs on Ubuntu, then restore packages.

For those dependencies read
https://ironsoftware.com/ocr/csharp/get-started/linux/ and use what it lists for
Ubuntu rather than a list from memory. Note in a comment that the list can
change between releases.

The runner is Linux, so OCR there needs the IronOcr.Linux package this
repository's instructions name. Show me the finished YAML, then any project
change the runner still needs to restore IronOcr.Linux.
Text
  • La clé de licence : L'agent cloud ne peut pas lire les secrets Actions, Codespaces ou Dependabot, donc la clé a besoin d'un secret Agents. Ajoutez la clé sous Paramètres, puis Secrets et variables, puis Agents, avec le même nom que lit l'éditeur, et l'agent la reçoit comme une variable d'environnement.
  • Une étape de configuration échouée : Elle ne stoppe pas l'agent cloud. L'agent passe les étapes restantes et commence quand même le travail, donc exécutez le workflow une fois à partir de l'onglet Actions et confirmez qu'il passe.

Que faut-il vérifier avant de fusionner ?

Examinez une demande de tirage Copilot comme vous le feriez pour celle d'un collègue.

/tests Add xUnit tests for this change: every scan in TestData/warehouse/ returns
the invoice number and total in its expected.csv, a page without a total returns
null rather than a guess, and reads below 80 confidence are flagged. Assert on
extracted fields, not on the full page text.
Text

Une nouvelle version d'IronOCR peut changer l'espacement et les sauts de ligne sans changer les valeurs. Le guide des assistants de codage IA transforme cette révision en test répétable.

Comment diagnostiquer un résultat OCR incorrect ?

Un résultat incorrect a généralement l'une des trois causes. La page a besoin d'un filtre d'image ou d'un DPI plus élevé, le pack linguistique du document n'a jamais été ajouté, ou la lecture cible la mauvaise région. Une collection de codes-barres vide peut également signifier que Configuration.ReadBarCodes n'a jamais été défini.

Delivery notes in TestData/notes/ return their text, but about a third
come back with an empty barcode collection, while the same notes decode fine on
the handheld scanner.

Explain the cause before changing anything, then fix it in ReadDeliveryNote only.
Do not change the text extraction. Report how many notes return a barcode before
and after. Measure the current count first and base the explanation on what you
measured, not on a guess.
Text

Dans une exécution sans l'instruction de mesure d'abord, Copilot a d'abord blâmé la résolution, puis a associé les codes-barres manquants à des codes QR imprimés en gris fané et les a récupérés en recadrant une région fixe et en sélectionnant une nuance de gris. Dans un second ensemble avec des codes fanés imprimés plus bas sur la page, cette correction n'en a lu aucun. Avec l'instruction, Copilot a d'abord mesuré, exclu le contraste, la binarisation, le suréchantillonnage et le recadrage, et ajouté une seconde lecture après l'application d'un filtre de netteté. Testez toujours les corrections sur des pages que Copilot n'a pas encore vues.

Si la reconnaissance fonctionne localement mais échoue sur un runner ou dans un conteneur, donnez à Copilot le message d'exception complet plutôt qu'un résumé.

Qu'est-ce que les messages ont produit lors d'une réelle exécution ?

Chaque invite dans ce guide qui s'exécute dans l'éditeur a été envoyée en séquence, sur deux chats, contre une application de réception d'échantillons, un projet console .NET 9 avec une gestion centralisée des paquets, un lecteur de factures et des scans avec des valeurs connues. Chaque résultat ci-dessous a été mesuré à nouveau en dehors du chat.

  • Les notes de livraison avec un code-barres sont passées de 6 sur 9 avant la correction à 9 sur 9 après, et la même correction a lu 8 sur 12 codes fanés dans le second ensemble.
  • La suite /tests a réussi 14 sur 14. Elle a également changé la sortie console d'ImportJob sans être demandée, et elle a testé le seuil de confiance sur des enregistrements construits, pas des scans.
  • Après les quatre invites, la build Release était propre, sans modifications manuelles.
  • Deux parties ont fonctionné différemment de la page. La personne a collé la clé de licence dans l'invite de tests, et Copilot l'a gardée hors de chaque fichier. Le workflow d'installation, l'agent cloud, son problème et le secret Agents nécessitent GitHub Actions ou un dépôt GitHub, donc aucun d'eux n'a été exécuté.

La version de l'assistant, le modèle, les temps et la machine de test derrière ces chiffres sont listés avec chaque autre guide dans le registre d’exécution.


Dépannage


Des questions ?

Si vous avez des questions, contactez support@ironsoftware.com

Curtis Chau détient un baccalauréat en informatique (Université de Carleton) et se spécialise dans le développement front-end avec expertise en Node.js, TypeScript, JavaScript et React. Passionné par la création d'interfaces utilisateur intuitives et esthétiquement plaisantes, Curtis aime travailler avec des frameworks modernes et créer des manuels bien structurés et visuellement attrayants.

Lire la suite

Prêt à commencer ?

Téléchargements NuGet 6,394,824Version :2026.11tout juste publié