@azure/ai-form-recognizer package

클래스

AzureKeyCredential	기본 키 값 업데이트를 지원하는 정적 키 기반 자격 증명입니다.
DocumentAnalysisClient	Form Recognizer 서비스의 분석 기능과 상호 작용하기 위한 클라이언트입니다. 예제: Form Recognizer 서비스 및 클라이언트는 두 가지 인증 방법을 지원합니다. 애저 액티브 디렉터리 import { DefaultAzureCredential } from "@azure/identity"; import { DocumentAnalysisClient } from "@azure/ai-form-recognizer"; const credential = new DefaultAzureCredential(); const client = new DocumentAnalysisClient( "https://<resource name>.cognitiveservices.azure.com", credential, ); API 키(구독 키) import { AzureKeyCredential, DocumentAnalysisClient } from "@azure/ai-form-recognizer"; const credential = new AzureKeyCredential("<API key>"); const client = new DocumentAnalysisClient( "https://<resource name>.cognitiveservices.azure.com", credential, );
DocumentModelAdministrationClient	모델 만들기, 읽기, 나열, 삭제 및 복사와 같은 Form Recognizer 서비스의 모델 관리 기능과 상호 작용하기 위한 클라이언트입니다. 예제: 애저 액티브 디렉터리 import { DefaultAzureCredential } from "@azure/identity"; import { DocumentModelAdministrationClient } from "@azure/ai-form-recognizer"; const credential = new DefaultAzureCredential(); const client = new DocumentModelAdministrationClient( "https://<resource name>.cognitiveservices.azure.com", credential, ); API 키(구독 키) import { AzureKeyCredential, DocumentModelAdministrationClient } from "@azure/ai-form-recognizer"; const credential = new AzureKeyCredential("<API key>"); const client = new DocumentModelAdministrationClient( "https://<resource name>.cognitiveservices.azure.com", credential, );

인터페이스

AddressValue	주소 필드 값입니다.
AnalyzeDocumentOptions	문서 분석 작업에 대한 옵션입니다.
AnalyzeResult	분석 작업의 결과입니다. 문서의 형식은 분석을 수행하는 데 사용되는 모델에 의해 결정될 수 있습니다.
AnalyzeResultCommon	LayoutResult, ReadResult 및 GeneralDocumentResult와 같은 모든 AnalyzeResult와 유사한 형식의 공통 필드입니다.
AnalyzedDocument	추출된 문서 개체입니다. AnalyzedDocument는 모델 내에서 문서 형식 중 하나의 인스턴스입니다. 해당 필드는 문서 형식의 필드 스키마에 해당합니다.
AzureBlobFileListSource	Azure Blob 컨테이너 및 컨테이너 내의 JSONL 파일 목록에 의해 정의된 학습 데이터 원본입니다.
AzureBlobFileListSourceDetails	Azure Blob Storage의 파일 목록입니다.
AzureBlobSource	Azure Blob 컨테이너에 의해 정의된 학습 데이터 원본입니다.
AzureBlobSourceDetails	Azure Blob Storage 콘텐츠.
BeginBuildDocumentClassifierOptions	문서 분류자 빌드 작업에 대한 옵션입니다.
BeginBuildDocumentModelOptions	모델 빌드 작업에 대한 옵션입니다.
BeginComposeDocumentModelOptions	모델 작성 작업에 대한 옵션입니다.
BeginCopyModelOptions	모델 복사 작업에 대한 옵션입니다.
BoundingRegion	입력의 특정 페이지에서 다각형 경계
ClassifierDocumentTypeDetails	분류자 문서 형식 정보입니다.
ClassifyDocumentOptions	문서 분류 작업에 대한 옵션입니다.
CommonModelCreationOptions	beginBuildDocumentModel, beginComposeDocumentModel및 getCopyAuthorization같은 새 모델을 정의하는 모든 작업에 공통적인 옵션입니다.
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	날짜 값이 있는 DocumentField입니다.
DocumentFieldCommon	모든 DocumentField 변형에 공통적인 필드입니다.
DocumentFieldSchema	JSON 스키마 스타일 구문을 사용하는 필드 의미 체계 스키마에 대한 설명입니다.
DocumentFootnote	표 각주 위치와 내용을 나타내는 개체입니다.
DocumentFormula	추출된 수식입니다.
DocumentIntegerField	정수 값이 있는 DocumentField입니다.
DocumentKeyValueElement	키-값 쌍의 필드 키 또는 값을 나타내는 개체입니다.
DocumentKeyValuePair	고유 필드 레이블(키) 및 필드 값(비어 있을 수 있음)이 있는 양식 필드를 나타내는 개체입니다.
DocumentLanguage	지정된 텍스트 범위에 대해 검색된 언어를 나타내는 개체입니다.
DocumentLine	단어 및 선택 표시와 같은 인접한 콘텐츠 요소 시퀀스로 구성된 콘텐츠 줄 개체입니다.
DocumentModel	구조화된 문서 추출을 지원하는 잘 알려진 모델 사양입니다. 모델 ID 문자열 대신 이러한 beginAnalyzeDocument 개체를 사용하여 더 강력한 결과 형식을 제공하도록 지원하는 DocumentAnalysisClientDocumentModel 메서드를 참조하세요.
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에 대한 값을 정의합니다. KnownDocumentBarcodeKind DocumentBarcodeKind와 교환하여 사용할 수 이 열거형에는 서비스에서 지원하는 알려진 값이 포함됩니다. 서비스에서 지원하는 알려진 값 QRCode: ISO/IEC 18004:2015에 정의된 QR 코드입니다. PDF417: PDF417( ISO 15438에 정의됨) UPCA: GS1 12자리 유니버설 제품 코드입니다. UPCE: GS1 6자리 유니버설 제품 코드입니다. Code39: ISO/IEC 16388:2007에 정의된 코드 39 바코드입니다. Code128: ISO/IEC 15417:2007에 정의된 코드 128 바코드입니다. EAN8: GS1 8자리 국제 문서 번호(유럽 문서 번호). EAN13: GS1 13자리 국제 문서 번호(유럽 문서 번호). DataBar: GS1 DataBar 바코드. Code93: ANSI/AIM BC5-1995에 정의된 코드 93 바코드입니다. Codabar: ANSI/AIM BC3-1995에 정의된 대로 코다바 바코드입니다. DataBarExpanded: GS1 DataBar 확장 바코드. ITF: ANSI/AIM BC2-1995에 정의된 대로 5개의 바코드 중 인터리브 2입니다. MicroQRCode: ISO/IEC 23941:2022에 정의된 마이크로 QR 코드입니다. Aztec: ISO/IEC 24778:2008에 정의된 Aztec 코드입니다. DataMatrix: ISO/IEC 16022:2006에 정의된 데이터 행렬 코드입니다. MaxiCode: MaxiCode( ISO/IEC 16023:2000에 정의됨)
DocumentBuildMode	DocumentBuildMode에 대한 값을 정의합니다. KnownDocumentBuildMode DocumentBuildMode와 교환하여 사용할 수 이 열거형에는 서비스에서 지원하는 알려진 값이 포함됩니다. 서비스에서 지원하는 알려진 값 템플릿: 유사한 시각적 템플릿을 사용하여 문서를 대상으로 지정합니다. 신경망: 다양한 시각적 템플릿이 있는 문서를 지원합니다.
DocumentClassifierPoller	사용자 지정 분류자 만들기 작업의 상태를 추적하는 폴러(long-running) 연산으로, 결국 DocumentClassifierDetails생성됩니다.
DocumentClassifierSource	문서 분류자를 빌드하는 데 사용할 수 있는 콘텐츠 원본입니다. 다음 중 하나: 블롭 소스 BlobFileListSource
DocumentField	추출된 필드입니다. kind 속성은 DocumentField형식을 식별(구분)합니다.
DocumentFieldType	DocumentFieldType에 대한 값을 정의합니다. KnownDocumentFieldType DocumentFieldType과 교환하여 사용할 수 이 열거형에는 서비스에서 지원하는 알려진 값이 포함됩니다. 서비스에서 지원하는 알려진 값 문자열: 일반 텍스트입니다. 날짜: ISO 8601(YYYY-MM-DD) 형식으로 정규화된 날짜입니다. 시간: ISO 8601(hh:mm:ss) 형식으로 정규화된 시간입니다. phoneNumber: 전화 번호로, E.164(+{CountryCode}{SubscriberNumber}) 형식으로 정규화됩니다. 숫자: 부동 소수점 숫자로, 배정밀도 부동 소수점으로 정규화됩니다. 정수: 64비트 부호 있는 정수로 정규화된 정수입니다. selectionMark: 필드가 선택되었나요? countryRegion: 국가/지역이며 ISO 3166-1 알파-3 형식(예: 미국)으로 정규화됩니다. 서명: 서명이 있나요? 배열: 동일한 형식의 하위 필드 목록입니다. 개체: 잠재적으로 다른 형식의 하위 필드의 명명된 목록입니다. 통화: 선택적 통화 기호 및 단위가 있는 통화 금액입니다. 주소: 구문 분석된 주소입니다. 부울: 부울 값으로, true 또는 false로 정규화됩니다.
DocumentFormulaKind	DocumentFormulaKind에 대한 값을 정의합니다. KnownDocumentFormulaKind DocumentFormulaKind와 교환하여 사용할 수 이 열거형에는 서비스에서 지원하는 알려진 값이 포함됩니다. 서비스에서 지원하는 알려진 값 인라인: 단락 내용에 포함된 수식입니다. 표시: 전체 줄을 차지하는 디스플레이 모드의 수식입니다.
DocumentModelBuildMode	지원되는 모델 빌드 모드입니다. 모델 빌드 모드는 레이블이 지정된 학습 데이터를 기반으로 서비스에서 모델을 학습하는 데 사용하는 엔진을 선택합니다. 옵션은 다음과 같습니다. "신경망"은 데이터 구조가 동일하지만 레이아웃이 다른 문서 클래스에서 데이터를 추출할 수 있는 최고 품질의 모델을 생성합니다(예: 회사마다 다를 수 있지만 항상 동일한 정보를 포함할 수 있는 W2 세금 양식). 모든 문서에 동일한 고정 레이아웃(템플릿)이 있어야 하는 "template"입니다. 자세한 내용은 다음 링크를 참조하세요. https://aka.ms/azsdk/formrecognizer/buildmode
DocumentModelPoller	모델 생성 작업의 상태를 추적하는 장기 실행 작업(폴러)이며, 결국 documentModelDetails 생성됩니다.
DocumentModelSource	문서 모델을 빌드하는 데 사용할 수 있는 콘텐츠 원본입니다. 다음 중 하나: 블롭 소스 BlobFileListSource
DocumentSignatureType	DocumentSignatureType에 대한 값을 정의합니다. KnownDocumentSignatureType DocumentSignatureType과 교환하여 사용할 수 이 열거형에는 서비스에서 지원하는 알려진 값이 포함됩니다. 서비스에서 지원하는 알려진 값 서명된 : 서명이 검색됩니다. 서명되지 않은 : 서명이 검색되지 않습니다.
DocumentTableCellKind	DocumentTableCellKind에 대한 값을 정의합니다. KnownDocumentTableCellKind DocumentTableCellKind와 교환하여 사용할 수 이 열거형에는 서비스에서 지원하는 알려진 값이 포함됩니다. 서비스에서 지원하는 알려진 값 콘텐츠: 기본 콘텐츠/데이터를 포함합니다. rowHeader: 행의 내용을 설명합니다. columnHeader: 열의 내용을 설명합니다. stubHead: 일반적으로 테이블의 왼쪽 위 모서리에 있는 행 머리글을 설명합니다. 설명: 테이블의 (부분) 내용에 대해 설명합니다.
FontStyle	FontStyle의 값을 정의합니다. KnownFontStyle FontStyle과 교환하여 사용할 수 이 열거형에는 서비스에서 지원하는 알려진 값이 포함됩니다. 서비스에서 지원하는 알려진 값 일반: 문자가 정상적으로 표시됩니다. 기울이기 : 문자는 오른쪽에 시각적으로 기울어진 것입니다.
FontWeight	FontWeight에 대한 값을 정의합니다. KnownFontWeight FontWeight와 교환하여 사용할 수 이 열거형에는 서비스에서 지원하는 알려진 값이 포함됩니다. 서비스에서 지원하는 알려진 값 일반: 문자가 정상적으로 표시됩니다. 굵은: 문자는 더 두꺼운 스트로크로 표시됩니다.
FormRecognizerFeature	요청에 사용할 수 있는 추가 기능(기능)입니다. Form Recognizer에서 사용할 수 있는 기능에 대한 자세한 내용은 서비스 설명서를 참조하세요. https://aka.ms/azsdk/formrecognizer/features
FormRecognizerRequestBody	Form Recognizer 서비스에 이진 데이터로 업로드할 수 있는 요청 입력입니다. Form Recognizer는 string 입력을 URL로 처리하므로 문자열을 이진 입력으로 보내려면 먼저 문자열을 다음 입력 형식 중 하나로 변환합니다.
LengthUnit	LengthUnit에 대한 값을 정의합니다. KnownLengthUnit LengthUnit과 교환하여 사용할 수 이 열거형에는 서비스에서 지원하는 알려진 값이 포함됩니다. 서비스에서 지원하는 알려진 값 픽셀: 이미지 파일의 길이 단위입니다. 인치: PDF 파일의 길이 단위입니다.
OperationDetailsUnion	여러 유형의 Form Recognizer 관리 작업에 대한 세부 정보입니다.
OperationKind	OperationKind에 대한 값을 정의합니다. KnownOperationKind OperationKind와 교환하여 사용할 수 이 열거형에는 서비스에서 지원하는 알려진 값이 포함됩니다. 서비스에서 지원하는 알려진 값 documentModelBuild : 새 사용자 지정 문서 모델을 빌드합니다. documentModelCompose : 기존 모델에서 새 사용자 지정 문서 모델을 작성합니다. documentModelCopyTo: 기존 문서 모델을 잠재적으로 다른 리소스, 지역 또는 구독에 복사합니다. documentClassifierBuild : 새 사용자 지정 분류자 모델을 빌드합니다.
OperationStatus	OperationStatus에 대한 값을 정의합니다.
ParagraphRole	ParagraphRole의 값을 정의합니다. KnownParagraphRole ParagraphRole과 교환하여 사용할 수 이 열거형에는 서비스에서 지원하는 알려진 값이 포함됩니다. 서비스에서 지원하는 알려진 값 pageHeader: 페이지의 위쪽 가장자리 근처에 있는 텍스트입니다. pageFooter: 페이지의 아래쪽 가장자리 근처에 있는 텍스트입니다. pageNumber: 페이지 번호입니다. 제목: 전체 문서를 설명하는 최상위 제목입니다. 섹션 머리글: 문서의 섹션을 설명하는 하위 제목입니다. 각주: 일반적으로 페이지의 기본 콘텐츠에 배치되는 메모입니다. formulaBlock: 종종 공유 맞춤이 있는 수식 블록입니다.
SelectionMarkState	SelectionMarkState에 대한 값을 정의합니다. KnownSelectionMarkState SelectionMarkState와 교환하여 사용할 수 이 열거형에는 서비스에서 지원하는 알려진 값이 포함됩니다. 서비스에서 지원하는 알려진 값 선택한 : 선택 표시가 선택되며 선택 표시 내에서 종종 check ✓ 또는 크로스 X로 표시됩니다. 선택되지 않은 : 선택 표시가 선택되지 않았습니다.
StringIndexType	Form Recognizer 서비스 및 SDK 클라이언트에서 지원하는 유효한 문자열 인덱스 형식입니다.

열거형

KnownDocumentBarcodeKind	DocumentBarcodeKind의 알려진 값은 서비스에서 허용하는.
KnownDocumentBuildMode	DocumentBuildMode의 알려진 값은 서비스에서 허용하는.
KnownDocumentFieldType	DocumentFieldType의 알려진 값은 서비스에서 허용하는.
KnownDocumentFormulaKind	DocumentFormulaKind의 알려진 값은 서비스에서 허용하는.
KnownDocumentSignatureType	DocumentSignatureType의 알려진 값은 서비스에서 허용하는.
KnownDocumentTableCellKind	DocumentTableCellKind의 알려진 값은 서비스에서 허용하는.
KnownFontStyle	FontStyle의 알려진 값은 서비스에서 허용하는.
KnownFontWeight	FontWeight의 알려진 값은 서비스에서 허용하는.
KnownFormRecognizerAudience	Form Recognizer에 대해 알려진 클라우드 대상을 정의합니다. TokenCredential 환경에서 Entra Id( 를 사용하여)로 인증하려면 또는 audienceDocumentAnalysisClient를 생성할 때 아래의 DocumentModelAdministrationClient 적절한 값을 옵션으로 제공하십시오. 기본값은 Azure 퍼블릭 클라우드에서 만든 Form Recognizer 리소스에 적합하므로 이 값은 다른 클라우드 환경에서 Form Recognizer를 사용하는 데만 필요합니다.
KnownLengthUnit	LengthUnit의 알려진 값은 서비스에서 허용하는.
KnownOperationKind	OperationKind의 알려진 값은 서비스에서 허용하는.
KnownParagraphRole	ParagraphRole의 알려진 값은 서비스에서 허용하는.
KnownSelectionMarkState	SelectionMarkState의 알려진 값은 서비스에서 허용하는.