@azure/ai-form-recognizer package
클래스
AzureKeyCredential |
기본 키 값 업데이트를 지원하는 정적 키 기반 자격 증명입니다. |
DocumentAnalysisClient |
Form Recognizer 서비스의 분석 기능과 상호 작용하기 위한 클라이언트입니다. 예제:Form Recognizer 서비스 및 클라이언트는 두 가지 인증 수단을 지원합니다. Azure Active Directory
API 키(구독 키)
|
DocumentModelAdministrationClient |
모델 만들기, 읽기, 나열, 삭제 및 복사와 같은 Form Recognizer 서비스의 모델 관리 기능과 상호 작용하기 위한 클라이언트입니다. 예제:Azure Active Directory
API 키(구독 키)
|
인터페이스
AddressValue |
주소 필드 값입니다. |
AnalyzeDocumentOptions |
문서 분석 작업에 대한 옵션입니다. |
AnalyzeResult |
분석 작업의 결과입니다. 문서의 형식은 분석을 수행하는 데 사용되는 모델에 의해 결정될 수 있습니다. |
AnalyzeResultCommon |
LayoutResult, ReadResult 및 GeneralDocumentResult와 같은 모든 AnalyzeResult와 유사한 형식의 공통 필드입니다. |
AnalyzedDocument |
추출된 문서 개체입니다. AnalyzedDocument는 모델 내 문서 형식 중 하나의 instance. 해당 필드는 문서 형식의 필드 스키마에 해당합니다. |
AzureBlobFileListSource |
Azure Blob 컨테이너 및 컨테이너 내의 JSONL 파일 목록으로 정의된 학습 데이터 원본입니다. |
AzureBlobFileListSourceDetails |
Azure Blob Storage 파일 목록입니다. |
AzureBlobSource |
Azure Blob 컨테이너에서 정의한 학습 데이터 원본입니다. |
AzureBlobSourceDetails |
콘텐츠를 Azure Blob Storage. |
BeginBuildDocumentClassifierOptions |
문서 분류자 빌드 작업에 대한 옵션입니다. |
BeginBuildDocumentModelOptions |
모델 빌드 작업에 대한 옵션입니다. |
BeginComposeDocumentModelOptions |
모델 작성 작업에 대한 옵션입니다. |
BeginCopyModelOptions |
모델 복사 작업에 대한 옵션입니다. |
BoundingRegion |
입력의 특정 페이지에서 다각형 경계 |
ClassifierDocumentTypeDetails |
문서 형식 정보를 분류합니다. |
ClassifyDocumentOptions |
문서 분류 작업에 대한 옵션입니다. |
CommonModelCreationOptions |
, |
CopyAuthorization |
지정한 대상 리소스 및 modelId에 문서 모델을 복사하기 위한 권한 부여 |
CreateDocumentModelOptions |
모델 만들기 작업에 대한 옵션입니다. |
CurrencyValue |
통화 필드 값입니다. |
CustomDocumentModelsDetails |
사용자 지정 문서 모델에 대한 세부 정보입니다. |
DeleteDocumentModelOptions |
모델 삭제 옵션입니다. |
DocumentAddressField |
구조화된 실제 주소를 설명하는 문서 필드입니다. |
DocumentAnalysisClientOptions |
DocumentAnalysisClient에 대한 구성 가능한 옵션입니다. |
DocumentAnalysisPollOperationState |
결국 모델에 해당하는 결과 형식을 생성하는 분석 작업의 상태입니다. |
DocumentAnnotation |
문서의 시각적 주석 요소(예: 검사 표시 또는 교차)입니다. |
DocumentArrayField |
중첩 필드 배열로 구성된 DocumentField입니다. 배열의 모든 필드에는 동일한 형식이 있습니다. |
DocumentBarcode |
추출된 바코드입니다. |
DocumentBooleanField |
부울 값이 있는 DocumentField입니다. |
DocumentCaption |
테이블 캡션 위치 및 내용을 나타내는 개체입니다. |
DocumentClassifierBuildOperationDetails |
작업 응답 개체를 가져옵니다. |
DocumentClassifierDetails |
문서 분류자 정보입니다. |
DocumentClassifierDocumentTypeSources |
문서 분류자를 만드는 데 사용되는 원본 집합입니다. 이 맵은 해당 원본 형식의 문서를 분류하도록 모델을 학습시키는 데 사용할 원본에 대한 문서 형식 이름의 맵입니다. |
DocumentClassifierOperationState |
모델 만들기 작업의 상태입니다. |
DocumentCountryRegionField |
문자열로 표시되는 국가 또는 지역을 나타내는 값이 있는 DocumentField입니다. |
DocumentCurrencyField |
특정 통화의 양을 설명하는 DocumentField입니다. |
DocumentDateField |
Date 값이 있는 DocumentField입니다. |
DocumentFieldCommon |
모든 DocumentField 변형에 공통적인 필드입니다. |
DocumentFieldSchema |
JSON 스키마 스타일 구문을 사용하는 필드 의미 체계 스키마에 대한 설명입니다. |
DocumentFootnote |
표 각주 위치와 내용을 나타내는 개체입니다. |
DocumentFormula |
추출된 수식입니다. |
DocumentIntegerField |
정수 값이 있는 DocumentField입니다. |
DocumentKeyValueElement |
키-값 쌍의 필드 키 또는 값을 나타내는 개체입니다. |
DocumentKeyValuePair |
고유한 필드 레이블(키) 및 필드 값(비어 있을 수 있음)이 있는 양식 필드를 나타내는 개체입니다. |
DocumentLanguage |
지정된 텍스트 범위에 대해 검색된 언어를 나타내는 개체입니다. |
DocumentLine |
단어 및 선택 표시와 같은 인접한 콘텐츠 요소 시퀀스로 구성된 콘텐츠 줄 개체입니다. |
DocumentModel |
구조화된 문서 추출을 지원하는 잘 알려진 모델 사양입니다.
|
DocumentModelAdministrationClientOptions |
DocumentModelAdministrationClient에 대한 구성 가능한 옵션입니다. |
DocumentModelBuildOperationDetails |
작업 응답 개체를 가져옵니다. |
DocumentModelComposeOperationDetails |
작업 응답 개체를 가져옵니다. |
DocumentModelCopyToOperationDetails |
작업 응답 개체를 가져옵니다. |
DocumentModelDetails |
문서 모델 정보입니다. |
DocumentModelOperationState |
모델 만들기 작업의 상태입니다. |
DocumentModelSummary |
문서 모델 요약. |
DocumentNumberField |
숫자 값이 있는 DocumentField입니다. |
DocumentObjectField |
고유한 DocumentField 값이 있는 여러 명명된 속성으로 구성된 DocumentField입니다. |
DocumentPage |
입력에서 페이지에서 추출된 콘텐츠 및 레이아웃 요소입니다. |
DocumentParagraph |
일반적으로 공통 맞춤 및 간격이 있는 연속선으로 구성된 단락 개체입니다. |
DocumentPhoneNumberField |
문자열로 표시되는 전화 번호 값이 있는 DocumentField입니다. |
DocumentSelectionMark |
선택 영역을 나타내는 검사 상자, 라디오 단추 및 기타 요소를 나타내는 선택 표시 개체입니다. |
DocumentSelectionMarkField |
선택 표시 상태(예: 확인란 또는 라디오 단추)를 나타내는 값이 문자열로 표시되는 DocumentField입니다. |
DocumentSignatureField |
문자열로 표시되는 서명의 상태를 나타내는 DocumentField입니다. |
DocumentSpan |
오프셋 및 길이로 지정된 연결된 콘텐츠 속성의 연속 영역입니다. |
DocumentStringField |
문자열 값이 있는 DocumentField입니다. |
DocumentStyle |
관찰된 텍스트 스타일을 나타내는 개체입니다. |
DocumentTable |
사각형 레이아웃으로 정렬된 표 셀로 구성된 테이블 개체입니다. |
DocumentTableCell |
테이블 셀의 위치와 내용을 나타내는 개체입니다. |
DocumentTimeField |
문자열로 표시되는 시간 값이 있는 DocumentField입니다. |
DocumentTypeDetails |
문서 형식 정보입니다. |
DocumentValueField |
문자열, 숫자 등과 같은 기본 값이 있는 단순 필드입니다. |
DocumentWord |
연속된 문자 시퀀스로 구성된 단어 개체입니다. 중국어, 일본어 및 한국어와 같이 공백으로 구분되지 않은 언어의 경우 각 문자가 자체 단어로 표시됩니다. |
ErrorModel |
오류 정보입니다. |
GetCopyAuthorizationOptions |
복사 권한 부여 가져오기 메서드에 대한 옵션입니다. |
GetModelOptions |
모델 정보를 검색하는 옵션입니다. |
GetOperationOptions |
작업 상태를 검색하는 옵션입니다. |
GetResourceDetailsOptions |
Form Recognizer 리소스 정보를 검색하는 옵션입니다. |
HasBoundingPolygon |
단어, 선택 표시 및 선과 같은 간단한 문서 요소는 다각형으로 제한됩니다. |
InnerError |
자세한 오류입니다. |
ListModelsOptions |
모델을 나열하는 옵션입니다. |
ListOperationsOptions |
작업을 나열하는 옵션입니다. |
ModelAdministrationOperationStateCommon |
모든 관리 작업에 공통적인 필드 집합입니다. |
OperationDetails |
작업 응답 개체를 가져옵니다. |
OperationSummary |
작업 정보입니다. |
Point2D |
경계 다각형을 정의하는 데 사용되는 점을 나타냅니다. 단위는 'pixel' 또는 'inch'입니다( LengthUnit 참조). |
PollerOptions |
Form Recognizer 클라이언트에서 장기 실행 작업(폴러)에 대한 옵션입니다. |
QuotaDetails |
할당량 사용, 제한 및 다음 재설정 날짜/시간. |
ResourceDetails |
현재 리소스에 대한 일반 정보입니다. |
형식 별칭
AnalysisPoller |
분석 작업의 상태를 추적하는 폴러(장기 실행 연산)로, 결국 모델에 해당하는 결과 형식을 생성합니다. |
AnalyzeResultOperationStatus |
AnalyzeResultOperationStatus에 대한 값을 정의합니다. |
DocumentBarcodeKind |
DocumentBarcodeKind에 대한 값을 정의합니다. 서비스에서 지원하는 알려진 값QRCode: ISO/IEC 18004:2015에 정의된 QR 코드입니다. |
DocumentBuildMode |
DocumentBuildMode에 대한 값을 정의합니다. 서비스에서 지원하는 알려진 값템플릿: 유사한 시각적 템플릿이 있는 대상 문서입니다. |
DocumentClassifierPoller |
사용자 지정 분류자 만들기 작업의 상태를 추적하여 결국 DocumentClassifierDetails를 생성하는 장기 실행 작업(폴러)입니다. |
DocumentClassifierSource |
문서 분류자를 작성하는 데 사용할 수 있는 콘텐츠 원본입니다. 다음 중 하나:
|
DocumentField |
추출된 필드입니다. 속성은 |
DocumentFieldType |
DocumentFieldType에 대한 값을 정의합니다. 서비스에서 지원하는 알려진 값string: 일반 텍스트입니다. |
DocumentFormulaKind |
DocumentFormulaKind에 대한 값을 정의합니다. 서비스에서 지원하는 알려진 값inline: 단락의 내용 내에 포함된 수식입니다. |
DocumentModelBuildMode |
지원되는 모델 빌드 모드. 모델 빌드 모드는 서비스에서 레이블이 지정된 학습 데이터를 기반으로 모델을 학습하는 데 사용하는 엔진을 선택합니다. 옵션은 다음과 같습니다.
자세한 내용은 다음 링크를 참조하세요. https://aka.ms/azsdk/formrecognizer/buildmode |
DocumentModelPoller |
모델 만들기 작업의 상태를 추적하는 장기 실행 작업(폴러)이며, 결국 DocumentModelDetails를 생성합니다. |
DocumentModelSource |
문서 모델을 빌드하는 데 사용할 수 있는 콘텐츠 원본입니다. 다음 중 하나:
|
DocumentSignatureType |
DocumentSignatureType에 대한 값을 정의합니다. 서비스에서 지원하는 알려진 값signed: 서명이 검색되었습니다. |
DocumentTableCellKind |
DocumentTableCellKind에 대한 값을 정의합니다. 서비스에서 지원하는 알려진 값content: 기본 콘텐츠/데이터를 포함합니다. |
FontStyle |
FontStyle의 값을 정의합니다. 서비스에서 지원하는 알려진 값normal: 문자가 정상적으로 표시됩니다. |
FontWeight |
FontWeight에 대한 값을 정의합니다. 서비스에서 지원하는 알려진 값normal: 문자가 정상적으로 표시됩니다. |
FormRecognizerFeature |
요청에 대해 사용하도록 설정할 수 있는 추가 기능(기능)입니다. Form Recognizer 사용할 수 있는 기능에 대한 자세한 내용은 서비스 설명서를 참조하세요. |
FormRecognizerRequestBody |
Form Recognizer 서비스에 이진 데이터로 업로드할 수 있는 요청 입력입니다. Form Recognizer 입력을 |
LengthUnit |
LengthUnit에 대한 값을 정의합니다. 서비스에서 지원하는 알려진 값pixel: 이미지 파일의 길이 단위입니다. |
OperationDetailsUnion |
여러 유형의 Form Recognizer 관리 작업에 대한 세부 정보입니다. |
OperationKind |
OperationKind에 대한 값을 정의합니다. 서비스에서 지원하는 알려진 값documentModelBuild: 새 사용자 지정 문서 모델을 빌드합니다. |
OperationStatus |
OperationStatus에 대한 값을 정의합니다. |
ParagraphRole |
ParagraphRole에 대한 값을 정의합니다. 서비스에서 지원하는 알려진 값pageHeader: 페이지의 위쪽 가장자리 근처에 있는 텍스트입니다. |
SelectionMarkState |
SelectionMarkState에 대한 값을 정의합니다. 서비스에서 지원하는 알려진 값selected: 선택 표시가 선택되며, 선택 표시 내에 검사 ✓ 또는 크로스 X로 표시되는 경우가 많습니다. |
StringIndexType |
Form Recognizer 서비스 및 SDK 클라이언트에서 지원하는 유효한 문자열 인덱스 형식입니다. |
열거형
KnownDocumentBarcodeKind |
서비스에서 허용하는 DocumentBarcodeKind 의 알려진 값입니다. |
KnownDocumentBuildMode |
서비스에서 허용하는 DocumentBuildMode 의 알려진 값입니다. |
KnownDocumentFieldType |
서비스에서 허용하는 DocumentFieldType 의 알려진 값입니다. |
KnownDocumentFormulaKind |
서비스에서 허용하는 DocumentFormulaKind 의 알려진 값입니다. |
KnownDocumentSignatureType |
서비스에서 허용하는 DocumentSignatureType 의 알려진 값입니다. |
KnownDocumentTableCellKind |
서비스에서 허용하는 DocumentTableCellKind 의 알려진 값입니다. |
KnownFontStyle |
서비스에서 허용하는 FontStyle 의 알려진 값입니다. |
KnownFontWeight |
서비스에서 허용하는 FontWeight 의 알려진 값입니다. |
KnownLengthUnit |
서비스에서 허용하는 LengthUnit 의 알려진 값입니다. |
KnownOperationKind |
서비스에서 허용하는 OperationKind 의 알려진 값입니다. |
KnownParagraphRole |
서비스에서 허용하는 ParagraphRole 의 알려진 값입니다. |
KnownSelectionMarkState |
서비스에서 허용하는 SelectionMarkState 의 알려진 값입니다. |