@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óinak használatá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 { 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); API-kulcs (előfizetési kulcs) 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	Ügyfél az 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 { 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); API-kulcs (előfizetési kulcs) 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);

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 a LayoutResult, a ReadResult és a GeneralDocumentResult közös mezői.
AnalyzedDocument	Kinyert dokumentumobjektum. Az AnalyzedDocument a modellen belüli egyik dokumentumtípus példánya. A mezők a dokumentumtípus mezősémájának felelnek meg.
AzureBlobFileListSource	Egy Azure Blob-tároló és egy JSONL-fájllista által definiált betanítási adatforrás a tárolóban.
AzureBlobFileListSourceDetails	Fájllista a Azure Blob Storage.
AzureBlobSource	Egy Azure Blob-tároló által definiált betanítási adatforrás.
AzureBlobSourceDetails	Azure Blob Storage tartalmat.
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ának adatai.
ClassifyDocumentOptions	A dokumentumbesorolási művelet beállításai.
CommonModelCreationOptions	Az új modelleket definiáló összes művelethez gyakran használt lehetőségek, 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énznemmező értéke.
CustomDocumentModelsDetails	Az egyéni dokumentummodellekkel kapcsolatos részletek.
DeleteDocumentModelOptions	A modell törlésének lehetőségei.
DocumentAddressField	Egy 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	Egy dokumentummező, amely beágyazott mezőkből álló tömbből áll. A tömb minden mezője ugyanazzal a típussal fog rendelkezni.
DocumentBarcode	Kinyert vonalkód.
DocumentBooleanField	Egy logikai értékkel rendelkező DocumentField.
DocumentCaption	Egy tábla helyét és tartalmát képviselő objektum, képaláírás.
DocumentClassifierBuildOperationDetails	Művelet válaszobjektumának lekérése.
DocumentClassifierDetails	Dokumentumosztályozó adatai.
DocumentClassifierDocumentTypeSources	Dokumentumosztályozó létrehozásához használt források halmaza. 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, amelynek értéke egy országot vagy régiót jelöl, sztringként jelölve.
DocumentCurrencyField	Egy dokumentummező, amely egy adott pénznem mennyiségét írja le.
DocumentDateField	Egy DocumentField, amely dátum értékkel rendelkezik.
DocumentFieldCommon	Az összes DocumentField-változathoz gyakran használt 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	A mezőkulcsot vagy értéket egy kulcs-érték párban képviselő objektum.
DocumentKeyValuePair	Egy űrlapmezőt képviselő objektum, amely különböző mezőcímkével (kulccsal) és mezőértékkel rendelkezik (lehet, hogy üres).
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 beginAnalyzeDocumentDocumentAnalysisClient metódusát, amely támogatja ezeknek az objektumoknak a DocumentModel használatát a modellazonosító-sztringek helyett, hogy erősebb eredménytípusokat biztosítson.
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	Dokumentummező, amely több megnevezett tulajdonságból áll, amelyek saját DocumentField-értékekkel rendelkeznek.
DocumentPage	A bemenetből kinyert tartalom- és elrendezéselemek.
DocumentParagraph	Egy bekezdésobjektum, amely folytonos vonalakból áll, általában közös igazítással és térközrel.
DocumentPhoneNumberField	Egy documentField, amelynek telefonszámértéke sztringként van jelölve.
DocumentSelectionMark	A jelölőnégyzeteket, választógombokat és a kijelölést jelző egyéb elemeket ábrázoló kijelölési objektum.
DocumentSelectionMarkField	Olyan Dokumentummező, amelynek értéke a kijelölési jelet jelző állapotot (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 tartalom tulajdonság egybefüggő régiója, amely eltolásként és hosszként van megadva.
DocumentStringField	Egy documentField, amelynek sztringértéke van.
DocumentStyle	Megfigyelt szövegstílusokat képviselő objektum.
DocumentTable	Táblázatobjektum, amely téglalap alakú elrendezésben elrendezett táblázatcellákból áll.
DocumentTableCell	Táblázatcellák 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 nyelvek esetében minden karakter saját szóként jelenik meg.
ErrorModel	Hibainformáció.
GetCopyAuthorizationOptions	A másolat lekérésének engedélyezési módszerének beállításai.
GetModelOptions	A modelladatok lekérésének lehetőségei.
GetOperationOptions	A műveletállapot lekérésének lehetőségei.
GetResourceDetailsOptions	A Form Recognizer erőforrás-információk lekérésének lehetőségei.
HasBoundingPolygon	Az egyszerű dokumentumelemeket, például a szavakat, a kijelölési jeleket és a vonalakat a sokszög határolja.
InnerError	Részletes hiba.
ListModelsOptions	Modellek listázásának lehetőségei.
ListOperationsOptions	Műveletek listázási lehetőségei.
ModelAdministrationOperationStateCommon	Az összes felügyeleti művelethez közös mezők halmaza.
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 "hüvelyk" (lásd : LengthUnit).
PollerOptions	A Form Recognizer-ügyfeleken futó hosszú ideig futó műveletek (lekérdezések) beállításai.
QuotaDetails	A felhasznált kvóta, a korlát és a következő alaphelyzetbe állítás dátuma/időpontja.
ResourceDetails	Az aktuális erőforrással kapcsolatos á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. A 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: Az ISO/IEC 18004:2015 szabványban meghatározott QR-kód. 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. Kód128: 128-as kód 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 Adatsáv kibontott vonalkódja. ITF: 2/5 vonalkód, az ANSI/AIM BC2-1995-ben meghatározottak szerint. MicroQRCode: Az ISO/IEC 23941:2022 szabványban meghatározott mikro QR-kód. 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. A KnownDocumentBuildMode felcserélhető a DocumentBuildMode szolgáltatással. 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 megcélzása. neurális: Változatos 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 fájlt.
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 típust DocumentField.
DocumentFieldType	A DocumentFieldType értékeit határozza meg. A KnownDocumentFieldType felcserélhető a DocumentFieldType 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 sztring: Egyszerű szöveg. dátum: Dátum, iso 8601 (ÉÉÉÉÉÉ-HH-DD) formátumra normalizálva. time: Time, normalizált ISO 8601 (hh:mm:ss) formátumra. phoneNumber: E.164(+{CountryCode}{SubscriberNumber}) formátumra normalizált telefonszám. 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ás: Jelen van az aláírás? tömb: Az azonos típusú almezők listája. object: A potenciálisan különböző típusú almezők nevesített listája. pénznem: Pénznem összege választható pénznemszimbólummal és egységgel. address: Elemzési cím. logikai: Logikai érték, igaz vagy hamis értékre normalizálva.
DocumentFormulaKind	A DocumentFormulaKind értékeit határozza meg. A KnownDocumentFormulaKind felcserélhető a DocumentFormulaKind szolgáltatással, 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: Bekezdés tartalmába ágyazott képlet. display: Egy képlet megjelenítési módban, amely egy teljes sort foglal el.
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 következő lehetőségek közül választhat: "neurális", amely a legmagasabb minőségű modellt biztosítja, amely képes adatokat kinyerni az azonos adatstruktúrával rendelkező dokumentumosztályokból, de különböző elrendezésekkel (például W2 adóű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 az alábbi 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 DocumentModelDetailst.
DocumentModelSource	Dokumentummodell létrehozásához használható tartalomforrás. Az alábbiak egyike: BlobSource BlobFileListSource
DocumentSignatureType	A DocumentSignatureType értékeit határozza meg. A 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. unsigned: A rendszer nem észlel aláírásokat.
DocumentTableCellKind	A DocumentTableCellKind értékeit határozza meg. A KnownDocumentTableCellKind felcserélhető a DocumentTableCellKind szolgáltatással, 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 content: 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észei) tartalmát ismerteti.
FontStyle	A FontStyle értékeit határozza meg. Az KnownFontStyle felcserélhető a FontStyle-tal, 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 normal: A karaktereket a rendszer normál módon jeleníti meg. dőlt: A karakterek vizuálisan jobbra vannak húzva.
FontWeight	A FontWeight értékeit határozza meg. Az KnownFontWeight felcserélhető a FontWeight paraméterrel, 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 normal: A karaktereket a rendszer normál módon jeleníti 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 Recognizer 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	A kérés bemenete, amely bináris adatként tölthető fel a Form Recognizer szolgáltatásba. Form Recognizer a bemeneteket string URL-címként kezeli, így a sztring bináris bemenetként való elküldéséhez először konvertálja a sztringet az alábbi bemeneti típusok egyikére.
LengthUnit	A LengthUnit értékeit határozza meg. Az 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éppont: 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. A KnownOperationKind felcserélhető az OperationKind szolgáltatással, 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: Hozzon létre egy új egyéni dokumentummodellt a 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. Az KnownParagraphRole felcserélhető a ParagraphRole-nal, 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. title: 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 egy blokkja, gyakran közös igazítással.
SelectionMarkState	A SelectionMarkState értékeit határozza meg. Az KnownSelectionMarkState felcserélhető a SelectionMarkState-nal, 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 kiválasztva: A kijelölési jel ki van jelölve, amelyet gyakran egy ✓ vagy x kereszt jelez a kijelölési jelen belül. nincs kijelölve: A kijelölési jel nincs kijelölve.
StringIndexType	Az Form Recognizer szolgáltatás és az SDK-ügyfelek által támogatott érvényes sztringindex-típusok.

Enumerációk

KnownDocumentBarcodeKind	A DocumentBarcodeKind ismert értékei, amelyeket a szolgáltatás elfogad.
KnownDocumentBuildMode	A DocumentBuildMode ismert értékei, amelyeket a szolgáltatás elfogad.
KnownDocumentFieldType	A DocumentFieldType ismert értékei, amelyeket a szolgáltatás elfogad.
KnownDocumentFormulaKind	A DocumentFormulaKind ismert értékei, amelyeket a szolgáltatás elfogad.
KnownDocumentSignatureType	A DocumentSignatureType ismert értékei, amelyeket a szolgáltatás elfogad.
KnownDocumentTableCellKind	A DocumentTableCellKind ismert értékei, amelyeket a szolgáltatás elfogad.
KnownFontStyle	A szolgáltatás által elfogadott FontStyle ismert értékei.
KnownFontWeight	A szolgáltatás által elfogadott FontWeight ismert értékei.
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.