@azure/ai-form-recognizer package

Klasy

AzureKeyCredential	Poświadczenie oparte na kluczu statycznym, które obsługuje aktualizowanie bazowej wartości klucza.
DocumentAnalysisClient	Klient do interakcji z funkcjami analizy usługi Rozpoznawanie formularzy. Przykłady: Usługa rozpoznawania formularzy i klienci obsługują dwa sposoby uwierzytelniania: 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); Klucz interfejsu API (klucz subskrypcji) 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 do interakcji z funkcjami zarządzania modelami usługi Rozpoznawanie formularzy, takimi jak tworzenie, odczytywanie, wyświetlanie listy, usuwanie i kopiowanie modeli. Przykłady: 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); Klucz interfejsu API (klucz subskrypcji) 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);

Interfejsy

AddressValue	Wartość pola adresu.
AnalyzeDocumentOptions	Opcje operacji analizy dokumentu.
AnalyzeResult	Wynik operacji analizy. Typ dokumentu może być określany przez model używany do przeprowadzania analizy.
AnalyzeResultCommon	Typowe pola wszystkich typów podobnych do AnalyzeResult, takich jak LayoutResult, ReadResult i GeneralDocumentResult.
AnalyzedDocument	Wyodrębniony obiekt dokumentu. Element AnalyzedDocument jest wystąpieniem jednego z typów dokumentów w modelu. Jego pola odpowiadają schematowi pola typu dokumentu.
AzureBlobFileListSource	Źródło danych trenowania zdefiniowane przez kontener obiektów blob platformy Azure i listę plików JSONL w kontenerze.
AzureBlobFileListSourceDetails	Lista plików w usłudze Azure Blob Storage.
AzureBlobSource	Źródło danych trenowania zdefiniowane przez kontener obiektów blob platformy Azure.
AzureBlobSourceDetails	Zawartość usługi Azure Blob Storage.
BeginBuildDocumentClassifierOptions	Opcje operacji kompilacji klasyfikatora dokumentów.
BeginBuildDocumentModelOptions	Opcje operacji kompilacji modelu.
BeginComposeDocumentModelOptions	Opcje operacji redagowania modelu.
BeginCopyModelOptions	Opcje operacji kopiowania modelu.
BoundingRegion	Wiązanie wielokąta na określonej stronie danych wejściowych.
ClassifierDocumentTypeDetails	Informacje o typie dokumentu klasyfikatora.
ClassifyDocumentOptions	Opcje operacji klasyfikacji dokumentów.
CommonModelCreationOptions	Opcje wspólne dla wszystkich operacji definiujących nowe modele, takie jak beginBuildDocumentModel, beginComposeDocumentModeli getCopyAuthorization.
CopyAuthorization	Autoryzacja kopiowania modelu dokumentu do określonego zasobu docelowego i identyfikatora modelId.
CreateDocumentModelOptions	Opcje operacji tworzenia modelu.
CurrencyValue	Wartość pola waluty.
CustomDocumentModelsDetails	Szczegóły dotyczące niestandardowych modeli dokumentów.
DeleteDocumentModelOptions	Opcje usuwania modelu.
DocumentAddressField	Pole dokumentu opisujące ustrukturyzowany adres fizyczny.
DocumentAnalysisClientOptions	Konfigurowalne opcje dla elementu DocumentAnalysisClient.
DocumentAnalysisPollOperationState	Stan operacji analizy, która ostatecznie spowoduje wygenerowanie typu wyniku odpowiadającego modelowi.
DocumentAnnotation	Element adnotacji wizualizacji w dokumencie, taki jak znacznik wyboru lub krzyż.
DocumentArrayField	Pole dokumentu składające się z tablicy zagnieżdżonych pól. Wszystkie pola w tablicy będą miały ten sam typ.
DocumentBarcode	Wyodrębniony kod kreskowy.
DocumentBooleanField	Pole dokumentu, które ma wartość logiczną.
DocumentCaption	Obiekt reprezentujący lokalizację i zawartość podpisu tabeli.
DocumentClassifierBuildOperationDetails	Pobierz obiekt odpowiedzi Operacji.
DocumentClassifierDetails	Informacje klasyfikatora dokumentów.
DocumentClassifierDocumentTypeSources	Zestaw źródeł używany do tworzenia klasyfikatora dokumentów. Jest to mapa nazw typów dokumentów do źródeł, które będą używane do trenowania modelu w celu klasyfikowania dokumentów odpowiedniego typu źródłowego.
DocumentClassifierOperationState	Stan operacji tworzenia modelu.
DocumentCountryRegionField	Pole dokumentu z wartością wskazującą kraj lub region reprezentowane jako ciąg.
DocumentCurrencyField	Pole dokumentu, które opisuje kwotę określonej waluty.
DocumentDateField	Pole dokumentu, które ma wartość Date.
DocumentFieldCommon	Pola wspólne dla wszystkich wariantów DocumentField.
DocumentFieldSchema	Opis schematu semantycznego pola przy użyciu składni stylu schematu JSON.
DocumentFootnote	Obiekt reprezentujący lokalizację i zawartość przypisu dolnego tabeli.
DocumentFormula	Wyodrębniona formuła.
DocumentIntegerField	Pole dokumentu, które ma wartość całkowitą.
DocumentKeyValueElement	Obiekt reprezentujący klucz pola lub wartość w parze klucz-wartość.
DocumentKeyValuePair	Obiekt reprezentujący pole formularza z unikatową etykietą pola (klucz) i wartością pola (może być pusta).
DocumentLanguage	Obiekt reprezentujący wykryty język dla danego zakresu tekstu.
DocumentLine	Obiekt wiersza zawartości składający się z sąsiedniej sekwencji elementów zawartości, takich jak wyrazy i znaczniki zaznaczenia.
DocumentModel	Dobrze znana specyfikacja modelu, która obsługuje wyodrębnianie dokumentów strukturalnych. Zobacz beginAnalyzeDocument metodę DocumentAnalysisClient, która obsługuje używanie tych obiektów DocumentModel zamiast ciągów identyfikatorów modelu w celu zapewnienia silniejszych typów wyników.
DocumentModelAdministrationClientOptions	Konfigurowalne opcje dla klasy DocumentModelAdministrationClient.
DocumentModelBuildOperationDetails	Pobierz obiekt odpowiedzi Operacji.
DocumentModelComposeOperationDetails	Pobierz obiekt odpowiedzi Operacji.
DocumentModelCopyToOperationDetails	Pobierz obiekt odpowiedzi Operacji.
DocumentModelDetails	Informacje o modelu dokumentu.
DocumentModelOperationState	Stan operacji tworzenia modelu.
DocumentModelSummary	Podsumowanie modelu dokumentu.
DocumentNumberField	Pole dokumentu, które ma wartość liczbową.
DocumentObjectField	Pole documentfield składające się z kilku nazwanych właściwości, które mają własne wartości DocumentField.
DocumentPage	Elementy zawartości i układu wyodrębnione ze strony z danych wejściowych.
DocumentParagraph	Obiekt akapitu składający się z ciągłych linii zwykle ze wspólnym wyrównaniem i odstępami.
DocumentPhoneNumberField	Pole dokumentu, które ma wartość numeru telefonu, reprezentowane jako ciąg.
DocumentSelectionMark	Obiekt zaznaczenia reprezentujący pola wyboru, przyciski radiowe i inne elementy wskazujące zaznaczenie.
DocumentSelectionMarkField	Pole dokumentu, które ma wartość wskazującą stan znacznika zaznaczenia (na przykład pole wyboru lub przycisk radiowy), reprezentowane jako ciąg.
DocumentSignatureField	Pole dokumentu wskazujące stan podpisu reprezentowane jako ciąg.
DocumentSpan	Ciągły region połączonej właściwości zawartości określony jako przesunięcie i długość.
DocumentStringField	Pole dokumentu, które ma wartość ciągu.
DocumentStyle	Obiekt reprezentujący obserwowane style tekstu.
DocumentTable	Obiekt tabeli składający się z komórek tabeli rozmieszczony w układzie prostokątnym.
DocumentTableCell	Obiekt reprezentujący lokalizację i zawartość komórki tabeli.
DocumentTimeField	Pole dokumentu, które ma wartość czasu, reprezentowane jako ciąg.
DocumentTypeDetails	Informacje o typie dokumentu.
DocumentValueField	Proste pole, które ma wartość pierwotną, takie jak ciąg, liczba itp.
DocumentWord	Obiekt wyrazu składający się z ciągłej sekwencji znaków. W przypadku języków rozdzielanych spacjami, takich jak chiński, japoński i koreański, każdy znak jest reprezentowany jako własny wyraz.
ErrorModel	Informacje o błędzie.
GetCopyAuthorizationOptions	Opcje metody uzyskiwania autoryzacji kopiowania.
GetModelOptions	Opcje pobierania informacji o modelu.
GetOperationOptions	Opcje pobierania stanu operacji.
GetResourceDetailsOptions	Opcje pobierania informacji o zasobie rozpoznawania formularzy.
HasBoundingPolygon	Proste elementy dokumentu, takie jak wyrazy, znaczniki zaznaczenia i linie, są ograniczone przez wielokąt.
InnerError	Szczegółowy błąd.
ListModelsOptions	Opcje wyświetlania listy modeli.
ListOperationsOptions	Opcje wyświetlania listy operacji.
ModelAdministrationOperationStateCommon	Zestaw pól wspólnych dla wszystkich operacji administracyjnych.
OperationDetails	Pobierz obiekt odpowiedzi Operacji.
OperationSummary	Informacje o operacji.
Point2D	Reprezentuje punkt używany do definiowania wielokątów granic. Jednostka jest "piksel" lub "cal" (zobacz LengthUnit).
PollerOptions	Opcje długotrwałych operacji (sondatorów) w klientach rozpoznawania formularzy.
QuotaDetails	Używany limit przydziału, limit i kolejna data/godzina resetowania.
ResourceDetails	Ogólne informacje dotyczące bieżącego zasobu.

Aliasy typu

AnalysisPoller	Długotrwała operacja (poller), która śledzi stan operacji analizy, ostatecznie generując typ wyniku odpowiadający modelowi.
AnalyzeResultOperationStatus	Definiuje wartości elementu AnalyzeResultOperationStatus.
DocumentBarcodeKind	Definiuje wartości documentBarcodeKind. KnownDocumentBarcodeKind można używać zamiennie z elementem DocumentBarcodeKind, wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę kod QRCode: kod QR, zgodnie z definicją w normie ISO/IEC 18004:2015. PDF417: PDF417 zgodnie z definicją w standardzie ISO 15438. UPCA: GS1 12-cyfrowy kod uniwersalnego produktu. UPCE: GS1 6-cyfrowy kod uniwersalnego produktu. Code39: kod kreskowy 39, zgodnie z definicją w normie ISO/IEC 16388:2007. Code128: Kod kreskowy 128, zgodnie z definicją w normie ISO/IEC 15417:2007. EAN8: 8-cyfrowy numer artykułu międzynarodowego GS1 (numer artykułu europejskiego). EAN13: GS1 13-cyfrowy numer artykułu międzynarodowego (europejski numer artykułu). DataBar: kod kreskowy GS1 DataBar. Code93: Kod kreskowy 93, zgodnie z definicją w ANSI/AIM BC5-1995. Codabar: Kod kreskowy Codabar, zgodnie z definicją w ANSI/AIM BC3-1995. DataBarExpanded: rozszerzony kod kreskowy paska danych GS1. ITF: Przeplatane 2 z 5 kodów kreskowych zgodnie z definicją w ANSI/AIM BC2-1995. MicroQRCode: Kod Micro QR zdefiniowany w normie ISO/IEC 23941:2022. Aztec: kod Aztec, zgodnie z definicją w normie ISO/IEC 24778:2008. DataMatrix: kod macierzy danych zgodnie z definicją w normie ISO/IEC 16022:2006. MaxiCode: MaxiCode zgodnie z definicją w normie ISO/IEC 16023:2000.
DocumentBuildMode	Definiuje wartości dla elementu DocumentBuildMode. KnownDocumentBuildMode można używać zamiennie z modułem DocumentBuildMode, wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę szablonu: dokumenty docelowe z podobnymi szablonami wizualizacji. neuronowych: obsługa dokumentów przy użyciu różnych szablonów wizualnych.
DocumentClassifierPoller	Długotrwała operacja (poller), która śledzi stan operacji tworzenia klasyfikatora niestandardowego, ostatecznie tworząc DocumentClassifierDetails.
DocumentClassifierSource	Źródło zawartości, które może służyć do tworzenia klasyfikatora dokumentów. Jeden z: BlobSource BlobFileListSource
DocumentField	Wyodrębnione pole. Właściwość kind identyfikuje (dyskryminuje) typ DocumentField.
DocumentFieldType	Definiuje wartości typu DocumentFieldType. KnownDocumentFieldType można używać zamiennie z parametrem DocumentFieldType, wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę ciąg: zwykły tekst. data: data, znormalizowana do formatu ISO 8601 (RRRR-MM-DD). czas: czas, znormalizowany do formatu ISO 8601 (hh:mm:ss). numer telefonu: numer telefonu, znormalizowany do formatu E.164 (+{CountryCode}{SubscriberNumber}). liczba: liczba zmiennoprzecinkowa znormalizowana do podwójnej precyzji zmiennoprzecinkowa. liczba całkowita: liczba całkowita znormalizowana do 64-bitowej liczby całkowitej ze znakiem. zaznaczeniaZnak: Czy wybrano pole? krajRegion: kraj/region, znormalizowany do formatu ISO 3166-1 alfa-3 (np. USA). podpis: czy jest obecny podpis? tablicy: lista pól podrzędnych tego samego typu. obiekt: nazwana lista pól podrzędnych potencjalnie różnych typów. waluty: kwota waluty z opcjonalnym symbolem waluty i jednostką. adres: przeanalizowany adres. wartość logiczna: wartość logiczna, znormalizowana do wartości true lub false.
DocumentFormulaKind	Definiuje wartości dla elementu DocumentFormulaKind. KnownDocumentFormulaKind można używać zamiennie z documentFormulaKind, wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę wbudowane: formuła osadzona w treści akapitu. wyświetlania: formuła w trybie wyświetlania, który zajmuje cały wiersz.
DocumentModelBuildMode	Obsługiwane tryby kompilacji modelu. Tryb kompilacji modelu wybiera aparat używany przez usługę do trenowania modelu na podstawie oznaczonych danych treningowych. Dostępne są następujące opcje: "neuronowe", które daje najwyższą jakość modelu, który może wyodrębniać dane z klas dokumentów, które mają taką samą strukturę danych, ale różne układy (na przykład formularze podatkowe W2, które mogą się różnić od firmy do firmy, ale zawsze zawierają te same informacje). "template", który wymaga, aby wszystkie dokumenty miały ten sam stały układ (szablon). Aby uzyskać więcej informacji, zobacz następujący link: https://aka.ms/azsdk/formrecognizer/buildmode
DocumentModelPoller	Długotrwała operacja (poller), która śledzi stan operacji tworzenia modelu, ostatecznie tworząc DocumentModelDetails.
DocumentModelSource	Źródło zawartości, które może służyć do tworzenia modelu dokumentu. Jeden z: BlobSource BlobFileListSource
DocumentSignatureType	Definiuje wartości typu DocumentSignatureType. KnownDocumentSignatureType można używać zamiennie z parametrem DocumentSignatureType, wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę podpisanych: wykryto podpis. niepodpisane: nie wykryto podpisów.
DocumentTableCellKind	Definiuje wartości documentTableCellKind. KnownDocumentTableCellKind można używać zamiennie z elementem DocumentTableCellKind, wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę zawartości: zawiera główną zawartość/dane. rowHeader: opisuje zawartość wiersza. kolumnaHeader: opisuje zawartość kolumny. stubHead : opisuje nagłówki wierszy, zwykle znajdujące się w lewym górnym rogu tabeli. opis: opisuje zawartość w (częściach) tabeli.
FontStyle	Definiuje wartości dla fontstyle. KnownFontStyle można używać zamiennie z funkcją FontStyle, wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę normalnych: znaki są reprezentowane normalnie. kursywa: Znaki są wizualnie skośne po prawej stronie.
FontWeight	Definiuje wartości dla fontweight. KnownFontWeight można używać zamiennie z czcionką, wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę normalnych: znaki są reprezentowane normalnie. pogrubioną: Znaki są reprezentowane z grubszymi pociągnięciami.
FormRecognizerFeature	Możliwości dodatków (funkcje), które można włączyć dla żądania. Aby uzyskać więcej informacji na temat funkcji dostępnych w rozpoznawaniu formularzy, zobacz dokumentację usługi: https://aka.ms/azsdk/formrecognizer/features
FormRecognizerRequestBody	Dane wejściowe żądania, które można przekazać jako dane binarne do usługi Rozpoznawanie formularzy. Rozpoznawanie formularzy traktuje string danych wejściowych jako adresy URL, dlatego aby wysłać ciąg jako dane wejściowe binarne, najpierw przekonwertuj ciąg na jeden z następujących typów danych wejściowych.
LengthUnit	Definiuje wartości parametru LengthUnit. KnownLengthUnit można używać zamiennie z parametrem LengthUnit, wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę pikseli: jednostka długości dla plików obrazów. cal: jednostka długości plików PDF.
OperationDetailsUnion	Szczegółowe informacje o kilku różnych typach operacji zarządzania rozpoznawaniem formularzy.
OperationKind	Definiuje wartości elementu OperationKind. KnownOperationKind można używać zamiennie z operacją OperationKind, wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę documentModelBuild: tworzenie nowego niestandardowego modelu dokumentów. documentModelCompose: tworzenie nowego niestandardowego modelu dokumentów na podstawie istniejących modeli. documentModelCopyTo: skopiuj istniejący model dokumentu do potencjalnie innego zasobu, regionu lub subskrypcji. documentClassifierBuild: Tworzenie nowego niestandardowego modelu klasyfikatora.
OperationStatus	Definiuje wartości elementu OperationStatus.
ParagraphRole	Definiuje wartości elementu ParagraphRole. KnownParagraphRole można używać zamiennie z elementem ParagraphRole, wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę pageHeader: tekst w górnej krawędzi strony. pageFooter: Tekst w dolnej krawędzi strony. pageNumber: numer strony. tytuł: tytuł najwyższego poziomu opisujący cały dokument. sekcjiHeading: nagłówek podrzędny opisujący sekcję dokumentu. przypis dolny: uwaga zwykle umieszczana po głównej zawartości na stronie. formułaBlock: blok formuł, często ze współdzieloną wyrównaniem.
SelectionMarkState	Definiuje wartości parametru SelectionMarkState. KnownSelectionMarkState można używać zamiennie z elementem SelectionMarkState, wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę zaznaczone: zaznaczony jest znacznik wyboru, często wskazywany przez znacznik wyboru — lub krzyż X wewnątrz znacznika zaznaczenia. niezaznaczone: znacznik wyboru nie jest zaznaczony.
StringIndexType	Prawidłowe typy indeksów ciągów obsługiwane przez klientów usługi rozpoznawania formularzy i zestawu SDK.

Wyliczenia

KnownDocumentBarcodeKind	Znane wartości DocumentBarcodeKind akceptowane przez usługę.
KnownDocumentBuildMode	Znane wartości DocumentBuildMode akceptowane przez usługę.
KnownDocumentFieldType	Znane wartości DocumentFieldType akceptowane przez usługę.
KnownDocumentFormulaKind	Znane wartości DocumentFormulaKind akceptowane przez usługę.
KnownDocumentSignatureType	Znane wartości DocumentSignatureType akceptowane przez usługę.
KnownDocumentTableCellKind	Znane wartości DocumentTableCellKind akceptowane przez usługę.
KnownFontStyle	Znane wartości FontStyle akceptowane przez usługę.
KnownFontWeight	Znane wartości FontWeight akceptowane przez usługę.
KnownLengthUnit	Znane wartości LengthUnit akceptowane przez usługę.
KnownOperationKind	Znane wartości OperationKind akceptowane przez usługę.
KnownParagraphRole	Znane wartości ParagraphRole, które akceptuje usługa.
KnownSelectionMarkState	Znane wartości SelectionMarkState akceptowane przez usługę.