Custom Models - Analyze Document

서비스:

Azure AI Services

API 버전:

2.1

지정된 문서에서 키-값 쌍, 테이블 및 의미 체계 값을 추출합니다. 입력 문서는 지원되는 콘텐츠 형식 중 하나여야 합니다. 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff' 또는 'image/bmp'. 또는 'application/json' 형식을 사용하여 분석할 문서의 위치(Uri 또는 로컬 경로)를 지정합니다.

POST {endpoint}/formrecognizer/v2.1/custom/models/{modelId}/analyze

선택적 매개 변수:

POST {endpoint}/formrecognizer/v2.1/custom/models/{modelId}/analyze?includeTextDetails={includeTextDetails}&pages={pages}

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
endpoint	path	True	string	지원되는 Cognitive Services 엔드포인트(프로토콜 및 호스트 이름( 예: https://westus2.api.cognitive.microsoft.com).
modelId	path	True	string uuid	모델 식별자입니다.
includeTextDetails	query		boolean	결과에 텍스트 줄 및 요소 참조를 포함합니다.
pages	query		string[]	다중 페이지 문서(PDF/TIFF)에 대한 사용자 지정 페이지 번호는 OCR 결과를 가져올 페이지 수를 입력합니다. 페이지 범위의 경우 하이픈을 사용합니다. 각 페이지 또는 범위를 쉼표로 구분합니다.

요청 헤더

Media Types: "application/pdf", "application/json", "image/jpeg", "image/png", "image/tiff", "image/bmp"

Name	필수	형식	Description
Ocp-Apim-Subscription-Key	True	string

요청 본문

Media Types: "application/pdf", "application/json", "image/jpeg", "image/png", "image/tiff", "image/bmp"

Name	형식	Description
source	string	파일 원본 경로입니다.

응답

Name	형식	Description
202 Accepted		요청이 성공적으로 큐에 대기됩니다. 헤더 Operation-Location: string
Other Status Codes	ErrorResponse	오류에 대한 추가 세부 정보를 포함하는 성공하지 못한 응답과 함께 제공되는 응답 엔터티입니다.

보안

Ocp-Apim-Subscription-Key

형식: apiKey
In(다음 안에): header

예제

Analyze form with custom model

샘플 요청

HTTP

POST {endpoint}/formrecognizer/v2.1/custom/models/f973e3c1-1148-43bb-bea8-49d0603ab3a8/analyze

샘플 응답

상태 코드:

202

Operation-Location: {endpoint}/formrecognizer/v2.1/custom/models/f973e3c1-1148-43bb-bea8-49d0603ab3a8/analyzeResults/3b1e6c5b-e113-4114-ab6b-ce65dfe8050f

정의

Name	Description
ErrorInformation
ErrorResponse
SourcePath	원본 데이터에 대한 Uri 또는 로컬 경로입니다.

ErrorInformation

Name	형식	Description
code	string
message	string

ErrorResponse

Name	형식	Description
error	ErrorInformation

SourcePath

원본 데이터에 대한 Uri 또는 로컬 경로입니다.

Name	형식	Description
source	string	파일 원본 경로입니다.