Sdílet prostřednictvím


@azure/ai-form-recognizer package

Třídy

AzureKeyCredential

Přihlašovací údaje založené na statickém klíči, které podporují aktualizaci hodnoty podkladové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 { DocumentAnalysisClient } from "@azure/ai-form-recognizer";
import { DefaultAzureCredential } from "@azure/identity";

const endpoint = "https://<resource name>.cognitiveservices.azure.com";
const credential = new DefaultAzureCredential();

const client = new DocumentAnalysisClient(endpoint, credential);

Klíč rozhraní API (klíč předplatného)

import { DocumentAnalysisClient, AzureKeyCredential } from "@azure/ai-form-recognizer";

const endpoint = "https://<resource name>.cognitiveservices.azure.com";
const credential = new AzureKeyCredential("<api key>");

const client = new DocumentAnalysisClient(endpoint, 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 { DocumentModelAdministrationClient } from "@azure/ai-form-recognizer";
import { DefaultAzureCredential } from "@azure/identity";

const endpoint = "https://<resource name>.cognitiveservices.azure.com";
const credential = new DefaultAzureCredential();

const client = new DocumentModelAdministrationClient(endpoint, credential);

Klíč rozhraní API (klíč předplatného)

import { DocumentModelAdministrationClient, AzureKeyCredential } from "@azure/ai-form-recognizer";

const endpoint = "https://<resource name>.cognitiveservices.azure.com";
const credential = new AzureKeyCredential("<api key>");

const client = new DocumentModelAdministrationClient(endpoint, credential);

Rozhraní

AddressValue

Hodnota pole Adresa.

AnalyzeDocumentOptions

Možnosti pro operaci analýzy dokumentu

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ů podobných analyzeResult, například 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 polí typu dokumentu.

AzureBlobFileListSource

Trénovací zdroj dat definovaný kontejnerem objektů blob Azure a seznamem souborů JSONL v rámci kontejneru.

AzureBlobFileListSourceDetails

Seznam souborů v Azure Blob Storage.

AzureBlobSource

Trénovací zdroj dat definovaný kontejnerem objektů blob Azure.

AzureBlobSourceDetails

Azure Blob Storage obsah.

BeginBuildDocumentClassifierOptions

Možnosti pro operaci sestavení klasifikátoru dokumentu

BeginBuildDocumentModelOptions

Možnosti pro operaci sestavení modelu

BeginComposeDocumentModelOptions

Možnosti pro operaci vytvoření modelu

BeginCopyModelOptions

Možnosti operace kopírování modelu

BoundingRegion

Ohraničující mnohoúhelník na konkrétní stránce vstupu.

ClassifierDocumentTypeDetails

Informace o typu dokumentu klasifikátoru

ClassifyDocumentOptions

Možnosti pro operaci klasifikace dokumentu.

CommonModelCreationOptions

Možnosti společné pro všechny operace, které definují nové modely, jako beginBuildDocumentModeljsou , beginComposeDocumentModela getCopyAuthorization.

CopyAuthorization

Autorizace pro zkopírování modelu dokumentu do zadaného cílového prostředku a id modelu.

CreateDocumentModelOptions

Možnosti pro operaci vytvoření modelu

CurrencyValue

Hodnota pole Měna.

CustomDocumentModelsDetails

Podrobnosti týkající se vlastních modelů dokumentů

DeleteDocumentModelOptions

Možnosti 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 tabulky popis.

DocumentClassifierBuildOperationDetails

Získejte objekt odpovědi operace.

DocumentClassifierDetails

Informace o klasifikátoru dokumentů

DocumentClassifierDocumentTypeSources

Sada zdrojů používaná k vytvoření klasifikátoru dokumentu. Jedná se o mapování názvů typů dokumentů na zdroje, které se použijí k trénování modelu pro klasifikaci dokumentů odpovídajícího typu zdroje.

DocumentClassifierOperationState

Stav operace vytvoření modelu.

DocumentCountryRegionField

A DocumentField, který má hodnotu označující zemi nebo oblast, reprezentované jako řetězec.

DocumentCurrencyField

A DocumentField, který popisuje částku určité měny.

DocumentDateField

A DocumentField, který má date hodnotu.

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

A DocumentField, který má celočíselnou hodnotu.

DocumentKeyValueElement

Objekt představující klíč pole nebo hodnotu ve dvojici 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 pro daný rozsah textu.

DocumentLine

Objekt řádku obsahu skládající se ze sousední sekvence prvků obsahu, jako jsou slova a výběrové značky.

DocumentModel

Dobře známá specifikace modelu, která podporuje extrakci strukturovaných dokumentů.

Podívejte se na metodu beginAnalyzeDocumentDocumentAnalysisClient, která podporuje využívání těchto DocumentModel objektů místo řetězců ID modelu k poskytování silnějších typů výsledků.

DocumentModelAdministrationClientOptions

Konfigurovatelné možnosti pro DocumentModelAdministrationClient.

DocumentModelBuildOperationDetails

Získejte objekt odpovědi operace.

DocumentModelComposeOperationDetails

Získejte objekt odpovědi operace.

DocumentModelCopyToOperationDetails

Získejte objekt odpovědi operace.

DocumentModelDetails

Informace o modelu dokumentu

DocumentModelOperationState

Stav operace vytvoření modelu.

DocumentModelSummary

Souhrn modelu dokumentu

DocumentNumberField

A DocumentField, která má číselnou hodnotu.

DocumentObjectField

A DocumentField, který se skládá z několika pojmenovaných vlastností, které mají své vlastní DocumentField hodnoty.

DocumentPage

Prvky obsahu a rozložení extrahované ze stránky ze vstupu

DocumentParagraph

Objekt odstavce skládající se 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

DocumentField, který 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

A DocumentField označující stav podpisu reprezentovaný jako řetězec.

DocumentSpan

Souvislá oblast vlastnosti zřetězený obsah, která je určena jako posun a délka.

DocumentStringField

A DocumentField, který má řetězcovou hodnotu.

DocumentStyle

Objekt představující pozorované styly textu.

DocumentTable

Objekt tabulky skládající se 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

A DocumentField, který má čas hodnotu, reprezentovaný jako řetězec.

DocumentTypeDetails

Informace o typu dokumentu.

DocumentValueField

Jednoduché pole, které má primitivní hodnotu, například řetězec, číslo atd.

DocumentWord

Objekt slova, který se skládá z souvislé sekvence znaků. U jazyků, které nejsou oddělené mezerami, jako je čínština, japonština a korejština, je každý znak reprezentován jako vlastní slovo.

ErrorModel

Informace o chybě.

GetCopyAuthorizationOptions

Možnosti pro metodu získání autorizace kopírování.

GetModelOptions

Možnosti pro načtení informací o modelu

GetOperationOptions

Možnosti pro 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 operací výpisu.

ModelAdministrationOperationStateCommon

Sada polí, která jsou společná pro všechny operace správy.

OperationDetails

Získejte objekt odpovědi operace.

OperationSummary

Informace o operaci.

Point2D

Představuje bod použitý k definování ohraničující mnohoúhelníky. Jednotkou je pixel nebo inch (viz LengthUnit).

PollerOptions

Možnosti pro dlouhotrvající operace (pollers) v klientech Rozpoznávání formulářů.

QuotaDetails

Využitá kvóta, omezení a datum a čas příštího resetování

ResourceDetails

Obecné informace týkající se aktuálního prostředku

Aliasy typu

AnalysisPoller

Dlouhotrvající operace (poller), která sleduje stav operace analýzy a nakonec vygeneruje typ výsledku odpovídající modelu.

AnalyzeResultOperationStatus

Definuje hodnoty pro AnalyzeResultOperationStatus.

DocumentBarcodeKind

Definuje hodnoty pro DocumentBarcodeKind.
KnownDocumentBarcodeKind 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, jak je definován 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.
Kód39: Čárový kód 39, jak je definován v ISO/IEC 16388:2007.
Kód 128: Čárový kód 128, jak je definován v ISO/IEC 15417:2007.
EAN8: GS1 8místné číslo mezinárodního článku (evropské číslo článku).
EAN13: GS1 13místné číslo mezinárodního článku (evropské číslo článku).
DataBar: GS1 DataBar čárový kód.
Kód93: Čárový kód 93, jak je definován v ANSI/AIM BC5-1995.
Codabar: Čárový kód Codabar, jak je definován v ANSI/AIM BC3-1995.
DataBarExpanded: Rozbalený čárový kód datového panelu GS1.
ITF: Prokládané 2 z 5 čárových kódů, jak jsou definovány v ANSI/AIM BC2-1995.
MicroQRCode: Kód micro QR, jak je definován v ISO/IEC 23941:2022.
Aztec: Aztec kód, jak je definován v ISO/IEC 24778:2008.
DataMatrix: Kód datové matice, jak je definován v ISO/IEC 16022:2006.
MaxiCode: MaxiCode, jak je definováno v ISO/IEC 16023:2000.

DocumentBuildMode

Definuje hodnoty pro DocumentBuildMode.
KnownDocumentBuildMode lze použít zaměnitelně s DocumentBuildMode, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

template: Cílové dokumenty s podobnými vizuálními šablonami.
neural: Podpora dokumentů s různými vizuálními šablonami.

DocumentClassifierPoller

Dlouhotrvající operace (poller), která sleduje stav operace vytvoření vlastního klasifikátoru a nakonec vytvoří DocumentClassifierDetails.

DocumentClassifierSource

Zdroj obsahu, který lze použít k vytvoření klasifikátoru dokumentů.

Jedna z těchto možností:

  • Zdroj objektů blob
  • BlobFileListSource
DocumentField

Extrahované pole Vlastnost kind identifikuje (rozlišuje) typ objektu DocumentField.

DocumentFieldType

Definuje hodnoty pro DocumentFieldType.
Pole KnownDocumentFieldType lze použít zaměnitelně s DocumentFieldType, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

string: Prostý text.
date: Datum, normalizované do formátu ISO 8601 (RRRR-MM-DD).
time: Čas, normalizovaný do formátu ISO 8601 (hh:mm:ss).
phoneNumber: Telefonní číslo normalizované do formátu E.164 (+{CountryCode}{SubscriberNumber}).
number: Číslo s plovoucí desetinou čárkou, normalizované na hodnotu s plovoucí desetinou čárkou s dvojitou přesností.
integer: Celočíselné číslo, normalizované na 64bitové celé číslo se signýmmim
selectionMark: Je pole vybrané?
countryRegion: Země/oblast, normalizované do formátu ISO 3166-1 alpha-3 (např. USA).
signature: Existuje podpis?
array: Seznam dílčích polí stejného typu.
object: Pojmenovaný seznam dílčích polí potenciálně různých typů.
currency: Částka měny s volitelným symbolem měny a jednotkou.
address: Parsovaná adresa.
Logická hodnota: Logická hodnota, normalizovaná na hodnotu true nebo false.

DocumentFormulaKind

Definuje hodnoty pro DocumentFormulaKind.
KnownDocumentFormulaKind lze použít zaměnitelně s DocumentFormulaKind, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

inline: Vzorec vložený do obsahu odstavce.
display: 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.

Možnosti:

  • "neurální", která poskytuje nejvyšší kvalitu modelu, který je schopen extrahovat data z tříd dokumentů, které mají stejnou strukturu dat, ale různá rozložení (například daňové formuláře W2, které se mohou lišit v jednotlivých 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 vygeneruje DocumentModelDetails.

DocumentModelSource

Zdroj obsahu, který lze použít k vytvoření modelu dokumentu.

Jedna z těchto možností:

  • Zdroj objektů blob
  • BlobFileListSource
DocumentSignatureType

Definuje hodnoty pro DocumentSignatureType.
KnownDocumentSignatureType lze použít zaměnitelně s DocumentSignatureType, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

podepsáno: Byl zjištěn podpis.
unsigned: Nebyly zjištěny žádné podpisy.

DocumentTableCellKind

Definuje hodnoty pro DocumentTableCellKind.
KnownDocumentTableCellKind lze použít zaměnitelně s DocumentTableCellKind, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

content: Obsahuje hlavní obsah nebo data.
rowHeader: Popisuje obsah řádku.
columnHeader: Popisuje obsah sloupce.
stubHead: Popisuje záhlaví řádků, která se obvykle nacházejí v levém horním rohu tabulky.
description: 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íva: Znaky jsou vizuálně zkosené doprava.

FontWeight

Definuje hodnoty pro FontWeight.
KnownFontWeight se dá 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é písmo: Znaky jsou znázorně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 v 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ářů považuje vstupy string za 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.
Pole KnownLengthUnit 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ů.
inch: Jednotka délky 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.
Pole KnownOperationKind 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: Sestavte 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: Vytvořte nový vlastní model klasifikátoru.

OperationStatus

Definuje hodnoty pro OperationStatus.

ParagraphRole

Definuje hodnoty pro ParagraphRole.
KnownParagraphRole 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 u dolního okraje stránky.
pageNumber: Číslo stránky.
title: Nadpis nejvyšší úrovně popisující celý dokument.
sectionHeading: Dílčí nadpis popisující část dokumentu.
poznámka pod čarou: Poznámka obvykle umístěná za hlavním obsahem na stránce.
formulaBlock: Blok vzorců, často se sdíleným zarovnáním.

SelectionMarkState

Definuje hodnoty pro SelectionMarkState.
KnownSelectionMarkState lze použít zaměnitelně s SelectionMarkState, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

selected: Je vybrána značka výběru, č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é klienty služby Rozpoznávání formulářů a 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á.

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