Miscellaneous - List Operations

서비스:

Azure AI Services

API 버전:

2022-08-31

모든 작업을 Lists.

GET {endpoint}/formrecognizer/operations?api-version=2022-08-31

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
endpoint	path	True	string	지원되는 Cognitive Services 엔드포인트(프로토콜 및 호스트 이름( 예: https://westus2.api.cognitive.microsoft.com).
api-version	query	True	ApiVersion	요청된 API 버전입니다.

요청 헤더

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

응답

Name	형식	Description
200 OK	GetOperationsResponse	OK.
Other Status Codes	ErrorResponse	오류가 발생했습니다.

보안

Ocp-Apim-Subscription-Key

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

예제

GetOperations

샘플 요청

HTTP

GET {endpoint}/formrecognizer/operations?api-version=2022-08-31

샘플 응답

상태 코드:

200

{
  "value": [
    {
      "operationId": "{operationId}",
      "status": "running",
      "percentCompleted": 0,
      "createdDateTime": "2021-09-23T09:12:57Z",
      "lastUpdatedDateTime": "2021-09-23T09:12:58Z",
      "kind": "documentModelBuild",
      "resourceLocation": "{endpoint}/formrecognizer/documentModels/{modelId}",
      "apiVersion": "2022-08-31"
    }
  ],
  "nextLink": "{nextLinkUrl}"
}

정의

Name	Description
ApiVersion	API 버전.
Error	오류 정보입니다.
ErrorResponse	오류 응답 개체입니다.
GetOperationsResponse	작업 응답 개체를 나열합니다.
InnerError	자세한 오류입니다.
OperationKind	작업 유형입니다.
OperationStatus	작업 상태입니다.
OperationSummary	작업 정보입니다.

ApiVersion

API 버전.

Name	형식	Description
2022-08-31	string

Error

오류 정보입니다.

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

ErrorResponse

오류 응답 개체입니다.

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

GetOperationsResponse

작업 응답 개체를 나열합니다.

Name	형식	Description
nextLink	string	작업의 다음 페이지에 연결합니다.
value	OperationSummary[]	작업 목록입니다.

InnerError

자세한 오류입니다.

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

OperationKind

작업 유형입니다.

Name	형식	Description
documentModelBuild	string
documentModelCompose	string
documentModelCopyTo	string

OperationStatus

작업 상태입니다.

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

OperationSummary

작업 정보입니다.

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