Jak korzystać z IronOCR z GitHub Copilot

Curtis Chau
Curtis Chau
Zaktualizowano: 9 października 2026

.NET zespoły z ustalonymi rozwiązaniami Visual Studio dla przechwytywania dokumentów, rozrachunków z dostawcami, przetwarzania roszczeń czy zarządzania rejestrami nie muszą zmieniać edytorów, aby ocenić GitHub Copilot, ponieważ wspiera on ich istniejące przepływy pracy.

Copilot działa w Visual Studio, VS Code, IDE JetBrains i na GitHub.com. IronOCR przetwarza rozpoznawanie lokalnie w .NET.

Szczegóły dotyczące modeli IronOCR dla fotografii i pisma ręcznego można znaleźć w przewodniku po czytaniu fotografii i przewodniku po piśmie ręcznym.

Szybki start
NuGetInstalacja z NuGet

PM > Install-Package IronOcr

Zainstaluj IronOCR, wykonując powyższe polecenie w konsoli Menedżera Pakietów NuGet lub wyszukaj pakiet w Menedżerze Pakietów NuGet.

W bieżącym IDE należy określić, co metoda musi zwrócić, i każdą wartość domyślną, którą model musiałby inaczej przypomnieć.

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

Ustaw IRONOCR_LICENSE_KEY w środowisku, z którego startuje edytor, i zapoznaj się z podręcznikiem kluczy licencyjnych dotyczącym innych miejsc przechowywania klucza. Bez tego, pierwszy odczyt zatrzymuje się na sprawdzeniu licencji, a Copilot nie może uruchomić kodu OCR, który napisał.



Gdzie Copilot pasuje do projektu już istniejącego w Visual Studio?

Używać czatu inline dla zmiany jednoplikowej IronOCR. Przejść do trybu agenta, gdy zmiana obejmuje kilka plików, ponieważ może on budować projekt i samodzielnie uruchomić kod OCR. Agent chmurowy na GitHub przejmuje przypisany temat i zwraca pull request.

W jaki sposób ustawić konwencje IronOCR dla Copilot?

Zadeklaruj konwencje IronOCR jako .github/copilot-instructions.md, które są odczytywane przez Copilot Chat, tryb agenta i agenta chmurowego. Uzupełnienia inline je ignorują.

# 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

Jak nadać jednemu katalogowi własne zasady języka OCR?

Ustawienia IronOCR często różnią się w zależności od źródła, takie jak niemieckie faktury od dostawców i angielskie skany magazynowe. Umieść niemieckie zasady w .github/instructions/ocr-german.instructions.md. Copilot stosuje ten plik wraz z plikiem ogólno-repozytoryjnym, gdy tylko plik, nad którym pracuje, odpowiada wzorcowi ścieżki na górze niemieckiego pliku.

---
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

Przykładowe niemieckie odczyty z najnowszym niemieckim pakietem z 2020.11.2 i angielskim jako językiem pomocniczym zwróciły "Gesamtbetrag: 3.271,07 EUR" z 96,6% pewnością na tej linii.

Co sprawia, że temat jest działaniem, które agent chmurowy może realizować?

Problem zgłaszający jedynie błędne sumy faktur pozostawia agenta chmurowego, aby znalazł wadliwy plik, dotknięte skany i poprawne sumy.

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

Notatka o poprawnym odczycie faktur e-mailowych kieruje dochodzenie w stronę jakości skanowania, a nie parsowania.

Dlaczego testy agenta chmurowego nie udają się na projekcie IronOCR?

Domyślnie agent chmurowy buduje i testuje na efemerycznym biegaczu Ubuntu Linux. Pakiet IronOcr dostarcza tylko natywne środowiska Windows, więc biegacz potrzebuje IronOcr.Linux. Przepływ pracy konfiguracji w .github/workflows/copilot-setup-steps.yml z jedną funkcją nazwany copilot-setup-steps zamyka tę lukę, gdy zostanie scalony do domyślnej gałęzi.

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
  • Klucz licencyjny: Agent chmurowy nie może odczytać tajemnic z Actions, Codespaces lub Dependabot, więc klucz potrzebuje tajemnicy Agenci. Dodać klucz w Ustawienia, następnie Sekrety i zmienne, potem Agenci, z tej samą nazwą, którą czyta edytor, a agent otrzymuje go jako zmienną środowiskową.
  • Nieudany krok konfiguracji: Nie przerywa to działania agenta chmurowego. Agent pomija pozostałe kroki i zaczyna pracę mimo to, więc uruchomić przepływ pracy raz z zakładki Actions i potwierdzić, że przechodzi.

Co należy sprawdzić przed scaleniem?

Przejrzeć pull request Copilot, jakby oceniano go jako kolegi.

/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

Nowe wydanie IronOCR może zmienić odstępy i łamanie linii, nie zmieniając wartości. Przewodnik po asystentach kodu AI zmienia tę recenzję w powtarzalny test.

Jak zdiagnozować niepoprawny wynik OCR?

Błędny wynik zwykle ma jedną z trzech przyczyn. Strona wymaga filtru obrazu lub wyższej rozdzielczości DPI, pakiet językowy dokumentu nigdy nie został dodany, albo odczytywany jest niewłaściwy region. Pusta kolekcja kodów kreskowych może również oznaczać, że Configuration.ReadBarCodes nigdy nie został ustawiony.

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

Podczas wykonywania bez instrukcji wstępnego pomiaru, Copilot początkowo obwiniał rozdzielczość, potem śledził brakujące kody kreskowe do kodów QR wydrukowanych w wyblakłej szarości i odzyskał je, kadrując stały obszar i wybierając jeden odcień szarości. W drugim zestawie z wyblakłymi kodami drukowanymi niżej na stronie, to rozwiązanie nie odczytało żadnego z nich. Z instrukcją, Copilot najpierw zmierzył, wykluczył kontrast, binaryzację, skalowanie i kadrowanie oraz dodał drugi odczyt po zastosowaniu filtru wyostrzającego. Zawsze testuj poprawki na stronach, których Copilot wcześniej nie widział.

Jeśli rozpoznawanie działa lokalnie, ale nie uda się na biegaczu lub w kontenerze, przekazać Copilot pełny komunikat wyjątku zamiast podsumowania.

Co wyprodukowały zapytania w rzeczywistym uruchomieniu?

Każda podpowiedź w tym przewodniku, która działała w edytorze, została wysłana w kolejności, w dwóch czatach, na przykładzie aplikacji odbierającej, projekcie konsolowym .NET 9 z centralnym zarządzaniem pakietami, odczytywaczem faktur i skanami o znanych wartościach. Każdy wynik poniżej został ponownie zmierzony poza czatem.

  • Noty dostaw z kodem kreskowym wzrosły z 6 na 9 przed poprawką do 9 na 9 po niej, a to samo rozwiązanie odczytało 8 na 12 wyblakłych kodów w drugim zestawie.
  • Pakiet /tests zaliczył 14 z 14. Zmienił także nieproszone dane wyjściowe ImportJob na konsoli oraz przetestował próg zaufania na skonstruowanych rekordach, nie skanach.
  • Po wszystkich czterech podpowiedziach wydanie Release było czyste, bez ręcznych edycji.
  • Dwie części działały inaczej niż na stronie. Osoba wkleiła klucz licencyjny w podpowiedzi testowe, a Copilot trzymał go z dala od każdego pliku. Workflow konfiguracji, agent chmurowy, jego problem i tajemnica Agenci wymagają GitHub Actions lub repozytorium GitHub, więc żadne z nich nie działało.

Wersja asystenta, model, czasy i maszyna testowa za tymi wynikami są wymienione z każdym innym przewodnikiem w rejestrze uruchomień.


Rozwiązywanie problemów


Pytania?

Jeśli są jakiekolwiek pytania, należy skontaktować się z support@ironsoftware.com

Curtis Chau posiada tytuł licencjata z informatyki (Uniwersytet Carleton) i specjalizuje się w front-endowym rozwoju, z ekspertką w Node.js, TypeScript, JavaScript i React. Pasjonuje się tworzeniem intuicyjnych i estetycznie przyjemnych interfejsów użytkownika, Curtis cieszy się pracą z nowoczesnymi frameworkami i tworzeniem dobrze zorganizowanych, atrakcyjnych wizualnie podręczników.

Czytaj więcej

Gotowy, aby rozpocząć?

Pobrania z NuGet 6,394,824Wersja:2026.11właśnie wydane