Sdílet prostřednictvím


formrecognizer Balíček

Balíčky

aio

Třídy

AccountProperties

Souhrn všech vlastních modelů v účtu

Novinka ve verzi v2.1: Podpora metod to_dict a from_dict

AddressValue

Hodnota pole adresa.

Novinka ve verzi 2023-07-31: Vlastnosti jednotky, city_district, state_district, předměstí, domu a úrovně .

AnalyzeResult

Výsledek analýzy dokumentu.

AnalyzedDocument

Objekt popisující umístění a sémantický obsah dokumentu.

BlobFileListSource

Zdroj obsahu pro seznam souborů v Azure Blob Storage.

BlobSource

Zdroj obsahu pro Azure Blob Storage.

BoundingRegion

Ohraničující oblast odpovídající stránce.

ClassifierDocumentTypeDetails

Trénovací zdroj dat.

CurrencyValue

Prvek hodnoty měny.

Novinka ve verzi 2023-07-31: Vlastnost kódu .

CustomDocumentModelsDetails

Podrobnosti týkající se vlastních modelů v rámci prostředku Rozpoznávání formulářů

CustomFormModel

Představuje vytrénovaný model.

Novinka ve verzi v2.1: vlastnosti model_name a vlastnosti, podpora metod to_dict a from_dict

CustomFormModelField

Pole, které model extrahuje z formulářů, které analyzuje.

Novinka ve verzi v2.1: Podpora metod to_dict a from_dict

CustomFormModelInfo

Informace o vlastním modelu.

Novinka ve verzi v2.1: vlastnosti model_name a vlastnosti, podpora metod to_dict a from_dict

CustomFormModelProperties

Volitelné vlastnosti modelu.

Novinka ve verzi v2.1: Podpora metod to_dict a from_dict

CustomFormSubmodel

Představuje dílčí model, který extrahuje pole z určitého typu formuláře.

Novinka ve verzi v2.1: Vlastnost model_id, podpora metod to_dict a from_dict

DocumentAnalysisClient

DocumentAnalysisClient analyzuje informace z dokumentů a obrázků a klasifikuje dokumenty. Jedná se o rozhraní pro analýzu s předem vytvořenými modely (mimo jiné účtenky, vizitky, faktury, dokumenty identity), analýzu rozložení z dokumentů, analýzu obecných typů dokumentů a analýzu vlastních dokumentů pomocí sestavených modelů (úplný seznam modelů podporovaných službou najdete tady: https://aka.ms/azsdk/formrecognizer/models). Poskytuje různé metody založené na vstupech z adresy URL a vstupech ze streamu.

Poznámka

DocumentAnalysisClient by se měl používat s verzemi rozhraní API.

2022-08-31 a novější. Pokud chcete použít rozhraní API verze <=v2.1, vytvořte instanci FormRecognizerClient.

Novinka ve verzi 2022-08-31: DocumentAnalysisClient a jeho klientské metody.

DocumentAnalysisError

DocumentAnalysisError obsahuje podrobnosti o chybě vrácené službou.

DocumentAnalysisInnerError

Podrobnosti o vnitřní chybě pro DocumentAnalysisError.

DocumentBarcode

Objekt čárového kódu.

DocumentClassifierDetails

Informace o klasifikátoru dokumentů Zahrnuje typy dokumentů, které model může klasifikovat.

DocumentField

Objekt představující obsah a umístění hodnoty pole dokumentu.

Novinka ve verzi 2023-07-31: Logická value_type a logická hodnota

DocumentFormula

Objekt vzorce.

DocumentKeyValueElement

Objekt představující klíč pole nebo hodnotu ve dvojici klíč-hodnota.

DocumentKeyValuePair

Objekt představující pole dokumentu s jedinečným popiskem pole (klíč) a hodnotou pole (může být prázdný).

DocumentLanguage

Objekt představující rozpoznaný jazyk pro daný rozsah textu.

DocumentLine

Objekt řádku obsahu představující obsah nalezený na jednom řádku dokumentu.

DocumentModelAdministrationClient

DocumentModelAdministrationClient je rozhraní Rozpoznávání formulářů, které se používá k vytváření a správě modelů.

Poskytuje metody pro vytváření modelů a klasifikátorů a také metody pro zobrazení a odstranění modelů a klasifikátorů, zobrazení operací modelu a klasifikátoru, přístup k informacím o účtu, kopírování modelů do jiného Rozpoznávání formulářů prostředku a vytvoření nového modelu z kolekce existujících modelů.

Poznámka

DocumentModelAdministrationClient by se měl používat s verzemi rozhraní API.

2022-08-31 a novější. Pokud chcete použít rozhraní API verze <=v2.1, vytvořte instanci FormTrainingClient.

Novinka ve verzi 2022-08-31: DocumentModelAdministrationClient a jeho klientské metody.

DocumentModelAdministrationLROPoller

Implementuje protokol následovaný vrácenými poller objekty.

DocumentModelDetails

Informace o modelu dokumentu. Zahrnuje typy dokumentů, které model dokáže analyzovat.

Novinka ve verzi 2023-07-31: Vlastnost expires_on .

DocumentModelSummary

Souhrn informací o modelu dokumentu, včetně ID modelu, jeho popisu a data vytvoření modelu

Novinka ve verzi 2023-07-31: Vlastnost expires_on .

DocumentPage

Prvky obsahu a rozložení extrahované ze stránky vstupu

Novinka ve verzi 2023-07-31: Vlastnosti čárových kódů a vzorců

DocumentParagraph

Objekt odstavce, který se obvykle skládá z souvislých čar se společným zarovnáním a mezerami.

Novinka ve verzi 2023-07-31: Role formulaBlock .

DocumentSelectionMark

Objekt značky výběru představující zaškrtávací políčka, přepínače a další prvky označující výběr.

DocumentSpan

Souvislá oblast obsahu vlastnosti, zadaná jako posun a délka.

DocumentStyle

Objekt představující pozorované styly textu.

Novinka ve verzi 2023-07-31: Vlastnosti similar_font_family, font_style, font_weight, barva a background_color .

DocumentTable

Objekt tabulky skládající se z buněk tabulky uspořádaných do obdélníkového rozložení.

DocumentTableCell

Objekt představující umístění a obsah buňky tabulky.

DocumentTypeDetails

DocumentTypeDetails představuje typ dokumentu, který model rozpozná, včetně jeho polí a typů a spolehlivosti pro tato pole.

DocumentWord

Objekt slova, který se skládá z souvislé sekvence znaků. U jazyků, které nejsou oddělené mezerami, jako je čínština, japonština a korejština, je každý znak reprezentován jako vlastní slovo.

FieldData

Obsahuje data pro pole formuláře. To zahrnuje text, umístění textu ve formuláři a kolekci prvků, které text tvoří.

Novinka ve verzi v2.1: FormSelectionMark se přidá do typů vrácených v seznamu field_elements, podpora metod to_dict a from_dict

FormElement

Základní typ, který obsahuje vlastnosti prvku formuláře.

Novinka ve verzi v2.1: Podpora metod to_dict a from_dict

FormField

Představuje pole rozpoznané ve vstupním formuláři.

Novinka ve verzi v2.1: Podpora metod to_dict a from_dict

FormLine

Objekt představující extrahovaný řádek textu.

Novinka ve verzi v2.1: vlastnost vzhled, podpora metod to_dict a from_dict

FormPage

Představuje stránku rozpoznanou ze vstupního dokumentu. Obsahuje řádky, slova, značky výběru, tabulky a metadata stránek.

Novinka ve verzi v2.1: selection_marks vlastnost, podpora metod to_dict a from_dict

FormPageRange

Rozsah stránek formuláře založený na 1.

Novinka ve verzi v2.1: Podpora metod to_dict a from_dict

FormRecognizerClient

FormRecognizerClient extrahuje informace z formulářů a obrázků do strukturovaných dat. Jedná se o rozhraní pro analýzu s předem vytvořenými modely (účtenky, vizitky, faktury, dokumenty identity), rozpoznávání obsahu a rozložení z formulářů a analýzu vlastních formulářů z natrénovaných modelů. Poskytuje různé metody založené na vstupech z adresy URL a vstupech ze streamu.

Poznámka

FormRecognizerClient by se měl používat s rozhraním API verze <=v2.1.

Pokud chcete používat rozhraní API verze 2022-08-31 nebo novější, vytvořte instanci DocumentAnalysisClient.

FormRecognizerError

Představuje chybu, ke které došlo při trénování.

Novinka ve verzi v2.1: Podpora metod to_dict a from_dict

FormSelectionMark

Informace o extrahované značce výběru

Novinka ve verzi v2.1: Podpora metod to_dict a from_dict

FormTable

Informace o extrahované tabulce obsažené na stránce

Novinka ve verzi v2.1: Vlastnost bounding_box, podpora metod to_dict a from_dict

FormTableCell

Představuje buňku obsaženou v tabulce rozpoznané ze vstupního dokumentu.

Novinka ve verzi v2.1: FormSelectionMark je přidán do typů vrácených v seznamu field_elements, podpora metod to_dict a from_dict

FormTrainingClient

FormTrainingClient je Rozpoznávání formulářů rozhraní pro vytváření a správu vlastních modelů. Poskytuje metody pro trénování modelů na formulářích, které poskytujete, a také metody pro zobrazení a odstraňování modelů, přístup k vlastnostem účtu, kopírování modelů do jiného Rozpoznávání formulářů prostředku a vytváření modelů z kolekce existujících modelů vytrénovaných pomocí popisků.

Poznámka

FormTrainingClient by se měl používat s verzemi <rozhraní API =v2.1.

Pokud chcete používat rozhraní API verze 2022-08-31 a novější, vytvořte instanci DocumentModelAdministrationClient.

FormWord

Představuje slovo rozpoznané ze vstupního dokumentu.

Novinka ve verzi v2.1: Podpora metod to_dict a from_dict

OperationDetails

OperationDetails se skládá z informací o operaci modelu, včetně výsledku nebo chyby operace, pokud byla dokončena.

Upozorňujeme, že informace o operaci se uchovávají pouze 24 hodin. Pokud byla operace úspěšná, je možné k modelu přistupovat také pomocí <xref:azure.ai.formrecognizer.get_document_model>rozhraní API , <xref:azure.ai.formrecognizer.list_document_models>, <xref:azure.ai.formrecognizer.get_document_classifier>, . <xref:azure.ai.formrecognizer.list_document_classifiers>

Novinka ve verzi 2023-07-31: Výsledek documentClassifierBuild a DocumentClassifierDetails .

OperationSummary

Informace o operaci modelu, včetně druhu a stavu operace, kdy byla vytvořena a další.

Upozorňujeme, že informace o operaci se uchovávají pouze 24 hodin. Pokud byla operace úspěšná, lze k modelu přistupovat pomocí <xref:azure.ai.formrecognizer.get_document_model>rozhraní API , <xref:azure.ai.formrecognizer.list_document_models>, <xref:azure.ai.formrecognizer.get_document_classifier>, <xref:azure.ai.formrecognizer.list_document_classifiers> . Pokud chcete zjistit, proč operace selhala, použijte <xref:azure.ai.formrecognizer.get_operation> a zadejte operation_id.

Novinka ve verzi 2023-07-31: Druh documentClassifierBuild .

Point

Souřadnice x, y bodu na ohraničující rámeček nebo mnohoúhelník.

Novinka ve verzi v2.1: Podpora metod to_dict a from_dict

QuotaDetails

Využitá kvóta, omezení a datum a čas příštího resetování

RecognizedForm

Představuje formulář, který byl rozpoznán natrénovaným nebo předem vytvořeným modelem. Vlastnost fields obsahuje pole formuláře, která byla extrahována z formuláře. Tabulky, textové řádky a slova a značky výběru se extrahují na stránku a nacházejí se ve vlastnosti pages .

Novinka ve verzi v2.1: Vlastnosti form_type_confidence a model_id, podpora metod to_dict a from_dict

ResourceDetails

Podrobnosti týkající se Rozpoznávání formulářů prostředku

Novinka ve verzi 2023-07-31: Vlastnost neural_document_model_quota .

TextAppearance

Objekt představující vzhled řádku textu.

Novinka ve verzi v2.1: Podpora metod to_dict a from_dict

TrainingDocumentInfo

Sestava pro jednotlivý dokument sloužící k trénování vlastního modelu

Novinka ve verzi v2.1: Vlastnost model_id, podpora metod to_dict a from_dict

Výčty

AnalysisFeature

Funkce analýzy dokumentů, které se mají povolit.

CustomFormModelStatus

Stav označující připravenost modelu k použití.

DocumentAnalysisApiVersion

Rozpoznávání formulářů verze rozhraní API podporované DocumentAnalysisClient a DocumentModelAdministrationClient.

FieldValueType

Sémantický datový typ hodnoty pole.

Novinka ve verzi v2.1: Hodnoty selectionMark a countryRegion

FormContentType

Typ obsahu pro nahrání

Novinka ve verzi v2.1: Podpora image/bmp

FormRecognizerApiVersion

Rozpoznávání formulářů verze rozhraní API podporované FormRecognizerClient a FormTrainingClient.

LengthUnit

Jednotka používaná vlastnostmi šířky, výšky a ohraničujícího rámečku. U obrázků je to "pixel". Pro PDF je jednotka "inch".

ModelBuildMode

Režim použitý při vytváření vlastních modelů

Další informace naleznete v tématu https://aka.ms/azsdk/formrecognizer/buildmode.

TrainingStatus

Stav trénovací operace.