@azure/ai-form-recognizer package

Třídy

AzureKeyCredential	Přihlašovací údaje založené na statickém klíči, které podporují aktualizaci hodnoty základního klíče.
DocumentAnalysisClient	Klient pro interakci s analytickými funkcemi služby Rozpoznávání formulářů. Příklady: Služba Rozpoznávání formulářů a klienti podporují dva způsoby ověřování: Azure Active Directory import { DefaultAzureCredential } from "@azure/identity"; import { DocumentAnalysisClient } from "@azure/ai-form-recognizer"; const credential = new DefaultAzureCredential(); const client = new DocumentAnalysisClient( "https://<resource name>.cognitiveservices.azure.com", credential, ); Klíč rozhraní API (klíč předplatného) import { AzureKeyCredential, DocumentAnalysisClient } from "@azure/ai-form-recognizer"; const credential = new AzureKeyCredential("<API key>"); const client = new DocumentAnalysisClient( "https://<resource name>.cognitiveservices.azure.com", credential, );
DocumentModelAdministrationClient	Klient pro interakci s funkcemi správy modelů služby Rozpoznávání formulářů, jako je vytváření, čtení, výpis, odstraňování a kopírování modelů. Příklady: Azure Active Directory import { DefaultAzureCredential } from "@azure/identity"; import { DocumentModelAdministrationClient } from "@azure/ai-form-recognizer"; const credential = new DefaultAzureCredential(); const client = new DocumentModelAdministrationClient( "https://<resource name>.cognitiveservices.azure.com", credential, ); Klíč rozhraní API (klíč předplatného) import { AzureKeyCredential, DocumentModelAdministrationClient } from "@azure/ai-form-recognizer"; const credential = new AzureKeyCredential("<API key>"); const client = new DocumentModelAdministrationClient( "https://<resource name>.cognitiveservices.azure.com", credential, );

Rozhraní

AddressValue	Hodnota pole Adresa.
AnalyzeDocumentOptions	Možnosti operace analýzy dokumentů
AnalyzeResult	Výsledek operace analýzy. Typ dokumentu může být určen modelem použitým k provedení analýzy.
AnalyzeResultCommon	Společná pole všech typů like AnalyzeResult, jako jsou LayoutResult, ReadResult a GeneralDocumentResult.
AnalyzedDocument	Extrahovaný objekt dokumentu. AnalyzedDocument je instance jednoho z typů dokumentů v rámci modelu. Jeho pole odpovídají schématu pole typu dokumentu.
AzureBlobFileListSource	Trénovací zdroj dat definovaný kontejnerem objektů blob Azure a seznamem souborů JSONL v rámci kontejneru.
AzureBlobFileListSourceDetails	Seznam souborů ve službě Azure Blob Storage
AzureBlobSource	Trénovací zdroj dat definovaný kontejnerem objektů blob Azure.
AzureBlobSourceDetails	Obsah služby Azure Blob Storage
BeginBuildDocumentClassifierOptions	Možnosti operace sestavení klasifikátoru dokumentů
BeginBuildDocumentModelOptions	Možnosti operace sestavení modelu
BeginComposeDocumentModelOptions	Možnosti pro operaci vytváření modelu
BeginCopyModelOptions	Možnosti operace kopírování modelu
BoundingRegion	Ohraničení mnohoúhelníku na konkrétní stránce vstupu
ClassifierDocumentTypeDetails	Informace o typu dokumentu klasifikátoru
ClassifyDocumentOptions	Možnosti operace klasifikace dokumentů
CommonModelCreationOptions	Možnosti společné pro všechny operace, které definují nové modely, jako jsou beginBuildDocumentModel, beginComposeDocumentModela getCopyAuthorization.
CopyAuthorization	Autorizace ke kopírování modelu dokumentu do zadaného cílového prostředku a ID modelu
CreateDocumentModelOptions	Možnosti operace vytvoření modelu
CurrencyValue	Hodnota pole Měna.
CustomDocumentModelsDetails	Podrobnosti týkající se vlastních modelů dokumentů
DeleteDocumentModelOptions	Možnosti pro odstranění modelu
DocumentAddressField	Pole dokumentu, které popisuje strukturovanou fyzickou adresu.
DocumentAnalysisClientOptions	Konfigurovatelné možnosti pro DocumentAnalysisClient
DocumentAnalysisPollOperationState	Stav operace analýzy, která nakonec vytvoří typ výsledku, který odpovídá modelu.
DocumentAnnotation	Prvek vizuální poznámky v dokumentu, například značka zaškrtnutí nebo křížek.
DocumentArrayField	DocumentField, který se skládá z pole vnořených polí. Všechna pole v poli budou mít stejný typ.
DocumentBarcode	Extrahovaný čárový kód.
DocumentBooleanField	DocumentField, který má logickou hodnotu.
DocumentCaption	Objekt představující umístění a obsah titulku tabulky.
DocumentClassifierBuildOperationDetails	Získání objektu odpovědi operace
DocumentClassifierDetails	Informace o klasifikátoru dokumentů
DocumentClassifierDocumentTypeSources	Sada zdrojů použitých k vytvoření klasifikátoru dokumentu. Toto je mapa názvů typů dokumentů na zdroje, které se použijí k trénování modelu pro klasifikaci dokumentů odpovídajícího zdrojového typu.
DocumentClassifierOperationState	Stav operace vytvoření modelu.
DocumentCountryRegionField	DocumentField, který má hodnotu označující zemi nebo oblast reprezentovanou jako řetězec.
DocumentCurrencyField	DocumentField, který popisuje množství určité měny.
DocumentDateField	Pole DocumentField, které má hodnotu Data.
DocumentFieldCommon	Pole, která jsou společná pro všechny varianty DocumentField.
DocumentFieldSchema	Popis sémantického schématu pole pomocí syntaxe stylu schématu JSON
DocumentFootnote	Objekt představující umístění a obsah poznámky pod čarou tabulky.
DocumentFormula	Extrahovaný vzorec.
DocumentIntegerField	Pole DocumentField, které má celočíselnou hodnotu.
DocumentKeyValueElement	Objekt představující klíč pole nebo hodnotu v páru klíč-hodnota.
DocumentKeyValuePair	Objekt představující pole formuláře s jedinečným popiskem pole (klíč) a hodnotou pole (může být prázdný).
DocumentLanguage	Objekt představující rozpoznaný jazyk daného rozsahu textu.
DocumentLine	Objekt řádku obsahu, který se skládá ze sousední sekvence prvků obsahu, jako jsou slova a značky výběru.
DocumentModel	Dobře známá specifikace modelu, která podporuje extrakci strukturovaných dokumentů. Podívejte se na beginAnalyzeDocument metodu DocumentAnalysisClient, která podporuje využívání těchto DocumentModel objektů místo řetězců ID modelu k zajištění silnějších typů výsledků.
DocumentModelAdministrationClientOptions	Konfigurovatelné možnosti pro DocumentModelAdministrationClient
DocumentModelBuildOperationDetails	Získání objektu odpovědi operace
DocumentModelComposeOperationDetails	Získání objektu odpovědi operace
DocumentModelCopyToOperationDetails	Získání objektu odpovědi operace
DocumentModelDetails	Informace o modelu dokumentu
DocumentModelOperationState	Stav operace vytvoření modelu.
DocumentModelSummary	Souhrn modelu dokumentu
DocumentNumberField	DocumentField, který má číselnou hodnotu.
DocumentObjectField	DocumentField, který se skládá z několika pojmenovaných vlastností, které mají vlastní hodnoty DocumentField.
DocumentPage	Prvky obsahu a rozložení extrahované ze stránky ze vstupu
DocumentParagraph	Objekt odstavce, který se skládá z souvislých čar obecně se společným zarovnáním a mezerami.
DocumentPhoneNumberField	DocumentField, který má hodnotu telefonního čísla reprezentovanou jako řetězec.
DocumentSelectionMark	Objekt značky výběru představující zaškrtávací políčka, přepínače a další prvky označující výběr
DocumentSelectionMarkField	Pole DocumentField má hodnotu označující stav značky výběru (například zaškrtávací políčko nebo přepínač) reprezentovaný jako řetězec.
DocumentSignatureField	DocumentField, který označuje stav podpisu reprezentovaný jako řetězec.
DocumentSpan	Souvislá oblast zřetězené vlastnosti obsahu určená jako posun a délka.
DocumentStringField	DocumentField, který má řetězcovou hodnotu.
DocumentStyle	Objekt představující pozorované styly textu
DocumentTable	Objekt tabulky, který se skládá z buněk tabulky uspořádaných do obdélníkového rozložení
DocumentTableCell	Objekt představující umístění a obsah buňky tabulky
DocumentTimeField	DocumentField, který má časovou hodnotu reprezentovanou jako řetězec.
DocumentTypeDetails	Informace o typu dokumentu
DocumentValueField	Jednoduché pole, které má primitivní hodnotu, například řetězec, číslo atd.
DocumentWord	Objekt slova skládající se z souvislé posloupnosti znaků. Pro jazyky, které nejsou oddělené mezerami, jako jsou čínština, japonština a korejština, jsou jednotlivé znaky reprezentovány jako vlastní slovo.
ErrorModel	Informace o chybě
GetCopyAuthorizationOptions	Možnosti metody získání autorizace kopírování
GetModelOptions	Možnosti načítání informací o modelu
GetOperationOptions	Možnosti načtení stavu operace
GetResourceDetailsOptions	Možnosti pro načtení informací o prostředcích rozpoznávání formulářů
HasBoundingPolygon	Jednoduché prvky dokumentu, jako jsou slova, značky výběru a čáry, jsou ohraničeny mnohoúhelníkem.
InnerError	Podrobná chyba
ListModelsOptions	Možnosti výpisu modelů
ListOperationsOptions	Možnosti pro výpis operací
ModelAdministrationOperationStateCommon	Sada polí společná pro všechny operace správy.
OperationDetails	Získání objektu odpovědi operace
OperationSummary	Informace o operaci.
Point2D	Představuje bod použitý k definování ohraničující mnohoúhelníky. Jednotka je "pixel" nebo "inch" (viz LengthUnit).
PollerOptions	Možnosti dlouhotrvajících operací (pollerů) v klientech rozpoznávání formulářů
QuotaDetails	Využitá kvóta, omezení a příští datum a čas resetování
ResourceDetails	Obecné informace týkající se aktuálního zdroje

Aliasy typu

AnalysisPoller	Dlouhotrvající operace (poller), která sleduje stav operace analýzy, nakonec vytvoří typ výsledku, který odpovídá modelu.
AnalyzeResultOperationStatus	Definuje hodnoty pro AnalyzeResultOperationStatus.
DocumentBarcodeKind	Definuje hodnoty pro DocumentBarcodeKind. PoleDocumentBarcodeKind lze použít zaměnitelně s DocumentBarcodeKind, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou QRCode: kód QR definovaný v ISO/IEC 18004:2015. PDF417: PDF417, jak je definováno v ISO 15438. UPCA: GS1 12místný univerzální kód produktu. UPCE: GS1 6místný univerzální kód produktu. Code39: Čárový kód 39 definovaný v ISO/IEC 16388:2007. Kód128: Čárový kód 128 definovaný v ISO/IEC 15417:2007. EAN8: GS1 8místný mezinárodní číslo článku (Číslo evropského článku). EAN13: GS1 13místný mezinárodní číslo článku (Číslo evropského článku). databar: čárový kód GS1 DataBar. Code93: Čárový kód 93 definovaný v ANSI/AIM BC5-1995. codabar: čárový kód Codabar, jak je definováno v ANSI/AIM BC3-1995. DataBarExpanded: Datovýbar GS1 Expanded Barcode. ITF: Prokládání 2 z 5 čárových kódů, jak je definováno v ANSI/AIM BC2-1995. MicroQRCode: Kód Micro QR, jak je definováno v ISO/IEC 23941:2022. Aztec: Aztec code, jak je definováno v ISO/IEC 24778:2008. DataMatrix: Kód datové matice, jak je definováno v ISO/IEC 16022:2006. MaxiCode: MaxiCode, jak je definováno v ISO/IEC 16023:2000.
DocumentBuildMode	Definuje hodnoty pro DocumentBuildMode. PoleDocumentBuildMode lze použít zaměnitelně s DocumentBuildMode, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou šablony: Cílové dokumenty s podobnými vizuálními šablonami neurální: Podpora dokumentů s různými vizuálními šablonami
DocumentClassifierPoller	Dlouhotrvající operace (poller), která sleduje stav vlastní operace vytváření klasifikátoru, nakonec vytvoří DocumentClassifierDetails.
DocumentClassifierSource	Zdroj obsahu, který lze použít k vytvoření klasifikátoru dokumentu. Jedna z těchto možností: Zdroj blobu Zdroj: BlobFileListSource
DocumentField	Extrahované pole. Vlastnost kind identifikuje (diskriminuje) typ DocumentField.
DocumentFieldType	Definuje hodnoty pro DocumentFieldType. PoleDocumentFieldType lze použít zaměnitelně s DocumentFieldType, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou řetězcové: prostý text. datum: Datum, normalizované do formátu ISO 8601 (RRRR-MM-DD). čas: Čas, normalizovaný do formátu ISO 8601 (hh:mm:ss). telefonní číslo: Telefonní číslo, normalizované na formát E.164 (+{CountryCode}{SubscriberNumber}). číslo: číslo s plovoucí desetinnou čárkou, normalizované na dvojitou přesnost s plovoucí desetinnou čárkou. celočíselná: Celočíselné číslo, normalizované na 64bitové celé číslo se signy. selectionMark: Je vybráno pole? zeměregion: Země/oblast, normalizovaná na formát ISO 3166-1 alfa-3 (např. USA). podpis: Existuje podpis? pole: Seznam dílčích polí stejného typu. objektu: Pojmenovaný seznam dílčích polí potenciálně různých typů. měna: Částka měny s volitelným symbolem měny a jednotkou. adresa: Parsovaná adresa. logická hodnota: Logická hodnota normalizovaná na hodnotu true nebo false.
DocumentFormulaKind	Definuje hodnoty pro DocumentFormulaKind. PoleDocumentFormulaKind lze použít zaměnitelně s DocumentFormulaKind, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou vložené: Vzorec vložený do obsahu odstavce. zobrazení: Vzorec v režimu zobrazení, který zabírá celý řádek.
DocumentModelBuildMode	Podporované režimy sestavení modelu Režim sestavení modelu vybere modul, který služba používá k trénování modelu na základě označených trénovacích dat. Mezi možnosti patří: "neurální", což přináší nejvyšší kvalitu modelu, který dokáže extrahovat data z tříd dokumentů se stejnou strukturou dat, ale různá rozložení (například daňové formuláře W2, které se mohou lišit od společnosti po společnost, ale vždy obsahují stejné informace). "šablona", která vyžaduje, aby všechny dokumenty měly stejné pevné rozložení (šablonu). Další informace najdete na následujícím odkazu: https://aka.ms/azsdk/formrecognizer/buildmode
DocumentModelPoller	Dlouhotrvající operace (poller), která sleduje stav operace vytvoření modelu a nakonec vytvoří DocumentModelDetails.
DocumentModelSource	Zdroj obsahu, který lze použít k vytvoření modelu dokumentu. Jedna z těchto možností: Zdroj blobu Zdroj: BlobFileListSource
DocumentSignatureType	Definuje hodnoty pro DocumentSignatureType. PoleDocumentSignatureType lze použít zaměnitelně s DocumentSignatureType, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou podepsaný: Zjistí se podpis. bez znaménka: Nezjistí se žádné podpisy.
DocumentTableCellKind	Definuje hodnoty pro DocumentTableCellKind. PoleDocumentTableCellKind lze použít zaměnitelně s DocumentTableCellKind, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou obsahu: Obsahuje hlavní obsah/data. rowHeader: Popisuje obsah řádku. columnHeader: Popisuje obsah sloupce. stubHead: Popisuje záhlaví řádků, obvykle umístěná v levém horním rohu tabulky. popis: Popisuje obsah tabulky (části).
FontStyle	Definuje hodnoty pro FontStyle. KnownFontStyle lze použít zaměnitelně s FontStyle, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou normální: Znaky jsou reprezentovány normálně. kurzívu: Znaky jsou vizuálně zkosené doprava.
FontWeight	Definuje hodnoty pro FontWeight. PoleFontWeight lze použít zaměnitelně s FontWeight, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou normální: Znaky jsou reprezentovány normálně. tučným písmem: Znaky jsou reprezentovány silnějšími tahy.
FormRecognizerFeature	Možnosti doplňku (funkce), které je možné pro žádost povolit. Další informace o funkcích dostupných ve službě Rozpoznávání formulářů najdete v dokumentaci ke službě: https://aka.ms/azsdk/formrecognizer/features
FormRecognizerRequestBody	Vstup požadavku, který lze nahrát jako binární data do služby Rozpoznávání formulářů. Rozpoznávání formulářů zpracovává string vstupy jako adresy URL, takže pokud chcete odeslat řetězec jako binární vstup, nejprve převeďte řetězec na jeden z následujících typů vstupu.
LengthUnit	Definuje hodnoty pro LengthUnit. PoleLengthUnit lze použít zaměnitelně s LengthUnit, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou pixel: jednotka délky pro soubory obrázků. palce: Délka jednotky pro soubory PDF.
OperationDetailsUnion	Podrobnosti o některém z několika různých typů operací správy rozpoznávání formulářů.
OperationKind	Definuje hodnoty pro OperationKind. PoleOperationKind lze použít zaměnitelně s OperationKind, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou documentModelBuild: Vytvořte nový vlastní model dokumentu. documentModelCompose: Vytvořte nový vlastní model dokumentu z existujících modelů. documentModelCopyTo: Zkopírujte existující model dokumentu do potenciálně jiného prostředku, oblasti nebo předplatného. documentClassifierBuild: Sestavte nový vlastní klasifikátor modelu.
OperationStatus	Definuje hodnoty pro OperationStatus.
ParagraphRole	Definuje hodnoty pro ParagraphRole. PoleParagraphRole lze použít zaměnitelně s ParagraphRole, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou pageHeader: Text v blízkosti horního okraje stránky. pageFooter: Text v dolní části stránky. číslo stránky: Číslo stránky. název: Nadpis nejvyšší úrovně popisující celý dokument. sectionHeading: Dílčí nadpis popisující část dokumentu. poznámky pod čarou: Poznámka se obvykle umístí za hlavní obsah na stránce. formulaBlock: Blok vzorců, často se sdíleným zarovnáním.
SelectionMarkState	Definuje hodnoty pro SelectionMarkState. PoleSelectionMarkState lze použít zaměnitelně s SelectionMarkState, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou vybraná: Značka výběru je vybrána, často označená zaškrtnutím nebo křížkem X uvnitř značky výběru. nevybrané: Značka výběru není vybraná.
StringIndexType	Platné typy indexů řetězců podporované službou Rozpoznávání formulářů a klienty sady SDK.

Výčty

KnownDocumentBarcodeKind	Známé hodnoty DocumentBarcodeKind, které služba přijímá.
KnownDocumentBuildMode	Známé hodnoty DocumentBuildMode, které služba přijímá.
KnownDocumentFieldType	Známé hodnoty DocumentFieldType, které služba přijímá.
KnownDocumentFormulaKind	Známé hodnoty DocumentFormulaKind, které služba přijímá.
KnownDocumentSignatureType	Známé hodnoty DocumentSignatureType, které služba přijímá.
KnownDocumentTableCellKind	Známé hodnoty DocumentTableCellKind, které služba přijímá.
KnownFontStyle	Známé hodnoty FontStyle, které služba přijímá.
KnownFontWeight	Známé hodnoty FontWeight, které služba přijímá.
KnownFormRecognizerAudience	Definuje známé cílové skupiny cloudu pro Rozpoznávání formulářů. Chcete-li se ověřit pomocí Entra ID (pomocí ) TokenCredentialv prostředí suverénního cloudu , zadejte příslušnou hodnotu níže jako možnost audience při vytváření a DocumentAnalysisClient nebo DocumentModelAdministrationClient. Výchozí hodnota je vhodná pro prostředky Rozpoznávání formulářů vytvořené ve veřejném cloudu Azure, takže tato hodnota je vyžadována pouze pro použití Rozpoznávání formulářů v jiném cloudovém prostředí.
KnownLengthUnit	Známé hodnoty LengthUnit, které služba přijímá.
KnownOperationKind	Známé hodnoty OperationKind, které služba přijímá.
KnownParagraphRole	Známé hodnoty ParagraphRole, které služba přijímá.
KnownSelectionMarkState	Známé hodnoty SelectionMarkState, které služba přijímá.