@azure/ai-form-recognizer package

Osztályok

AzureKeyCredential	Statikus kulcsalapú hitelesítő adat, amely támogatja a mögöttes kulcs értékének frissítését.
DocumentAnalysisClient	Ügyfél a Form Recognizer szolgáltatás elemzési funkcióival való interakcióhoz. Példák: A Form Recognizer szolgáltatás és az ügyfelek két hitelesítési módot támogatnak: 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, ); API-kulcs (előfizetési kulcs) 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	Ügyfél a Form Recognizer szolgáltatás modellkezelési funkcióival való interakcióhoz, például modellek létrehozásához, olvasásához, listázásához, törléséhez és másolásához. Példák: 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, ); API-kulcs (előfizetési kulcs) 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, );

Interfészek

AddressValue	Címmező értéke.
AnalyzeDocumentOptions	A dokumentumelemzési művelet beállításai.
AnalyzeResult	Egy elemzési művelet eredménye. A dokumentum típusát az elemzés végrehajtásához használt modell határozhatja meg.
AnalyzeResultCommon	Az Összes AnalyzeResult-szerű típus, például az LayoutResult, a ReadResult és a GeneralDocumentResult közös mezői.
AnalyzedDocument	Kinyert dokumentumobjektum. Az AnalyzedDocument a modell egyik dokumentumtípusának példánya. A mezők a dokumentumtípus mezősémájának felelnek meg.
AzureBlobFileListSource	Egy Azure Blob Container által meghatározott betanítási adatforrás és egy JSONL-fájllista a tárolón belül.
AzureBlobFileListSourceDetails	Fájllista az Azure Blob Storage-ban.
AzureBlobSource	Egy Azure Blob-tároló által definiált betanítási adatforrás.
AzureBlobSourceDetails	Azure Blob Storage-tartalom.
BeginBuildDocumentClassifierOptions	A dokumentumosztályozó buildelési műveletének beállításai.
BeginBuildDocumentModelOptions	A modell buildelési műveletének beállításai.
BeginComposeDocumentModelOptions	A modellírási művelet beállításai.
BeginCopyModelOptions	A másolási modell műveletének beállításai.
BoundingRegion	Határoló sokszög a bemenet egy adott oldalán.
ClassifierDocumentTypeDetails	Osztályozó dokumentumtípus-információi.
ClassifyDocumentOptions	A dokumentumbesorolási művelet beállításai.
CommonModelCreationOptions	Az új modelleket definiáló összes műveletre , például beginBuildDocumentModel, beginComposeDocumentModelés getCopyAuthorization.
CopyAuthorization	Dokumentummodell másolásának engedélyezése a megadott célerőforrásba és modelId-be.
CreateDocumentModelOptions	A modelllétrehozási művelet beállításai.
CurrencyValue	Pénznem mező értéke.
CustomDocumentModelsDetails	Az egyéni dokumentummodellekkel kapcsolatos részletek.
DeleteDocumentModelOptions	A modell törlésének lehetőségei.
DocumentAddressField	Strukturált fizikai címet leíró dokumentummező.
DocumentAnalysisClientOptions	A DocumentAnalysisClient konfigurálható beállításai.
DocumentAnalysisPollOperationState	Egy elemzési művelet állapota, amely végül a modellnek megfelelő eredménytípust hozza létre.
DocumentAnnotation	A dokumentum vizuális széljegyzeteleme, például pipa vagy kereszt.
DocumentArrayField	Beágyazott mezők tömbéből álló DocumentField. A tömb minden mezője ugyanazzal a típussal fog rendelkezni.
DocumentBarcode	Kinyert vonalkód.
DocumentBooleanField	Logikai értékkel rendelkező DocumentField.
DocumentCaption	Egy táblafelirat helyét és tartalmát jelképező objektum.
DocumentClassifierBuildOperationDetails	Művelet válaszobjektumának lekérése.
DocumentClassifierDetails	Dokumentumosztályozó adatai.
DocumentClassifierDocumentTypeSources	Dokumentumosztályozó létrehozásához használt források készlete. Ez a dokumentumtípusnevek olyan forrásokra való leképezése, amelyek a modell betanítására szolgálnak a megfelelő forrástípus dokumentumainak besorolására.
DocumentClassifierOperationState	A modelllétrehozási művelet állapota.
DocumentCountryRegionField	Olyan DocumentField, amely egy országot vagy régiót jelző értékkel rendelkezik, sztringként jelölve.
DocumentCurrencyField	Egy adott pénznem mennyiségét leíró DocumentField.
DocumentDateField	Dátum értékkel rendelkező DocumentField.
DocumentFieldCommon	Az összes DocumentField-változatban gyakori mezők.
DocumentFieldSchema	A mező szemantikai sémájának leírása JSON-sémastílus szintaxisával.
DocumentFootnote	Egy táblázat lábjegyzetének helyét és tartalmát jelképező objektum.
DocumentFormula	Kinyert képlet.
DocumentIntegerField	Egész számértékeket tartalmazó DocumentField.
DocumentKeyValueElement	Egy kulcs-érték pár mezőkulcsát vagy értékét képviselő objektum.
DocumentKeyValuePair	Az űrlapmezőt különböző mezőfelirattal (kulcs) és mezőértékkel (lehet, hogy üres) képviselő objektum.
DocumentLanguage	Egy adott szövegtartomány észlelt nyelvét képviselő objektum.
DocumentLine	Tartalomvonal-objektum, amely tartalomelemek, például szavak és kijelölési jelek szomszédos sorozatából áll.
DocumentModel	Jól ismert modellspecifikáció, amely támogatja a strukturált dokumentumok kinyerését. Tekintse meg a DocumentAnalysisClient beginAnalyzeDocument metódusát, amely támogatja ezeknek a DocumentModel objektumoknak a használatát a modellazonosító-sztringek helyett az erősebb eredménytípusok érdekében.
DocumentModelAdministrationClientOptions	A DocumentModelAdministrationClient konfigurálható beállításai.
DocumentModelBuildOperationDetails	Művelet válaszobjektumának lekérése.
DocumentModelComposeOperationDetails	Művelet válaszobjektumának lekérése.
DocumentModelCopyToOperationDetails	Művelet válaszobjektumának lekérése.
DocumentModelDetails	Dokumentummodell adatai.
DocumentModelOperationState	A modelllétrehozási művelet állapota.
DocumentModelSummary	Dokumentummodell összegzése.
DocumentNumberField	Számértékeket tartalmazó DocumentField.
DocumentObjectField	Több elnevezett tulajdonságból álló DocumentField, amely saját DocumentField-értékekkel rendelkezik.
DocumentPage	A bemenetből kinyert tartalom- és elrendezéselemek.
DocumentParagraph	Olyan bekezdésobjektum, amely általában egybefüggő vonalakból áll, közös igazítással és térközrel.
DocumentPhoneNumberField	Olyan DocumentField, amelynek telefonszámértéke sztringként van jelölve.
DocumentSelectionMark	Jelölőnégyzeteket, választógombokat és a kijelölést jelző egyéb elemeket megjelenítő kijelölésjel objektum.
DocumentSelectionMarkField	Olyan Dokumentummező, amelynek értéke a kijelölési jel állapotát (például jelölőnégyzetet vagy választógombot) jelöli sztringként.
DocumentSignatureField	Egy dokumentummező, amely egy aláírás állapotát jelzi, sztringként jelölve.
DocumentSpan	Az összefűzött tartalomtulajdonság egybefüggő régiója, eltolásként és hosszként megadva.
DocumentStringField	Egy sztringértéket tartalmazó DocumentField.
DocumentStyle	Megfigyelt szövegstílusokat képviselő objektum.
DocumentTable	Táblázatobjektum, amely négyszögletes elrendezésben elrendezett táblázatcellákból áll.
DocumentTableCell	Egy táblacella helyét és tartalmát képviselő objektum.
DocumentTimeField	Egy dokumentummező, amelynek időértéke sztringként van jelölve.
DocumentTypeDetails	Dokumentumtípus adatai.
DocumentValueField	Egyszerű mező, amelynek primitív értéke van, például sztring, szám stb.
DocumentWord	Egy szóobjektum, amely egy összefüggő karaktersorozatból áll. A nem szóközzel tagolt nyelvek, például a kínai, a japán és a koreai nyelv esetében minden karakter saját szóként jelenik meg.
ErrorModel	Hibainformációk.
GetCopyAuthorizationOptions	A másolás-engedélyezési metódus lekérésének beállításai.
GetModelOptions	A modelladatok beolvasásának lehetőségei.
GetOperationOptions	A műveletállapot beolvasásának lehetőségei.
GetResourceDetailsOptions	A Form Recognizer erőforrás-információinak lekérési lehetőségei.
HasBoundingPolygon	Az egyszerű dokumentumelemeket, például szavakat, kijelölési jeleket és sorokat a sokszög határolja.
InnerError	Részletes hiba.
ListModelsOptions	Modellek listázásának lehetőségei.
ListOperationsOptions	A műveletek felsorolásának beállításai.
ModelAdministrationOperationStateCommon	Az összes felügyeleti művelethez gyakran használt mezők készlete.
OperationDetails	Művelet válaszobjektumának lekérése.
OperationSummary	Művelet adatai.
Point2D	Határoló sokszögek definiálására használt pontot jelöl. Az egység "pixel" vagy "inch" (lásd LengthUnit).
PollerOptions	A Form Recognizer-ügyfeleken futó hosszú ideig futó műveletek (pollerek) beállításai.
QuotaDetails	A felhasznált kvóta, a korlát és a következő visszaállítás dátuma/ideje.
ResourceDetails	Az aktuális erőforrásra vonatkozó általános információk.

Típusaliasok

AnalysisPoller	Egy hosszú ideig futó művelet (poller), amely nyomon követi egy elemzési művelet állapotát, és végül a modellnek megfelelő eredménytípust hoz létre.
AnalyzeResultOperationStatus	Az AnalyzeResultOperationStatus értékeit határozza meg.
DocumentBarcodeKind	A DocumentBarcodeKind értékeit határozza meg. KnownDocumentBarcodeKind a DocumentBarcodeKind használatával felcserélhető, ez a szám tartalmazza a szolgáltatás által támogatott ismert értékeket. A szolgáltatás által támogatott ismert értékek QRCode: QR-kód, az ISO/IEC 18004:2015 szabványban meghatározottak szerint. PDF417: PDF417, az ISO 15438-ban meghatározottak szerint. UPCA: GS1 12 jegyű univerzális termékkód. UPCE: GS1 6 jegyű univerzális termékkód. Code39: Code 39 vonalkód, az ISO/IEC 16388:2007 szabványban meghatározottak szerint. Code128: Code 128 vonalkód, az ISO/IEC 15417:2007 szabványban meghatározottak szerint. EAN8: GS1 8 jegyű nemzetközi cikkszám (európai cikkszám). EAN13: GS1 13 jegyű nemzetközi cikkszám (európai cikkszám). DataBar: GS1 DataBar vonalkód. Code93: Code 93 vonalkód, az ANSI/AIM BC5-1995-ben meghatározottak szerint. Codabar: Codabar vonalkód, az ANSI/AIM BC3-1995-ben meghatározottak szerint. DataBarExpanded: GS1 DataBar Expand barcode. ITF: 2/5 vonalkód, az ANSI/AIM BC2-1995-ben meghatározottak szerint. MicroQRCode: Micro QR-kód, az ISO/IEC 23941:2022 szabványban meghatározottak szerint. Aztec: Aztec-kód, az ISO/IEC 24778:2008 szabványban meghatározottak szerint. DataMatrix: Az ISO/IEC 16022:2006 szabványban meghatározott adatmátrix-kód. MaxiCode: MaxiCode, az ISO/IEC 16023:2000 szabványban meghatározottak szerint.
DocumentBuildMode	A DocumentBuildMode értékeit határozza meg. KnownDocumentBuildMode a DocumentBuildMode használatával felcserélhető, ez a szám tartalmazza a szolgáltatás által támogatott ismert értékeket. A szolgáltatás által támogatott ismert értékek sablon: Hasonló vizualizációs sablonokkal rendelkező dokumentumok céldokumentumai. neurális: Különböző vizualizációs sablonokkal rendelkező dokumentumok támogatása.
DocumentClassifierPoller	Egy hosszú ideig futó művelet (poller), amely nyomon követi egy egyéni osztályozó létrehozási műveletének állapotát, és végül létrehoz egy DocumentClassifierDetails.
DocumentClassifierSource	Dokumentumosztályozó létrehozásához használható tartalomforrás. Az alábbiak egyike: BlobSource BlobFileListSource
DocumentField	Kinyert mező. A kind tulajdonság azonosítja (megkülönbözteti) a DocumentFieldtípusát.
DocumentFieldType	A DocumentFieldType értékeit határozza meg. KnownDocumentFieldType a DocumentFieldType használatával felcserélhető, ez a szám tartalmazza a szolgáltatás által támogatott ismert értékeket. A szolgáltatás által támogatott ismert értékek sztring: Egyszerű szöveg. dátum: Dátum, iso 8601 (YYYY-MM-DD) formátumra normalizálva. idő: Idő, iso 8601 (óó:mm:ss) formátumra normalizálva. phoneNumber: Telefonszám, normalizálva E.164 (+{CountryCode}{SubscriberNumber}) formátumra. szám: Lebegőpontos szám, kettős pontosságú lebegőpontosra normalizálva. egész szám: Egész szám, normalizálva 64 bites aláírt egész számra. selectionMark: A mező ki van jelölve? countryRegion: Ország/régió, iso 3166-1 alfa-3 formátumra normalizálva (pl. USA). aláírási: Létezik aláírás? tömb: Az azonos típusú almezők listája. objektum: A különböző típusú almezők nevesített listája. pénznem: Pénznem összege választható pénznemszimbólummal és mértékegységgel. cím: Elemzési cím. logikai: Logikai érték, igaz vagy hamis értékre normalizálva.
DocumentFormulaKind	A DocumentFormulaKind értékeit határozza meg. KnownDocumentFormulaKind a DocumentFormulaKind használatával felcserélhető, ez a szám tartalmazza a szolgáltatás által támogatott ismert értékeket. A szolgáltatás által támogatott ismert értékek beágyazott: Egy bekezdés tartalmába ágyazott képlet. megjelenítési: Egy teljes sort elfoglaló, megjelenítési módban lévő képlet.
DocumentModelBuildMode	Támogatott modellépítési módok. A modell összeállítási módja kiválasztja azt a motort, amelyet a szolgáltatás a modell betanításához használ a címkézett betanítási adatok alapján. A lehetőségek a következők: "neurális", amely biztosítja a legmagasabb minőségű modellt, amely képes adatokat kinyerni olyan dokumentumosztályokból, amelyek azonos adatstruktúrával rendelkeznek, de különböző elrendezésekkel (például W2 adózási űrlapok, amelyek vállalatonként eltérőek lehetnek, de mindig ugyanazokat az információkat tartalmazzák). "sablon", amelyhez minden dokumentumnak azonos rögzített elrendezésűnek (sablonnak) kell rendelkeznie. További információért tekintse meg a következő hivatkozást: https://aka.ms/azsdk/formrecognizer/buildmode
DocumentModelPoller	Egy hosszú ideig futó művelet (poller), amely nyomon követi a modelllétrehozási művelet állapotát, és végül létrehoz egy DocumentModelDetails.
DocumentModelSource	Egy dokumentummodell létrehozásához használható tartalomforrás. Az alábbiak egyike: BlobSource BlobFileListSource
DocumentSignatureType	A DocumentSignatureType értékeit határozza meg. KnownDocumentSignatureType a DocumentSignatureType használatával felcserélhető, ez a szám tartalmazza a szolgáltatás által támogatott ismert értékeket. A szolgáltatás által támogatott ismert értékek aláírt: A rendszer aláírást észlel. aláíratlan: A rendszer nem észlel aláírásokat.
DocumentTableCellKind	A DocumentTableCellKind értékeit határozza meg. KnownDocumentTableCellKind a DocumentTableCellKind használatával felcserélhető, ez a szám tartalmazza a szolgáltatás által támogatott ismert értékeket. A szolgáltatás által támogatott ismert értékek tartalom: A fő tartalmat/adatokat tartalmazza. rowHeader: A sor tartalmát ismerteti. columnHeader: Az oszlop tartalmát ismerteti. stubHead: A táblázat bal felső sarkában található sorfejléceket ismerteti. leírás: A táblázat (részeinek) tartalmát ismerteti.
FontStyle	A FontStyle értékeit határozza meg. IsmertFontStyle felcserélhető a FontStyle használatával, ez a szám tartalmazza a szolgáltatás által támogatott ismert értékeket. A szolgáltatás által támogatott ismert értékek normál: A karakterek normál módon jelennek meg. dőlt: A karakterek vizuálisan jobbra vannak eltolva.
FontWeight	A FontWeight értékeit határozza meg. IsmertFontWeight a FontWeight használatával felcserélhető, ez a szám tartalmazza a szolgáltatás által támogatott ismert értékeket. A szolgáltatás által támogatott ismert értékek normál: A karakterek normál módon jelennek meg. félkövér: A karakterek vastagabb vonásokkal jelennek meg.
FormRecognizerFeature	A kéréshez engedélyezhető bővítményfunkciók (funkciók). A Form Recognizerben elérhető funkciókkal kapcsolatos további információkért tekintse meg a szolgáltatás dokumentációját: https://aka.ms/azsdk/formrecognizer/features
FormRecognizerRequestBody	Kérelembemenet, amely bináris adatként tölthető fel a Form Recognizer szolgáltatásba. A Form Recognizer URL-címként kezeli a string bemeneteket, így ha egy sztringet bináris bemenetként szeretne küldeni, először konvertálja a sztringet az alábbi bemeneti típusok egyikére.
LengthUnit	A LengthUnit értékeit határozza meg. KnownLengthUnit felcserélhető a LengthUnittal, ez a szám tartalmazza a szolgáltatás által támogatott ismert értékeket. A szolgáltatás által támogatott ismert értékek képpontos: Képfájlok hosszegysége. hüvelyk: A PDF-fájlok hosszegysége.
OperationDetailsUnion	A Form Recognizer felügyeleti műveletek különböző típusainak részletei.
OperationKind	Az OperationKind értékeit határozza meg. KnownOperationKind az OperationKinddel felcserélhető, ez a szám tartalmazza a szolgáltatás által támogatott ismert értékeket. A szolgáltatás által támogatott ismert értékek documentModelBuild: Új egyéni dokumentummodell létrehozása. documentModelCompose: Új egyéni dokumentummodell összeállítása meglévő modellekből. documentModelCopyTo: Meglévő dokumentummodell másolása egy másik erőforrásba, régióba vagy előfizetésbe. documentClassifierBuild: Új egyéni osztályozómodell létrehozása.
OperationStatus	Az OperationStatus értékeit határozza meg.
ParagraphRole	A ParagraphRole értékeit határozza meg. KnownParagraphRole a ParagraphRole-nal felcserélhető, ez a szám tartalmazza a szolgáltatás által támogatott ismert értékeket. A szolgáltatás által támogatott ismert értékek pageHeader: Szöveg a lap felső széle közelében. pageFooter: Szöveg a lap alsó széle közelében. pageNumber: Oldalszám. cím: A teljes dokumentumot leíró legfelső szintű cím. sectionHeading: A dokumentum egy szakaszát leíró alfejléc. lábjegyzet: Általában a lap fő tartalma után elhelyezett jegyzet. formulaBlock: Képletek blokkja, gyakran közös igazítással.
SelectionMarkState	A SelectionMarkState értékeit határozza meg. KnownSelectionMarkState a SelectionMarkState használatával felcserélhető, ez a szám tartalmazza a szolgáltatás által támogatott ismert értékeket. A szolgáltatás által támogatott ismert értékek kijelölt: A kijelölési jel ki van jelölve, amelyet gyakran jelöl egy ellenőrzés ✓ vagy X kereszt a kijelölési jelen belül. kijelöletlen: A kijelölési jel nincs kijelölve.
StringIndexType	A Form Recognizer szolgáltatás és az SDK-ügyfelek által támogatott érvényes sztringindex-típusok.

Enumerációk

KnownDocumentBarcodeKind	A szolgáltatás által elfogadott DocumentBarcodeKind ismert értékei.
KnownDocumentBuildMode	A szolgáltatás által elfogadott DocumentBuildMode ismert értékei.
KnownDocumentFieldType	A szolgáltatás által elfogadott DocumentFieldType ismert értékei.
KnownDocumentFormulaKind	A szolgáltatás által elfogadott DocumentFormulaKind ismert értékei.
KnownDocumentSignatureType	A szolgáltatás által elfogadott DocumentSignatureType ismert értékei.
KnownDocumentTableCellKind	A szolgáltatás által elfogadott DocumentTableCellKind ismert értékei.
KnownFontStyle	A szolgáltatás által elfogadott FontStyle ismert értékei.
KnownFontWeight	A szolgáltatás által elfogadott FontWeight ismert értékei.
KnownFormRecognizerAudience	Meghatározza a Form Recognizer ismert felhőbeli célközönségeit. Ha az Entra azonosítóval (egy TokenCredential) használatával szeretne hitelesítést végezni egy szuverén felhő környezetben, adja meg az alábbi audienceDocumentAnalysisClient megfelelő értéket a vagy DocumentModelAdministrationClienta . Az alapértelmezett érték az Azure nyilvános felhőben létrehozott Form Recognizer-erőforrásokhoz megfelelő, ezért erre az értékre csak a Form Recognizer másik felhőkörnyezetben való használatához van szükség.
KnownLengthUnit	A szolgáltatás által elfogadott LengthUnit ismert értékei.
KnownOperationKind	A szolgáltatás által elfogadott OperationKind ismert értékei.
KnownParagraphRole	A szolgáltatás által elfogadott ParagraphRole ismert értékei.
KnownSelectionMarkState	A szolgáltatás által elfogadott SelectionMarkState ismert értékei.