다음을 통해 공유


formrecognizer 패키지

패키지

aio

클래스

AccountProperties

계정의 모든 사용자 지정 모델에 대한 요약입니다.

버전 v2.1의 새로운 기능: to_dictfrom_dict 메서드 지원

AddressValue

주소 필드 값입니다.

버전 2023-07-31의 새로운 기능: 단위, city_district, state_district, 교외, 수준 속성입니다.

AnalyzeResult

문서 분석 결과입니다.

AnalyzedDocument

문서의 위치 및 의미 체계 콘텐츠를 설명하는 개체입니다.

BlobFileListSource

Azure Blob Storage 파일 목록의 콘텐츠 원본입니다.

BlobSource

Azure Blob Storage 콘텐츠 원본입니다.

BoundingRegion

페이지에 해당하는 경계 지역입니다.

ClassifierDocumentTypeDetails

학습 데이터 원본.

CurrencyValue

통화 값 요소입니다.

버전 2023-07-31의 새로운 기능: 코드 속성입니다.

CustomDocumentModelsDetails

Form Recognizer 리소스 아래의 사용자 지정 모델에 대한 세부 정보입니다.

CustomFormModel

학습된 모델을 나타냅니다.

버전 v2.1의 새로운 기능: model_name속성 속성, to_dictfrom_dict 메서드 지원

CustomFormModelField

모델이 분석하는 양식에서 추출할 필드입니다.

버전 v2.1의 새로운 기능: to_dictfrom_dict 메서드 지원

CustomFormModelInfo

사용자 지정 모델 정보입니다.

버전 v2.1의 새로운 기능: model_name속성 속성, to_dictfrom_dict 메서드 지원

CustomFormModelProperties

선택적 모델 속성입니다.

버전 v2.1의 새로운 기능: to_dictfrom_dict 메서드 지원

CustomFormSubmodel

특정 형식의 양식에서 필드를 추출하는 하위 모델입니다.

버전 v2.1의 새로운 기능: model_id 속성, to_dictfrom_dict 메서드 지원

DocumentAnalysisClient

DocumentAnalysisClient는 문서 및 이미지의 정보를 분석하고 문서를 분류합니다. 미리 빌드된 모델(영수증, 명함, 청구서, ID 문서 등)을 사용하여 분석하고, 문서의 레이아웃을 분석하고, 일반 문서 유형을 분석하고, 빌드된 모델을 사용하여 사용자 지정 문서를 분석하는 데 사용할 수 있는 인터페이스입니다(서비스에서 지원하는 모델의 전체 목록을 보려면 다음 https://aka.ms/azsdk/formrecognizer/models을 참조하세요.). URL의 입력과 스트림의 입력에 따라 다른 메서드를 제공합니다.

참고

DocumentAnalysisClient를 API 버전과 함께 사용해야 합니다.

2022-08-31 이상. API 버전 <=v2.1을 사용하려면 FormRecognizerClient를 인스턴스화합니다.

버전 2022-08-31의 새로운 기능: DocumentAnalysisClient 및 해당 클라이언트 메서드.

DocumentAnalysisError

DocumentAnalysisError에는 서비스에서 반환된 오류의 세부 정보가 포함되어 있습니다.

DocumentAnalysisInnerError

DocumentAnalysisError의 내부 오류 세부 정보입니다.

DocumentBarcode

바코드 개체입니다.

DocumentClassifierDetails

문서 분류자 정보입니다. 모델이 분류할 수 있는 문서 형식을 포함합니다.

DocumentField

문서 필드 값의 내용과 위치를 나타내는 개체입니다.

버전 2023-07-31의 새로운 기능: 부울 value_type 및 부울

DocumentFormula

수식 개체입니다.

DocumentKeyValueElement

키-값 쌍의 필드 키 또는 값을 나타내는 개체입니다.

DocumentKeyValuePair

고유한 필드 레이블(키) 및 필드 값(비어 있을 수 있음)이 있는 문서 필드를 나타내는 개체입니다.

DocumentLanguage

지정된 텍스트 범위에 대해 검색된 언어를 나타내는 개체입니다.

DocumentLine

문서의 한 줄에 있는 콘텐츠를 나타내는 콘텐츠 줄 개체입니다.

DocumentModelAdministrationClient

DocumentModelAdministrationClient는 모델을 빌드하고 관리하는 데 사용할 Form Recognizer 인터페이스입니다.

모델 및 분류자를 빌드하는 방법뿐만 아니라 모델 및 분류자를 보고 삭제하고, 모델 및 분류자 작업을 보고, 계정 정보에 액세스하고, 모델을 다른 Form Recognizer 리소스로 복사하고, 기존 모델 컬렉션에서 새 모델을 구성하는 방법을 제공합니다.

참고

DocumentModelAdministrationClient를 API 버전과 함께 사용해야 합니다.

2022-08-31 이상. API 버전 <=v2.1을 사용하려면 FormTrainingClient를 인스턴스화합니다.

버전 2022-08-31의 새로운 기능: DocumentModelAdministrationClient 및 해당 클라이언트 메서드.

DocumentModelAdministrationLROPoller

반환된 폴러 개체 뒤에 프로토콜을 구현합니다.

DocumentModelDetails

문서 모델 정보입니다. 모델에서 분석할 수 있는 문서 형식을 포함합니다.

버전 2023-07-31의 새로운 기능: expires_on 속성입니다.

DocumentModelSummary

모델 ID, 해당 설명 및 모델을 만든 시기를 포함한 문서 모델 정보의 요약입니다.

버전 2023-07-31의 새로운 기능: expires_on 속성입니다.

DocumentPage

입력 페이지에서 추출된 콘텐츠 및 레이아웃 요소입니다.

버전 2023-07-31의 새로운 기능: 바코드수식 속성입니다.

DocumentParagraph

일반적으로 공통 맞춤 및 간격이 있는 연속선으로 구성된 단락 개체입니다.

버전 2023-07-31의 새로운 기능: formulaBlock 역할입니다.

DocumentSelectionMark

선택 영역을 나타내는 검사 상자, 라디오 단추 및 기타 요소를 나타내는 선택 표시 개체입니다.

DocumentSpan

오프셋 및 길이로 지정된 속성 콘텐츠의 연속 영역입니다.

DocumentStyle

관찰된 텍스트 스타일을 나타내는 개체입니다.

버전 2023-07-31의 새로운 기능: similar_font_family, font_style, font_weight, background_color 속성입니다.

DocumentTable

사각형 레이아웃에 정렬된 표 셀로 구성된 테이블 개체입니다.

DocumentTableCell

테이블 셀의 위치와 내용을 나타내는 개체입니다.

DocumentTypeDetails

DocumentTypeDetails는 필드 및 형식 및 해당 필드에 대한 신뢰도를 포함하여 모델이 인식할 수 있는 문서 형식을 나타냅니다.

DocumentWord

연속된 문자 시퀀스로 구성된 단어 개체입니다. 중국어, 일본어 및 한국어와 같이 공백으로 구분되지 않은 언어의 경우 각 문자는 고유한 단어로 표시됩니다.

FieldData

양식 필드의 데이터를 포함합니다. 여기에는 텍스트, 폼의 텍스트 위치 및 텍스트를 구성하는 요소의 컬렉션이 포함됩니다.

버전 v2.1의 새로운 기능: FormSelectionMark 가 field_elements 목록에 반환된 형식, to_dict 지원 및 from_dict 메서드에 추가됩니다.

FormElement

양식 요소의 속성을 포함하는 기본 형식입니다.

버전 v2.1의 새로운 기능: to_dictfrom_dict 메서드 지원

FormField

입력 양식에서 인식되는 필드를 나타냅니다.

버전 v2.1의 새로운 기능: to_dictfrom_dict 메서드 지원

FormLine

추출된 텍스트 줄을 나타내는 개체입니다.

버전 v2.1의 새로운 기능: 모양 속성, to_dictfrom_dict 메서드 지원

FormPage

입력 문서에서 인식되는 페이지를 나타냅니다. 선, 단어, 선택 표시, 테이블 및 페이지 메타데이터를 포함합니다.

버전 v2.1의 새로운 기능: selection_marks 속성, to_dictfrom_dict 메서드 지원

FormPageRange

양식의 1부터 시작하는 페이지 범위입니다.

버전 v2.1의 새로운 기능: to_dictfrom_dict 메서드 지원

FormRecognizerClient

FormRecognizerClient는 양식 및 이미지의 정보를 구조화된 데이터로 추출합니다. 미리 빌드된 모델(영수증, 명함, 청구서, ID 문서)을 사용하여 분석하고, 양식의 콘텐츠/레이아웃을 인식하고, 학습된 모델의 사용자 지정 양식을 분석하는 데 사용할 인터페이스입니다. URL의 입력과 스트림의 입력에 따라 다른 메서드를 제공합니다.

참고

FormRecognizerClient는 API 버전 <=v2.1과 함께 사용해야 합니다.

API 버전 2022-08-31을 사용하려면 DocumentAnalysisClient를 인스턴스화합니다.

FormRecognizerError

학습 중에 발생한 오류를 나타냅니다.

버전 v2.1의 새로운 기능: to_dictfrom_dict 메서드 지원

FormSelectionMark

추출된 선택 표시에 대한 정보입니다.

버전 v2.1의 새로운 기능: to_dictfrom_dict 메서드 지원

FormTable

페이지에 포함된 추출된 테이블에 대한 정보입니다.

버전 v2.1의 새로운 기능: bounding_box 속성, to_dictfrom_dict 메서드 지원

FormTableCell

입력 문서에서 인식되는 테이블에 포함된 셀을 나타냅니다.

버전 v2.1의 새로운 기능: formSelectionMark가 field_elements, to_dict 지원 및from_dict 메서드 목록에 반환된 형식에 추가됩니다.

FormTrainingClient

FormTrainingClient는 사용자 지정 모델을 만들고 관리하는 데 사용할 Form Recognizer 인터페이스입니다. 제공하는 양식에서 모델을 학습시키는 방법뿐만 아니라 모델을 보고 삭제하고, 계정 속성에 액세스하고, 모델을 다른 Form Recognizer 리소스로 복사하고, 레이블로 학습된 기존 모델 컬렉션에서 모델을 구성하는 방법을 제공합니다.

참고

FormTrainingClient는 API 버전 <=v2.1과 함께 사용해야 합니다.

API 버전 2022-08-31을 사용하려면 DocumentModelAdministrationClient를 인스턴스화합니다.

FormWord

입력 문서에서 인식되는 단어를 나타냅니다.

버전 v2.1의 새로운 기능: to_dictfrom_dict 메서드 지원

OperationDetails

OperationDetails는 완료된 경우 작업의 결과 또는 오류를 포함하여 모델 작업에 대한 정보로 구성됩니다.

작업 정보는 24시간 동안만 유지됩니다. 작업이 성공한 경우 , , <xref:azure.ai.formrecognizer.list_document_models>, <xref:azure.ai.formrecognizer.get_document_classifier><xref:azure.ai.formrecognizer.list_document_classifiers> API를 <xref:azure.ai.formrecognizer.get_document_model>사용하여 모델에 액세스할 수도 있습니다.

버전 2023-07-31의 새로운 기능: documentClassifierBuild 종류 및 DocumentClassifierDetails 결과입니다.

OperationSummary

작업 종류 및 상태, 생성 시기 등을 포함한 모델 작업 정보입니다.

작업 정보는 24시간 동안만 유지됩니다. 작업이 성공한 경우 , , <xref:azure.ai.formrecognizer.list_document_models>, <xref:azure.ai.formrecognizer.get_document_classifier><xref:azure.ai.formrecognizer.list_document_classifiers> API를 <xref:azure.ai.formrecognizer.get_document_model>사용하여 모델에 액세스할 수 있습니다. 작업이 실패한 이유를 알아보려면 를 사용하고 <xref:azure.ai.formrecognizer.get_operation>operation_id 제공합니다.

버전 2023-07-31의 새로운 기능: documentClassifierBuild 종류입니다.

Point

경계 상자 또는 다각형에 있는 점의 x, y 좌표입니다.

버전 v2.1의 새로운 기능: to_dictfrom_dict 메서드 지원

QuotaDetails

사용된 할당량, 제한 및 다음 재설정 날짜/시간입니다.

RecognizedForm

학습되거나 미리 빌드된 모델에서 인식된 양식을 나타냅니다. fields 속성에는 양식에서 추출된 양식 필드가 포함됩니다. 표, 텍스트 줄/단어 및 선택 표시는 페이지별로 추출되고 pages 속성에 있습니다.

버전 v2.1의 새로운 기능: form_type_confidencemodel_id 속성, to_dictfrom_dict 메서드 지원

ResourceDetails

Form Recognizer 리소스에 대한 세부 정보입니다.

버전 2023-07-31의 새로운 기능: neural_document_model_quota 속성입니다.

TextAppearance

텍스트 줄의 모양을 나타내는 개체입니다.

버전 v2.1의 새로운 기능: to_dictfrom_dict 메서드 지원

TrainingDocumentInfo

사용자 지정 모델을 학습하는 데 사용되는 개별 문서에 대한 보고서입니다.

버전 v2.1의 새로운 기능: model_id 속성, to_dictfrom_dict 메서드 지원

열거형

AnalysisFeature

사용하도록 설정할 문서 분석 기능입니다.

CustomFormModelStatus

모델의 사용 준비를 나타내는 상태입니다.

DocumentAnalysisApiVersion

Form Recognizer DocumentAnalysisClient 및 DocumentModelAdministrationClient에서 지원되는 API 버전입니다.

FieldValueType

필드 값의 의미 체계 데이터 형식입니다.

버전 v2.1의 새로운 기능: selectionMarkcountryRegion

FormContentType

업로드할 콘텐츠 형식입니다.

버전 v2.1의 새로운 기능: 이미지/bmp 지원

FormRecognizerApiVersion

Form Recognizer FormRecognizerClient 및 FormTrainingClient에서 지원하는 API 버전입니다.

LengthUnit

너비, 높이 및 경계 상자 속성에 사용되는 단위입니다. 이미지의 경우 단위는 "pixel"입니다. PDF의 경우 단위는 "인치"입니다.

ModelBuildMode

사용자 지정 모델을 빌드할 때 사용되는 모드입니다.

자세한 내용은 https://aka.ms/azsdk/formrecognizer/buildmode를 참조하세요.

TrainingStatus

학습 작업의 상태입니다.