formrecognizer Pakiet

Pakiety

aio

Klasy

AccountProperties	Podsumowanie wszystkich modeli niestandardowych na koncie. Nowość w wersji 2.1: obsługa metod to_dict i from_dict
AddressValue	Wartość pola adresu. Nowość w wersji 2023-07-31: Jednostka, city_district, state_district, przedmieścia, dom i nieruchomości na poziomie .
AnalyzeResult	Wynik analizy dokumentu.
AnalyzedDocument	Obiekt opisujący lokalizację i semantyczną zawartość dokumentu.
BlobFileListSource	Źródło zawartości listy plików w Azure Blob Storage.
BlobSource	Źródło zawartości dla Azure Blob Storage.
BoundingRegion	Region ograniczenia odpowiadający stronie.
ClassifierDocumentTypeDetails	Trenowanie źródła danych.
CurrencyValue	Element wartości waluty. Nowość w wersji 2023-07-31: właściwość code .
CustomDocumentModelsDetails	Szczegóły dotyczące modeli niestandardowych w ramach zasobu Form Recognizer.
CustomFormModel	Reprezentuje wytrenowany model. Nowość w wersji 2.1: właściwości model_name i właściwości, obsługa metod to_dict i from_dict
CustomFormModelField	Pole wyodrębnione przez model z formularzy, które analizuje. Nowość w wersji 2.1: obsługa metod to_dict i from_dict
CustomFormModelInfo	Informacje o modelu niestandardowym. Nowość w wersji 2.1: właściwości model_name i właściwości, obsługa metod to_dict i from_dict
CustomFormModelProperties	Opcjonalne właściwości modelu. Nowość w wersji 2.1: obsługa metod to_dict i from_dict
CustomFormSubmodel	Reprezentuje model podrzędny, który wyodrębnia pola z określonego typu formularza. Nowość w wersji 2.1: właściwość model_id, obsługa metod to_dict i from_dict
DocumentAnalysisClient	DocumentAnalysisClient analizuje informacje z dokumentów i obrazów oraz klasyfikuje dokumenty. Jest to interfejs używany do analizowania przy użyciu wstępnie utworzonych modeli (paragony, wizytówki, faktury, dokumenty tożsamości, między innymi), analizowanie układu z dokumentów, analizowanie ogólnych typów dokumentów i analizowanie dokumentów niestandardowych za pomocą modeli utworzonych (aby wyświetlić pełną listę modeli obsługiwanych przez usługę, zobacz: https://aka.ms/azsdk/formrecognizer/models). Udostępnia ona różne metody na podstawie danych wejściowych z adresu URL i danych wejściowych ze strumienia. Uwaga Obiekt DocumentAnalysisClient powinien być używany z wersjami interfejsu API 2022-08-31 i nowszy. Aby użyć wersji <interfejsu API =v2.1, utwórz wystąpienie obiektu FormRecognizerClient. Nowość w wersji 2022-08-31: DocumentAnalysisClient i jego metody klienckie.
DocumentAnalysisError	Błąd DocumentAnalysisError zawiera szczegóły błędu zwróconego przez usługę.
DocumentAnalysisInnerError	Szczegóły błędu wewnętrznego dla błędu DocumentAnalysisError.
DocumentBarcode	Obiekt kodu kreskowego.
DocumentClassifierDetails	Informacje o klasyfikatorze dokumentu. Zawiera typy oświadczeń, które mogą klasyfikować model.
DocumentField	Obiekt reprezentujący zawartość i lokalizację wartości pola dokumentu. Nowość w wersji 2023-07-31: wartość logiczna value_type i wartość logiczna
DocumentFormula	Obiekt formuły.
DocumentKeyValueElement	Obiekt reprezentujący klucz pola lub wartość w parze klucz-wartość.
DocumentKeyValuePair	Obiekt reprezentujący pole dokumentu 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 reprezentujący zawartość znajdującą się w jednym wierszu dokumentu.
DocumentModelAdministrationClient	DocumentModelAdministrationClient to interfejs Form Recognizer używany do tworzenia modeli i zarządzania nimi. Udostępnia metody tworzenia modeli i klasyfikatorów, a także metody wyświetlania i usuwania modeli i klasyfikatorów, wyświetlania operacji modelu i klasyfikatora, uzyskiwania dostępu do informacji o koncie, kopiowania modeli do innego zasobu Form Recognizer i tworzenia nowego modelu z kolekcji istniejących modeli. Uwaga Element DocumentModelAdministrationClient powinien być używany z wersjami interfejsu API 2022-08-31 i nowszy. Aby użyć wersji <interfejsu API =v2.1, utwórz wystąpienie elementu FormTrainingClient. Nowość w wersji 2022-08-31: DocumentModelAdministrationClient i jego metody klienta.
DocumentModelAdministrationLROPoller	Implementuje protokół, po którym następuje zwracane obiekty poller.
DocumentModelDetails	Dokumentowanie informacji o modelu. Zawiera typy oświadczeń, które model może analizować. Nowość w wersji 2023-07-31: właściwość expires_on .
DocumentModelSummary	Podsumowanie informacji o modelu dokumentu, w tym identyfikator modelu, jego opis i czas utworzenia modelu. Nowość w wersji 2023-07-31: właściwość expires_on .
DocumentPage	Zawartość i elementy układu wyodrębnione ze strony danych wejściowych. Nowość w wersji 2023-07-31: właściwości kodów kreskowych i formuł .
DocumentParagraph	Obiekt akapitu zwykle składa się z ciągłych linii ze wspólnym wyrównaniem i odstępami. Nowość w wersji 2023-07-31: rola formulaBlock .
DocumentSelectionMark	Obiekt znacznika wyboru reprezentujący pola wyboru, przyciski radiowe i inne elementy wskazujące zaznaczenie.
DocumentSpan	Ciągły region zawartości właściwości określony jako przesunięcie i długość.
DocumentStyle	Obiekt reprezentujący obserwowane style tekstu. Nowość w wersji 2023-07-31: właściwości similar_font_family, font_style, font_weight, koloru i background_color .
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.
DocumentTypeDetails	DocumentTypeDetails reprezentuje typ dokumentu, który model może rozpoznać, w tym jego pola i typy, oraz pewność siebie dla tych pól.
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.
FieldData	Zawiera dane dla pola formularza. Obejmuje to tekst, lokalizację tekstu w formularzu oraz kolekcję elementów tworzących tekst. Nowość w wersji 2.1: element FormSelectionMark jest dodawany do typów zwracanych na liście field_elements, obsługi metod to_dict i from_dict
FormElement	Typ podstawowy, który zawiera właściwości elementu formularza. Nowość w wersji 2.1: obsługa metod to_dict i from_dict
FormField	Reprezentuje pole rozpoznane w formularzu wejściowym. Nowość w wersji 2.1: obsługa metod to_dict i from_dict
FormLine	Obiekt reprezentujący wyodrębniony wiersz tekstu. Nowość w wersji 2.1: właściwość wyglądu, obsługa metod to_dict i from_dict
FormPage	Reprezentuje stronę rozpoznaną z dokumentu wejściowego. Zawiera wiersze, wyrazy, znaczniki zaznaczenia, tabele i metadane strony. Nowość w wersji 2.1: właściwość selection_marks, obsługa metod to_dict i from_dict
FormPageRange	Zakres stron oparty na 1 formularzu. Nowość w wersji 2.1: obsługa metod to_dict i from_dict
FormRecognizerClient	FormRecognizerClient wyodrębnia informacje z formularzy i obrazów do danych strukturalnych. Jest to interfejs używany do analizowania za pomocą wstępnie utworzonych modeli (paragonów, wizytówek, faktur, dokumentów tożsamości), rozpoznawania zawartości/układu z formularzy i analizowania formularzy niestandardowych z wytrenowanych modeli. Udostępnia ona różne metody na podstawie danych wejściowych z adresu URL i danych wejściowych ze strumienia. Uwaga Obiekt FormRecognizerClient powinien być używany z wersjami <interfejsu API =v2.1. Aby użyć interfejsu API w wersji 2022-08-31 i nowszych, utwórz wystąpienie klasy DocumentAnalysisClient.
FormRecognizerError	Reprezentuje błąd, który wystąpił podczas trenowania. Nowość w wersji 2.1: obsługa metod to_dict i from_dict
FormSelectionMark	Informacje o wyodrębnionym znaczniku zaznaczenia. Nowość w wersji 2.1: obsługa metod to_dict i from_dict
FormTable	Informacje o wyodrębnionej tabeli zawartej na stronie. Nowość w wersji 2.1: właściwość bounding_box, obsługa metod to_dict i from_dict
FormTableCell	Reprezentuje komórkę zawartą w tabeli rozpoznawaną z dokumentu wejściowego. Nowość w wersji 2.1: Element FormSelectionMark jest dodawany do typów zwracanych na liście field_elements, obsługi metod to_dict i from_dict
FormTrainingClient	FormTrainingClient to interfejs Form Recognizer używany do tworzenia modeli niestandardowych i zarządzania nimi. Udostępnia metody trenowania modeli w formularzach, które udostępniasz, a także metody wyświetlania i usuwania modeli, uzyskiwania dostępu do właściwości konta, kopiowania modeli do innego zasobu Form Recognizer i tworzenia modeli z kolekcji istniejących modeli wyszkolonych za pomocą etykiet. Uwaga Obiekt FormTrainingClient powinien być używany z wersjami interfejsu <API =v2.1. Aby użyć interfejsu API w wersji 2022-08-31 i nowszej, utwórz wystąpienie elementu DocumentModelAdministrationClient.
FormWord	Reprezentuje wyraz rozpoznany z dokumentu wejściowego. Nowość w wersji 2.1: obsługa metod to_dict i from_dict
OperationDetails	OperacjaDetails zawiera informacje o operacji modelu, w tym wynik lub błąd operacji, jeśli została ukończona. Należy pamiętać, że informacje o operacji są utrwalane tylko przez 24 godziny. Jeśli operacja zakończyła się pomyślnie, można również uzyskać dostęp do modelu przy użyciu <xref:azure.ai.formrecognizer.get_document_model>interfejsów API , <xref:azure.ai.formrecognizer.list_document_models>, . <xref:azure.ai.formrecognizer.get_document_classifier><xref:azure.ai.formrecognizer.list_document_classifiers> Nowość w wersji 2023-07-31: wynik documentClassifierBuild i DocumentClassifierDetails .
OperationSummary	Informacje o operacji modelu, w tym rodzaj i stan operacji, kiedy została utworzona i nie tylko. Należy pamiętać, że informacje o operacji są utrwalane tylko przez 24 godziny. Jeśli operacja zakończyła się pomyślnie, można uzyskać dostęp do modelu przy użyciu <xref:azure.ai.formrecognizer.get_document_model>interfejsów API , <xref:azure.ai.formrecognizer.list_document_models>, . <xref:azure.ai.formrecognizer.get_document_classifier><xref:azure.ai.formrecognizer.list_document_classifiers> Aby dowiedzieć się, dlaczego operacja nie powiodła się, użyj <xref:azure.ai.formrecognizer.get_operation> i podaj operation_id. Nowość w wersji 2023-07-31: rodzaj documentClassifierBuild .
Point	Współrzędna x, y punktu na polu ograniczenia lub wielokącie. Nowość w wersji 2.1: obsługa metod to_dict i from_dict
QuotaDetails	Użyto limitu przydziału, limitu i następnego resetowania daty/godziny.
RecognizedForm	Reprezentuje formularz rozpoznany przez wytrenowany lub wstępnie utworzony model. Właściwość fields zawiera pola formularza, które zostały wyodrębnione z formularza. Tabele, wiersze tekstu/wyrazy i znaczniki zaznaczenia są wyodrębniane na stronę i znajdują się we właściwości pages . Nowość w wersji 2.1: właściwości form_type_confidence i model_id, obsługa metod to_dict i from_dict
ResourceDetails	Szczegóły dotyczące zasobu Form Recognizer. Nowość w wersji 2023-07-31: właściwość neural_document_model_quota .
TextAppearance	Obiekt reprezentujący wygląd wiersza tekstu. Nowość w wersji 2.1: obsługa metod to_dict i from_dict
TrainingDocumentInfo	Raport dla pojedynczego dokumentu używanego do trenowania modelu niestandardowego. Nowość w wersji 2.1: właściwość model_id, obsługa metod to_dict i from_dict

Wyliczenia

AnalysisFeature	Funkcje analizy dokumentów do włączenia.
CustomFormModelStatus	Stan wskazujący gotowość modelu do użycia.
DocumentAnalysisApiVersion	Form Recognizer wersje interfejsu API obsługiwane przez klasy DocumentAnalysisClient i DocumentModelAdministrationClient.
FieldValueType	Semantyczny typ danych wartości pola. Nowość w wersji 2.1: wartości selectionMark i countryRegion
FormContentType	Typ zawartości do przekazania. Nowość w wersji 2.1: obsługa obrazu/bmp
FormRecognizerApiVersion	Form Recognizer wersje interfejsu API obsługiwane przez formRecognizerClient i FormTrainingClient.
LengthUnit	Jednostka używana przez właściwości pola szerokości, wysokości i ograniczenia. W przypadku obrazów jednostka jest "piksel". W przypadku formatu PDF jednostka jest "cal".
ModelBuildMode	Tryb używany podczas tworzenia modeli niestandardowych. Aby uzyskać więcej informacji, zobacz https://aka.ms/azsdk/formrecognizer/buildmode.
TrainingStatus	Stan operacji trenowania.