@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 Form Recognizer. Przykłady: Usługa Form Recognizer 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 Form Recognizer, 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 dokumentów.
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 szkoleniowych zdefiniowane przez kontener obiektów blob platformy Azure i listę plików JSONL w kontenerze.
AzureBlobFileListSourceDetails	Lista plików w Azure Blob Storage.
AzureBlobSource	Źródło danych trenowania zdefiniowane przez kontener obiektów blob platformy Azure.
AzureBlobSourceDetails	Azure Blob Storage zawartości.
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 do 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ść tabeli podpis.
DocumentClassifierBuildOperationDetails	Pobierz obiekt odpowiedzi Operation.
DocumentClassifierDetails	Informacje o klasyfikatorze dokumentu.
DocumentClassifierDocumentTypeSources	Zestaw źródeł używanych 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, które ma wartość wskazującą kraj lub region, reprezentowane jako ciąg.
DocumentCurrencyField	Pole dokumentu opisujące 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ć pusty).
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 metodę beginAnalyzeDocumentDocumentAnalysisClient, która obsługuje używanie tych DocumentModel obiektów zamiast ciągów identyfikatorów modelu, aby zapewnić silniejsze typy wyników.
DocumentModelAdministrationClientOptions	Opcje konfigurowalne dla klasy DocumentModelAdministrationClient.
DocumentModelBuildOperationDetails	Pobierz obiekt odpowiedzi Operation.
DocumentModelComposeOperationDetails	Pobierz obiekt odpowiedzi Operation.
DocumentModelCopyToOperationDetails	Pobierz obiekt odpowiedzi Operation.
DocumentModelDetails	Informacje o modelu dokumentu.
DocumentModelOperationState	Stan operacji tworzenia modelu.
DocumentModelSummary	Podsumowanie modelu dokumentu.
DocumentNumberField	Pole dokumentu, które ma wartość liczbową.
DocumentObjectField	Pole dokumentu 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 znacznika wyboru reprezentujący pola wyboru, przyciski radiowe i inne elementy wskazujące zaznaczenie.
DocumentSelectionMarkField	Pole dokumentu, które ma wartość wskazującą stan znacznika wyboru (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 rozmieszczonych w układzie prostokątnym.
DocumentTableCell	Obiekt reprezentujący lokalizację i zawartość komórki tabeli.
DocumentTimeField	Pole dokumentu, które ma wartość czasu reprezentowaną 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 zasobach Form Recognizer.
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 powiązanych. Jednostka jest "piksel" lub "cal" (zobacz LengthUnit).
PollerOptions	Opcje długotrwałych operacji (sondatorów) w klientach Form Recognizer.
QuotaDetails	Użyto limitu przydziału, limitu i następnego resetowania daty/godziny.
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 parametru AnalyzeResultOperationStatus.
DocumentBarcodeKind	Definiuje wartości elementu DocumentBarcodeKind. KnownDocumentBarcodeKind można używać zamiennie z documentBarcodeKind. To wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę KOD QR: kod QR zdefiniowany 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. Kod128: Kod kreskowy 128, zgodnie z definicją w normie ISO/IEC 15417:2007. EAN8: GS1 8-cyfrowy numer artykułu międzynarodowego (numer artykułu europejskiego). EAN13: GS1 13-cyfrowy numer artykułu międzynarodowego (numer artykułu europejskiego). 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: rozwinięty kod kreskowy GS1 DataBar. ITF: Przeplatane 2 z 5 kodów kreskowych, zgodnie z definicją w ANSI/AIM BC2-1995. MicroQRCode: Kod Mikro QR zdefiniowany w normie ISO/IEC 23941:2022. Aztec: kod Aztec, zgodnie z definicją w normie ISO/IEC 24778:2008. DataMatrix: kod macierzy danych zdefiniowany w normie ISO/IEC 16022:2006. MaxiCode: MaxiCode, zgodnie z definicją w normie ISO/IEC 16023:2000.
DocumentBuildMode	Definiuje wartości dla elementu DocumentBuildMode. Element KnownDocumentBuildMode może być używany zamiennie z trybem DocumentBuildMode. To wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę szablon: Dokumenty docelowe z podobnymi szablonami wizualnymi. neuronowe: obsługa dokumentów z różnymi szablonami wizualnymi.
DocumentClassifierPoller	Długotrwała operacja (poller), która śledzi stan operacji tworzenia klasyfikatora niestandardowego, ostatecznie tworząc element 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. ZnaneDokumentFieldType można używać zamiennie z documentFieldType. To 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). time: Czas, znormalizowany do formatu ISO 8601 (hh:mm:ss). phoneNumber: numer telefonu, znormalizowany do formatu E.164 (+{CountryCode}{Numer subskrybenta}). liczba: liczba zmiennoprzecinkowa, znormalizowana do podwójnej precyzji zmiennoprzecinkowa. Liczba całkowita: liczba całkowita, znormalizowana do 64-bitowej liczby całkowitej ze znakiem. selectionMark: czy pole jest zaznaczone? countryRegion: Kraj/region, znormalizowany do formatu ISO 3166-1 alfa-3 (np. USA). podpis: Czy podpis jest obecny? array: Lista pól podrzędnych tego samego typu. object: nazwana lista pól podrzędnych potencjalnie różnych typów. waluta: 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 elementu DocumentFormulaKind. ZnaneDokumentFormulaKind można używać zamiennie z documentFormulaKind. To wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę wbudowany: formuła osadzona w treści akapitu. display: formuła w trybie wyświetlania, która 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 danych treningowych oznaczonych etykietami. Dostępne opcje to: "neuronowy", który 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ą różnić się 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 element 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 parametru DocumentSignatureType. ZnaneDokumentSignatureType można używać zamiennie z parametrem DocumentSignatureType. To wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę podpisany: wykryto podpis. niepodpisane: nie wykryto podpisów.
DocumentTableCellKind	Definiuje wartości elementu DocumentTableCellKind. ZnaneDocumentTableCellKind można używać zamiennie z documentTableCellKind. To wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę zawartość: zawiera główną zawartość/dane. rowHeader: opisuje zawartość wiersza. columnHeader: opisuje zawartość kolumny. stubHead: opisuje nagłówki wierszy, zwykle znajdujące się w lewym górnym rogu tabeli. description: Opisuje zawartość tabeli (części).
FontStyle	Definiuje wartości fontstyle. ZnanyfontStyle może być używany zamiennie z FontStyle. To wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę normalny: znaki są reprezentowane normalnie. kursywa: znaki są wizualnie pochylone po prawej stronie.
FontWeight	Definiuje wartości dla opcji FontWeight. Wartość KnownFontWeight może być używana zamiennie z funkcją FontWeight. To wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę normalny: znaki są reprezentowane normalnie. pogrubienie: znaki są reprezentowane za pomocą grubszych pociągnięć.
FormRecognizerFeature	Możliwości dodatku (funkcje), które można włączyć dla żądania. Aby uzyskać więcej informacji na temat funkcji dostępnych w Form Recognizer, 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 Form Recognizer. Form Recognizer traktuje string dane wejściowe jako adresy URL, więc 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. ZnaneLengthUnit można używać zamiennie z parametrem LengthUnit. To wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę piksel: jednostka długości dla plików obrazów. cal: jednostka długości plików PDF.
OperationDetailsUnion	Szczegółowe informacje o różnych typach operacji zarządzania Form Recognizer.
OperationKind	Definiuje wartości elementu OperationKind. ZnaneOperationKind można używać zamiennie z operacją OperationKind. To 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: utwórz nowy niestandardowy model dokumentów z istniejących modeli. documentModelCopyTo: skopiuj istniejący model dokumentów do potencjalnie innego zasobu, regionu lub subskrypcji. documentClassifierBuild: tworzenie nowego niestandardowego modelu klasyfikatora.
OperationStatus	Definiuje wartości elementu OperationStatus.
ParagraphRole	Definiuje wartości dla elementu AkapitRole. ZnaneParagraphRole można używać zamiennie z AkapitRole. To wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę pageHeader: tekst w górnej części strony. pageFooter: Tekst w dolnej krawędzi strony. pageNumber: numer strony. title: tytuł najwyższego poziomu opisujący cały dokument. sectionHeading: Nagłówek podrzędny opisujący sekcję dokumentu. przypis dolny: Uwaga zwykle umieszczana po głównej zawartości na stronie. formulaBlock: blok formuł, często z udostępnionym wyrównaniem.
SelectionMarkState	Definiuje wartości SelectionMarkState. Funkcja KnownSelectionMarkState może być używana zamiennie z elementem SelectionMarkState. To wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę zaznaczony: zaznaczony jest znacznik wyboru, często wskazywany przez znacznik wyboru — lub krzyż X wewnątrz znacznika wyboru. niezaznaczone: znacznik wyboru nie jest zaznaczony.
StringIndexType	Prawidłowe typy indeksów ciągów obsługiwane przez klientów usługi Form Recognizer 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 elementu OperationKind akceptowane przez usługę.
KnownParagraphRole	Znane wartości elementu ParagraphRole akceptowane przez usługę.
KnownSelectionMarkState	Znane wartości SelectionMarkState akceptowane przez usługę.