formrecognizer Paket

Paket

aio

Klasser

AccountProperties

Sammanfattning av alla anpassade modeller för kontot.

Nytt i version v2.1: Stöd för metoder för to_dict och from_dict

AddressValue

Ett värde för adressfält.

Ny i version 2023-07-31: Enheten, city_district, state_district, förort, hus och nivåegenskaper .

AnalyzeResult

Dokumentanalysresultat.

AnalyzedDocument

Ett objekt som beskriver ett dokuments plats och semantiska innehåll.

BlobFileListSource

Innehållskälla för en fillista i Azure Blob Storage.

BlobSource

Innehållskälla för Azure Blob Storage.

BoundingRegion

Den avgränsningsregion som motsvarar en sida.

ClassifierDocumentTypeDetails

Träningsdatakälla.

CurrencyValue

Ett valutavärdeelement.

Ny i version 2023-07-31: Kodegenskapen.

CustomDocumentModelsDetails

Information om de anpassade modellerna under resursen Formigenkänning.

CustomFormModel

Representerar en tränad modell.

Nytt i version v2.1: Egenskaper för model_name och egenskaper, stöd för to_dict- och from_dict-metoder

CustomFormModelField

Ett fält som modellen extraherar från formulär som den analyserar.

Nytt i version v2.1: Stöd för metoder för to_dict och from_dict

CustomFormModelInfo

Anpassad modellinformation.

Nytt i version v2.1: Egenskaper för model_name och egenskaper, stöd för to_dict- och from_dict-metoder

CustomFormModelProperties

Valfria modellegenskaper.

Nytt i version v2.1: Stöd för metoder för to_dict och from_dict

CustomFormSubmodel

Representerar en undermodell som extraherar fält från en viss typ av formulär.

Nytt i version v2.1: Egenskapen model_id , stöd för to_dict - och from_dict metoder

DocumentAnalysisClient

DocumentAnalysisClient analyserar information från dokument och bilder och klassificerar dokument. Det är gränssnittet som ska användas för att analysera med fördefinierade modeller (kvitton, visitkort, fakturor, identitetsdokument, bland annat), analys av layout från dokument, analys av allmänna dokumenttyper och analys av anpassade dokument med inbyggda modeller (för att se en fullständig lista över modeller som stöds av tjänsten, se: https://aka.ms/azsdk/formrecognizer/models). Den tillhandahåller olika metoder baserat på indata från en URL och indata från en ström.

Anteckning

DocumentAnalysisClient ska användas med API-versioner

2022-08-31 och uppåt. Om du vill använda API-versioner <=v2.1 instansierar du en FormRecognizerClient.

Ny i version 2022-08-31: DocumentAnalysisClient och dess klientmetoder.

DocumentAnalysisError

DocumentAnalysisError innehåller information om felet som returneras av tjänsten.

DocumentAnalysisInnerError

Inre felinformation för DocumentAnalysisError.

DocumentBarcode

Ett streckkodsobjekt.

DocumentClassifierDetails

Information om dokumentklassificerare. Innehåller de dokumenttyper som modellen kan klassificera.

DocumentField

Ett objekt som representerar innehållet och platsen för ett dokumentfältvärde.

Nytt i version 2023-07-31: Det booleska value_type- och bool-värdet

DocumentFormula

Ett formelobjekt.

DocumentKeyValueElement

Ett objekt som representerar fältnyckeln eller värdet i ett nyckel/värde-par.

DocumentKeyValuePair

Ett objekt som representerar ett dokumentfält med distinkt fältetikett (nyckel) och fältvärde (kan vara tomt).

DocumentLanguage

Ett objekt som representerar det identifierade språket för ett visst textintervall.

DocumentLine

Ett innehållsradsobjekt som representerar innehållet som finns på en enda rad i dokumentet.

DocumentModelAdministrationClient

DocumentModelAdministrationClient är det Formigenkänning gränssnitt som ska användas för att skapa och hantera modeller.

Den innehåller metoder för att skapa modeller och klassificerare, samt metoder för att visa och ta bort modeller och klassificerare, visa modell- och klassificeraråtgärder, komma åt kontoinformation, kopiera modeller till en annan Formigenkänning resurs och skapa en ny modell från en samling befintliga modeller.

Anteckning

DocumentModelAdministrationClient ska användas med API-versioner

2022-08-31 och uppåt. Om du vill använda API-versioner <=v2.1 instansierar du en FormTrainingClient.

Ny i version 2022-08-31: DocumentModelAdministrationClient och dess klientmetoder.

DocumentModelAdministrationLROPoller

Implementerar ett protokoll följt av returnerade pollerobjekt.

DocumentModelDetails

Dokumentmodellinformation. Innehåller de dokumenttyper som modellen kan analysera.

Ny i version 2023-07-31: egenskapen expires_on .

DocumentModelSummary

En sammanfattning av dokumentmodellinformation inklusive modell-ID, dess beskrivning och när modellen skapades.

Ny i version 2023-07-31: egenskapen expires_on .

DocumentPage

Innehålls- och layoutelement som extraherats från en sida med indata.

Ny i version 2023-07-31: Egenskaperna för streckkoder och formler .

DocumentParagraph

Ett styckeobjekt består vanligtvis av sammanhängande linjer med gemensam justering och avstånd.

Ny i version 2023-07-31: Rollen formulaBlock .

DocumentSelectionMark

Ett markeringsmarkeringsobjekt som representerar kryssrutor, alternativknappar och andra element som anger en markering.

DocumentSpan

Sammanhängande region för innehållet i egenskapen, angivet som en förskjutning och längd.

DocumentStyle

Ett objekt som representerar observerade textformat.

Ny i version 2023-07-31: Egenskaperna similar_font_family, font_style, font_weight, färg och background_color .

DocumentTable

Ett tabellobjekt som består av tabellceller ordnade i en rektangulär layout.

DocumentTableCell

Ett objekt som representerar platsen och innehållet i en tabellcell.

DocumentTypeDetails

DocumentTypeDetails representerar en dokumenttyp som en modell kan identifiera, inklusive dess fält och typer, och konfidensen för dessa fält.

DocumentWord

Ett ordobjekt som består av en sammanhängande sekvens med tecken. För icke-blankstegsavgränsade språk, till exempel kinesiska, japanska och koreanska, representeras varje tecken som sitt eget ord.

FieldData

Innehåller data för formulärfältet. Detta inkluderar texten, platsen för texten i formuläret och en samling av de element som utgör texten.

Ny i version v2.1: FormSelectionMark läggs till i de typer som returneras i listan över field_elements, stöd för metoder för to_dict och from_dict

FormElement

Bastyp som innehåller egenskaper för ett formulärelement.

Nytt i version v2.1: Stöd för metoder för to_dict och from_dict

FormField

Representerar ett fält som identifieras i ett indataformulär.

Nytt i version v2.1: Stöd för metoder för to_dict och from_dict

FormLine

Ett objekt som representerar en extraherad textrad.

Nytt i version v2.1: utseendeegenskap , stöd för to_dict och from_dict metoder

FormPage

Representerar en sida som identifieras från indatadokumentet. Innehåller rader, ord, urvalsmarkeringar, tabeller och sidmetadata.

Nytt i version v2.1: selection_marks egenskap, stöd för to_dict och from_dict metoder

FormPageRange

Formulärets 1-baserade sidintervall.

Nytt i version v2.1: Stöd för metoder för to_dict och from_dict

FormRecognizerClient

FormRecognizerClient extraherar information från formulär och bilder till strukturerade data. Det är gränssnittet som ska användas för att analysera med fördefinierade modeller (kvitton, visitkort, fakturor, identitetsdokument), identifiera innehåll/layout från formulär och analysera anpassade formulär från tränade modeller. Den tillhandahåller olika metoder baserat på indata från en URL och indata från en ström.

Anteckning

FormRecognizerClient ska användas med API-versioner <=v2.1.

Om du vill använda API-versionerna 2022-08-31 och senare instansierar du en DocumentAnalysisClient.

FormRecognizerError

Representerar ett fel som uppstod under träningen.

Nytt i version v2.1: Stöd för metoder för to_dict och from_dict

FormSelectionMark

Information om det extraherade markeringsmärket.

Ny i version v2.1: Stöd för to_dict och from_dict metoder

FormTable

Information om den extraherade tabellen som finns på en sida.

Ny i version v2.1: egenskapen bounding_box , stöd för to_dict och from_dict metoder

FormTableCell

Representerar en cell som finns i en tabell som känns igen från indatadokumentet.

Ny i version v2.1: FormSelectionMark läggs till i de typer som returneras i listan över field_elements, stöd för to_dict och from_dict metoder

FormTrainingClient

FormTrainingClient är det Formigenkänning gränssnitt som ska användas för att skapa och hantera anpassade modeller. Den innehåller metoder för att träna modeller på de formulär som du tillhandahåller, samt metoder för att visa och ta bort modeller, komma åt kontoegenskaper, kopiera modeller till en annan Formigenkänning resurs och skapa modeller från en samling befintliga modeller som tränats med etiketter.

Anteckning

FormTrainingClient ska användas med API-versioner <=v2.1.

Om du vill använda API-versionerna 2022-08-31 och senare instansierar du en DocumentModelAdministrationClient.

FormWord

Representerar ett ord som känns igen från indatadokumentet.

Ny i version v2.1: Stöd för to_dict och from_dict metoder

OperationDetails

OperationDetails består av information om modellåtgärden, inklusive resultatet eller felet för åtgärden om den har slutförts.

Observera att åtgärdsinformationen bara finns kvar i 24 timmar. Om åtgärden lyckades kan modellen också nås med api:erna <xref:azure.ai.formrecognizer.get_document_model>, <xref:azure.ai.formrecognizer.list_document_models>, <xref:azure.ai.formrecognizer.get_document_classifier>. <xref:azure.ai.formrecognizer.list_document_classifiers>

Ny i version 2023-07-31: DocumentClassifierBuild-typen och DocumentClassifierDetails-resultatet .

OperationSummary

Information om modellåtgärder, inklusive typ och status för åtgärden, när den skapades med mera.

Observera att åtgärdsinformationen bara finns kvar i 24 timmar. Om åtgärden lyckades kan modellen nås med api:erna <xref:azure.ai.formrecognizer.get_document_model>, <xref:azure.ai.formrecognizer.list_document_models>, <xref:azure.ai.formrecognizer.get_document_classifier>. <xref:azure.ai.formrecognizer.list_document_classifiers> Om du vill ta reda på varför en åtgärd misslyckades använder <xref:azure.ai.formrecognizer.get_operation> du och anger operation_id.

Ny i version 2023-07-31: Typen documentClassifierBuild .

Point

Koordinaten x, y för en punkt i en avgränsningsruta eller polygon.

Ny i version v2.1: Stöd för to_dict och from_dict metoder

QuotaDetails

Använd kvot, begränsa och nästa återställningsdatum/tid.

RecognizedForm

Representerar ett formulär som har identifierats av en tränad eller fördefinierad modell. Egenskapen fields innehåller de formulärfält som extraherades från formuläret. Tabeller, textrader/ord och markeringsmarkeringar extraheras per sida och finns i sidegenskapen.

Nytt i version v2.1: Egenskaperna form_type_confidence och model_id , stöd för to_dict och from_dict metoder

ResourceDetails

Information om den Formigenkänning resursen.

Ny i version 2023-07-31: egenskapen neural_document_model_quota .

TextAppearance

Ett objekt som representerar textradens utseende.

Ny i version v2.1: Stöd för to_dict och from_dict metoder

TrainingDocumentInfo

Rapport för ett enskilt dokument som används för att träna en anpassad modell.

Ny i version v2.1: egenskapen model_id , stöd för to_dict och from_dict metoder

Uppräkningar

AnalysisFeature

Funktioner för dokumentanalys som ska aktiveras.

CustomFormModelStatus

Status som anger modellens beredskap för användning.

DocumentAnalysisApiVersion

Formigenkänning API-versioner som stöds av DocumentAnalysisClient och DocumentModelAdministrationClient.

FieldValueType

Semantisk datatyp för fältvärdet.

Ny i version v2.1: Värdena för selectionMark och countryRegion

FormContentType

Innehållstyp för uppladdning.

Nytt i version v2.1: Stöd för image/bmp

FormRecognizerApiVersion

Formigenkänning API-versioner som stöds av FormRecognizerClient och FormTrainingClient.

LengthUnit

Den enhet som används av egenskaperna bredd, höjd och avgränsningsruta. För bilder är enheten "pixel". För PDF är enheten "tum".

ModelBuildMode

Det läge som används när du skapar anpassade modeller.

Mer information finns i https://aka.ms/azsdk/formrecognizer/buildmode.

TrainingStatus

Status för träningsåtgärden.