Analyzer - Get Analyze Layout Result

참조

서비스:: Azure AI Services

API 버전:: 2.1

진행 상황을 추적하고 레이아웃 분석 작업의 결과를 획득합니다.

GET {endpoint}/formrecognizer/v2.1/layout/analyzeResults/{resultId}

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
endpoint	path	True	string	지원되는 Cognitive Services 엔드포인트(프로토콜 및 호스트 이름( 예: https://westus2.api.cognitive.microsoft.com).
resultId	path	True	string uuid	작업 결과 식별자를 분석합니다.

요청 헤더

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

응답

Name	형식	Description
200 OK	AnalyzeOperationResult	Success
Other Status Codes	ErrorResponse	오류에 대한 추가 세부 정보를 포함하는 성공하지 못한 응답과 함께 제공되는 응답 엔터티입니다.

보안

Ocp-Apim-Subscription-Key

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

예제

Get analyze layout result

샘플 요청

HTTP

GET {endpoint}/formrecognizer/v2.1/layout/analyzeResults/3b1e6c5b-e113-4114-ab6b-ce65dfe8050f

샘플 응답

상태 코드:: 200

{
  "status": "succeeded",
  "createdDateTime": "2019-05-01T10:53:21Z",
  "lastUpdatedDateTime": "2019-05-01T10:53:23Z",
  "analyzeResult": {
    "version": "v2.1",
    "readResults": [],
    "pageResults": []
  }
}

정의

Name	Description
AnalyzeOperationResult	큐에 대기된 분석 작업의 상태 및 결과입니다.
AnalyzeResult	작업 결과를 분석합니다.
Appearance	텍스트 줄의 모양을 나타내는 개체입니다.
DataTable	페이지에 포함된 추출된 테이블에 대한 정보입니다.
DataTableCell	표에서 추출된 셀에 대한 정보입니다.
DocumentResult	입력 문서에 해당하는 추출된 필드 집합입니다.
ErrorInformation
ErrorResponse
FieldValue	인식된 필드 값입니다.
FieldValueType	필드 값의 의미 체계 데이터 형식입니다.
KeyValueElement	키-값 쌍의 추출된 키 또는 값에 대한 정보입니다.
KeyValuePair	추출된 키-값 쌍에 대한 정보입니다.
KeyValueType	키 값 요소의 의미 체계 데이터 형식입니다.
LengthUnit	너비, 높이 및 boundingBox 속성에 사용되는 단위입니다. 이미지의 경우 단위는 "pixel"입니다. PDF의 경우 단위는 "인치"입니다.
OperationStatus	큐에 대기된 작업의 상태입니다.
PageResult	단일 페이지에서 추출된 정보입니다.
ReadResult	입력 문서의 페이지에서 추출된 텍스트입니다.
SelectionMark	추출된 선택 표시에 대한 정보입니다.
Style	텍스트 줄의 스타일을 나타내는 개체입니다.
TextLine	추출된 텍스트 줄을 나타내는 개체입니다.
TextStyle	필기 및 기타를 포함한 텍스트 줄 스타일 이름입니다.
TextWord	단어를 나타내는 개체입니다.

AnalyzeOperationResult

큐에 대기된 분석 작업의 상태 및 결과입니다.

Name	형식	Description
analyzeResult	AnalyzeResult	분석 작업의 결과입니다.
createdDateTime	string	분석 작업이 제출된 날짜 및 시간(UTC)입니다.
lastUpdatedDateTime	string	상태 마지막으로 업데이트된 날짜 및 시간(UTC)입니다.
status	OperationStatus	작업 상태입니다.

AnalyzeResult

작업 결과를 분석합니다.

Name	형식	Description
documentResults	DocumentResult[]	입력에서 추출된 문서 수준 정보입니다.
errors	ErrorInformation[]	분석 작업 중에 보고된 오류 목록입니다.
pageResults	PageResult[]	입력에서 추출된 페이지 수준 정보입니다.
readResults	ReadResult[]	입력에서 추출된 텍스트입니다.
version	string	이 결과에 사용되는 스키마의 버전입니다.

Appearance

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

Name	형식	Description
style	Style	텍스트 줄의 스타일을 나타내는 개체입니다.

DataTable

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

Name	형식	Description
boundingBox	number[]	테이블의 경계 상자입니다.
cells	DataTableCell[]	표에 포함된 셀 목록입니다.
columns	integer	열의 수입니다.
rows	integer	행 수입니다.

DataTableCell

표에서 추출된 셀에 대한 정보입니다.

Name	형식	Default value	Description
boundingBox	number[]		셀의 경계 상자입니다.
columnIndex	integer		셀의 열 인덱스입니다.
columnSpan	integer	1	이 셀에 걸쳐 있는 열 수입니다.
confidence	number		신뢰도 값입니다.
elements	string[]		includeTextDetails가 true로 설정된 경우 이 표 셀을 구성하는 텍스트 요소에 대한 참조 목록입니다.
isFooter	boolean	False	현재 셀이 바닥글 셀인가요?
isHeader	boolean	False	현재 셀이 머리글 셀인가요?
rowIndex	integer		셀의 행 인덱스입니다.
rowSpan	integer	1	이 셀에 걸쳐 있는 행 수입니다.
text	string		셀의 텍스트 내용입니다.

DocumentResult

입력 문서에 해당하는 추출된 필드 집합입니다.

Name	형식	Description
docType	string	문서 형식입니다.
docTypeConfidence	number	예측된 문서 형식 신뢰도입니다.
fields	<string, FieldValue>	명명된 필드 값의 사전입니다.
modelId	string	모델 식별자입니다.
pageRange	integer[]	문서가 있는 첫 번째 및 마지막 페이지 번호입니다.

ErrorInformation

Name	형식	Description
code	string
message	string

ErrorResponse

Name	형식	Description
error	ErrorInformation

FieldValue

인식된 필드 값입니다.

Name	형식	Description
boundingBox	number[]	필드 값의 경계 상자(해당하는 경우)입니다.
confidence	number	신뢰도 점수.
elements	string[]	includeTextDetails가 true로 설정된 경우 이 필드를 구성하는 텍스트 요소에 대한 참조 목록입니다.
page	integer	입력 문서의 1 기반 페이지 번호입니다.
text	string	추출된 필드의 텍스트 콘텐츠입니다.
type	FieldValueType	필드 값의 형식입니다.
valueArray	FieldValue[]	필드 값의 배열입니다.
valueCountryRegion	string	3자 국가 코드(ISO 3166-1 alpha-3).
valueDate	string	날짜 값입니다.
valueInteger	integer	정수 값.
valueNumber	number	부동 소수점 값입니다.
valueObject	<string, FieldValue>	명명된 필드 값의 사전입니다.
valuePhoneNumber	string	전화 번호 값입니다.
valueSelectionMark	enum: selected unselected	선택 표시 값입니다.
valueString	string	문자열 값입니다.
valueTime	string	시간 값입니다.

FieldValueType

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

Name	형식	Description
array	string
countryRegion	string
date	string
integer	string
number	string
object	string
phoneNumber	string
selectionMark	string
string	string
time	string

KeyValueElement

키-값 쌍의 추출된 키 또는 값에 대한 정보입니다.

Name	형식	Description
boundingBox	number[]	키 또는 값의 경계 상자입니다.
elements	string[]	includeTextDetails가 true로 설정된 경우 이 키 또는 값을 구성하는 텍스트 요소에 대한 참조 목록입니다.
text	string	키 또는 값의 텍스트 콘텐츠입니다.
type	KeyValueType	키 값 요소의 의미 체계 데이터 형식입니다.

KeyValuePair

추출된 키-값 쌍에 대한 정보입니다.

Name	형식	Description
confidence	number	신뢰도 값입니다.
key	KeyValueElement	키-값 쌍의 추출된 키에 대한 정보입니다.
label	string	키/값 쌍 항목에 대한 사용자 정의 레이블입니다.
value	KeyValueElement	키-값 쌍의 추출된 값에 대한 정보입니다.

KeyValueType

키 값 요소의 의미 체계 데이터 형식입니다.

Name	형식	Description
selectionMark	string
string	string

LengthUnit

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

Name	형식	Description
inch	string
pixel	string

OperationStatus

큐에 대기된 작업의 상태입니다.

Name	형식	Description
failed	string
notStarted	string
running	string
succeeded	string

PageResult

단일 페이지에서 추출된 정보입니다.

Name	형식	Description
clusterId	integer	클러스터 식별자입니다.
keyValuePairs	KeyValuePair[]	페이지에서 추출된 키-값 쌍 목록입니다.
page	integer	페이지 번호입니다.
tables	DataTable[]	페이지에서 추출된 데이터 테이블 목록입니다.

ReadResult

입력 문서의 페이지에서 추출된 텍스트입니다.

Name	형식	Description
angle	number	(-180, 180] 사이의 각도로 측정된 시계 방향으로 텍스트의 일반 방향입니다.
height	number	이미지/PDF의 높이(각각 픽셀/인치)입니다.
lines	TextLine[]	includeTextDetails가 true로 설정되면 인식된 텍스트 줄 목록이 표시됩니다. 반환되는 최대 줄 수는 페이지당 300개입니다. 특정 경우에는 근접이 더 높은 우선 순위로 처리되지만 선은 위에서 아래로, 왼쪽에서 오른쪽으로 정렬됩니다. 정렬 순서는 검색된 텍스트에 따라 달라지으므로 이미지 및 OCR 버전 업데이트 간에 변경될 수 있습니다. 따라서 비즈니스 논리는 주문이 아닌 실제 라인 위치를 기반으로 구축되어야 합니다.
page	integer	입력 문서의 1 기반 페이지 번호입니다.
selectionMarks	SelectionMark[]	페이지에서 추출된 선택 표시 목록입니다.
unit	LengthUnit	너비, 높이 및 boundingBox 속성에 사용되는 단위입니다. 이미지의 경우 단위는 "pixel"입니다. PDF의 경우 단위는 "인치"입니다.
width	number	이미지/PDF의 너비(각각 픽셀/인치)입니다.

SelectionMark

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

Name	형식	Description
boundingBox	number[]	선택 표시의 경계 상자입니다.
confidence	number	신뢰도 값입니다.
state	enum: selected unselected	선택 표시의 상태입니다.

Style

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

Name	형식	Description
confidence	number	텍스트 선 스타일의 신뢰도입니다.
name	TextStyle	필기 및 기타를 포함한 텍스트 줄 스타일 이름입니다.

TextLine

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

Name	형식	Description
appearance	Appearance	텍스트 모양 속성입니다.
boundingBox	number[]	추출된 줄의 경계 상자입니다.
text	string	줄의 텍스트 내용입니다.
words	TextWord[]	텍스트 줄의 단어 목록입니다.

TextStyle

필기 및 기타를 포함한 텍스트 줄 스타일 이름입니다.

Name	형식	Description
handwriting	string
other	string

TextWord

단어를 나타내는 개체입니다.

Name	형식	Description
boundingBox	number[]	추출된 단어의 경계 상자입니다.
confidence	number	신뢰도 값입니다.
text	string	단어의 텍스트 내용입니다.

다음을 통해 공유