Miscellaneous - Get Operation

Service:

Azure AI Services

API Version:

2023-07-31

작업 정보를 가져옵니다.

GET {endpoint}/formrecognizer/operations/{operationId}?api-version=2023-07-31

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
endpoint	path	True	string url	지원되는 Cognitive Services 엔드포인트(프로토콜 및 호스트 이름( 예: https://westus2.api.cognitive.microsoft.com).
operationId	path	True	string uuid	고유 작업 ID입니다. Regex pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
api-version	query	True	string	요청된 API 버전입니다.

요청 헤더

Name	필수	형식	Description
Ocp-Apim-Subscription-Key	True	string	Azure Cognitive Services 구독의 비밀 키입니다.

응답

Name	형식	Description
200 OK	OperationDetails: DocumentModelBuildOperationDetails DocumentModelComposeOperationDetails DocumentModelCopyToOperationDetails DocumentClassifierBuildOperationDetails	OK.
Other Status Codes	ErrorResponse	오류가 발생했습니다.

보안

Ocp-Apim-Subscription-Key

Azure Cognitive Services 구독의 비밀 키입니다.

Type: apiKey
In: header

예제

Get Operation

Sample Request

HTTP

GET https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2023-07-31

Sample Response

Status code:

200

{
  "operationId": "31533879936_426a3e4c-c6fb-4c83-937c-a92414c371a4",
  "status": "succeeded",
  "percentCompleted": 100,
  "createdDateTime": "2021-09-23T09:12:57Z",
  "lastUpdatedDateTime": "2021-09-23T09:13:01Z",
  "kind": "documentModelBuild",
  "resourceLocation": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/myCustomModel",
  "result": {
    "modelId": "myCustomModel",
    "description": "Custom model description",
    "createdDateTime": "2021-09-23T09:13:01Z",
    "apiVersion": "2023-07-31"
  }
}

정의

Name	Description
AzureBlobContentSource	콘텐츠를 Azure Blob Storage.
AzureBlobFileListContentSource	Azure Blob Storage 파일 목록입니다.
ClassifierDocumentTypeDetails	분류자 문서 형식 정보입니다.
DocumentBuildMode	사용자 지정 문서 모델 빌드 모드입니다.
DocumentClassifierBuildOperationDetails	작업 응답 개체를 가져옵니다.
DocumentClassifierDetails	문서 분류자 정보입니다.
DocumentFieldSchema	JSON 스키마 스타일 구문을 사용하는 필드 의미 체계 스키마에 대한 설명입니다.
DocumentFieldType	필드 값의 의미 체계 데이터 형식입니다.
DocumentModelBuildOperationDetails	작업 응답 개체를 가져옵니다.
DocumentModelComposeOperationDetails	작업 응답 개체를 가져옵니다.
DocumentModelCopyToOperationDetails	작업 응답 개체를 가져옵니다.
DocumentModelDetails	문서 모델 정보입니다.
DocumentTypeDetails	문서 형식 정보입니다.
Error	오류 정보입니다.
ErrorResponse	오류 응답 개체입니다.
InnerError	자세한 오류입니다.
OperationStatus	작업 상태입니다.

AzureBlobContentSource

콘텐츠를 Azure Blob Storage.

Name	형식	Description
containerUrl	string	컨테이너 URL을 Azure Blob Storage.
prefix	string	Blob 이름 접두사입니다.

AzureBlobFileListContentSource

Azure Blob Storage 파일 목록입니다.

Name	형식	Description
containerUrl	string	컨테이너 URL을 Azure Blob Storage.
fileList	string	학습을 위해 문서의 하위 집합을 지정하는 컨테이너 내의 JSONL 파일 경로입니다.

ClassifierDocumentTypeDetails

분류자 문서 형식 정보입니다.

Name	형식	Description
azureBlobFileListSource	AzureBlobFileListContentSource	분류자 문서 형식에 대한 학습 데이터를 지정하는 파일 목록을 Azure Blob Storage. azureBlobSource 또는 azureBlobFileListSource를 지정해야 합니다.
azureBlobSource	AzureBlobContentSource	분류자 문서 형식에 대한 학습 데이터를 포함하는 Azure Blob Storage 위치입니다. azureBlobSource 또는 azureBlobFileListSource를 지정해야 합니다.

DocumentBuildMode

사용자 지정 문서 모델 빌드 모드입니다.

Name	형식	Description
neural	string	다양한 시각적 템플릿이 있는 문서를 지원합니다.
template	string	유사한 시각적 템플릿을 사용하여 문서를 대상으로 지정합니다.

DocumentClassifierBuildOperationDetails

작업 응답 개체를 가져옵니다.

Name	형식	Description
apiVersion	string	이 작업을 만드는 데 사용되는 API 버전입니다.
createdDateTime	string	작업을 만든 날짜 및 시간(UTC)입니다.
error	Error	오류가 발생했습니다.
kind	string: documentClassifierBuild	작업 유형입니다.
lastUpdatedDateTime	string	상태 마지막으로 업데이트된 날짜 및 시간(UTC)입니다.
operationId	string	OperationID
percentCompleted	integer	작업 진행률(0-100).
resourceLocation	string	이 작업의 대상이 되는 리소스의 URL입니다.
result	DocumentClassifierDetails	성공 시 작업 결과입니다.
status	OperationStatus	작업 상태입니다.
tags	object	문서 모델과 연결된 키-값 태그 특성 목록입니다.

DocumentClassifierDetails

문서 분류자 정보입니다.

Name	형식	Description
apiVersion	string	이 문서 분류자를 만드는 데 사용되는 API 버전입니다.
classifierId	string	고유한 문서 분류자 이름입니다.
createdDateTime	string	문서 분류자를 만든 날짜 및 시간(UTC)입니다.
description	string	문서 분류자 설명입니다.
docTypes	<string,  ClassifierDocumentTypeDetails>	분류할 문서 형식 목록입니다.
expirationDateTime	string	문서 분류자의 만료 날짜 및 시간(UTC)입니다.

DocumentFieldSchema

JSON 스키마 스타일 구문을 사용하는 필드 의미 체계 스키마에 대한 설명입니다.

Name	형식	Description
description	string	필드 설명입니다.
example	string	예제 필드 콘텐츠입니다.
items	DocumentFieldSchema	각 배열 요소의 필드 형식 스키마입니다.
properties	<string,  DocumentFieldSchema>	개체 필드의 명명된 하위 필드입니다.
type	DocumentFieldType	필드 값의 의미 체계 데이터 형식입니다.

DocumentFieldType

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

Name	형식	Description
address	string	구문 분석된 주소입니다.
array	string	동일한 형식의 하위 필드 목록입니다.
boolean	string	true 또는 false로 정규화된 부울 값입니다.
countryRegion	string	국가/지역, ISO 3166-1 alpha-3 형식(예: 미국)으로 정규화됩니다.
currency	string	선택적 통화 기호 및 단위가 있는 통화 금액입니다.
date	string	ISO 8601(YYYY-MM-DD) 형식으로 정규화된 날짜입니다.
integer	string	부호 있는 64비트 정수로 정규화된 정수입니다.
number	string	배정밀도 부동 소수점으로 정규화된 부동 소수점 수입니다.
object	string	잠재적으로 다른 유형의 하위 필드의 명명된 목록입니다.
phoneNumber	string	E.164(+{CountryCode}{SubscriberNumber}) 형식으로 정규화된 전화 번호입니다.
selectionMark	string	필드가 선택되었나요?
signature	string	서명이 있나요?
string	string	일반 텍스트입니다.
time	string	ISO 8601(hh:mm:ss) 형식으로 정규화된 시간입니다.

DocumentModelBuildOperationDetails

작업 응답 개체를 가져옵니다.

Name	형식	Description
apiVersion	string	이 작업을 만드는 데 사용되는 API 버전입니다.
createdDateTime	string	작업을 만든 날짜 및 시간(UTC)입니다.
error	Error	오류가 발생했습니다.
kind	string: documentModelBuild	작업 유형입니다.
lastUpdatedDateTime	string	상태 마지막으로 업데이트된 날짜 및 시간(UTC)입니다.
operationId	string	OperationID
percentCompleted	integer	작업 진행률(0-100).
resourceLocation	string	이 작업의 대상이 되는 리소스의 URL입니다.
result	DocumentModelDetails	성공 시 작업 결과입니다.
status	OperationStatus	작업 상태입니다.
tags	object	문서 모델과 연결된 키-값 태그 특성 목록입니다.

DocumentModelComposeOperationDetails

작업 응답 개체를 가져옵니다.

Name	형식	Description
apiVersion	string	이 작업을 만드는 데 사용되는 API 버전입니다.
createdDateTime	string	작업을 만든 날짜 및 시간(UTC)입니다.
error	Error	오류가 발생했습니다.
kind	string: documentModelCompose	작업 유형입니다.
lastUpdatedDateTime	string	상태 마지막으로 업데이트된 날짜 및 시간(UTC)입니다.
operationId	string	OperationID
percentCompleted	integer	작업 진행률(0-100).
resourceLocation	string	이 작업의 대상이 되는 리소스의 URL입니다.
result	DocumentModelDetails	성공 시 작업 결과입니다.
status	OperationStatus	작업 상태입니다.
tags	object	문서 모델과 연결된 키-값 태그 특성 목록입니다.

DocumentModelCopyToOperationDetails

작업 응답 개체를 가져옵니다.

Name	형식	Description
apiVersion	string	이 작업을 만드는 데 사용되는 API 버전입니다.
createdDateTime	string	작업을 만든 날짜 및 시간(UTC)입니다.
error	Error	오류가 발생했습니다.
kind	string: documentModelCopyTo	작업 유형입니다.
lastUpdatedDateTime	string	상태 마지막으로 업데이트된 날짜 및 시간(UTC)입니다.
operationId	string	OperationID
percentCompleted	integer	작업 진행률(0-100).
resourceLocation	string	이 작업의 대상이 되는 리소스의 URL입니다.
result	DocumentModelDetails	성공 시 작업 결과입니다.
status	OperationStatus	작업 상태입니다.
tags	object	문서 모델과 연결된 키-값 태그 특성 목록입니다.

DocumentModelDetails

문서 모델 정보입니다.

Name	형식	Description
apiVersion	string	이 문서 모델을 만드는 데 사용되는 API 버전입니다.
createdDateTime	string	문서 모델을 만든 날짜 및 시간(UTC)입니다.
description	string	문서 모델 설명입니다.
docTypes	<string,  DocumentTypeDetails>	지원되는 문서 유형입니다.
expirationDateTime	string	문서 모델이 만료되는 날짜 및 시간(UTC)입니다.
modelId	string	고유한 문서 모델 이름입니다.
tags	object	문서 모델과 연결된 키-값 태그 특성 목록입니다.

DocumentTypeDetails

문서 형식 정보입니다.

Name	형식	Description
buildMode	DocumentBuildMode	사용자 지정 문서 모델 빌드 모드입니다.
description	string	문서 모델 설명입니다.
fieldConfidence	object	각 필드에 대한 예상 신뢰도입니다.
fieldSchema	<string,  DocumentFieldSchema>	JSON 스키마 스타일 구문을 사용하는 문서 의미 체계 스키마에 대한 설명입니다.

Error

오류 정보입니다.

Name	형식	Description
code	string	오류 코드
details	Error[]	자세한 오류 목록입니다.
innererror	InnerError	자세한 오류입니다.
message	string	오류 메시지입니다.
target	string	오류의 대상입니다.

ErrorResponse

오류 응답 개체입니다.

Name	형식	Description
error	Error	오류 정보입니다.

InnerError

자세한 오류입니다.

Name	형식	Description
code	string	오류 코드
innererror	InnerError	자세한 오류입니다.
message	string	오류 메시지입니다.

OperationStatus

작업 상태입니다.

Name	형식	Description
canceled	string	작업이 취소되었습니다.
failed	string	작업이 실패했습니다.
notStarted	string	작업이 아직 시작되지 않았습니다.
running	string	작업이 진행 중입니다.
succeeded	string	작업이 성공했습니다.