Document Models - Compose Model

Service:

Azure AI Services

API Version:

2022-08-31

기존 문서 모델의 문서 형식에서 새 문서 모델을 만듭니다.

POST {endpoint}/formrecognizer/documentModels:compose?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
componentModels	True	ComponentDocumentModelDetails[]	작성할 구성 요소 문서 모델 목록입니다.
modelId	True	string	고유한 문서 모델 이름입니다.
description		string	문서 모델 설명입니다.
tags		object	문서 모델과 연결된 키-값 태그 특성 목록입니다.

응답

Name	형식	Description
202 Accepted		요청이 성공적으로 큐에 대기됩니다. Headers Operation-Location: string
Other Status Codes	ErrorResponse	오류가 발생했습니다.

보안

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

예제

ComposeDocumentModel

Sample Request

HTTP

POST {endpoint}/formrecognizer/documentModels:compose?api-version=2022-08-31

{
  "modelId": "{composedModelId}",
  "description": "{composedModelDescription}",
  "componentModels": [
    {
      "modelId": "{modelId1}"
    },
    {
      "modelId": "{modelId2}"
    }
  ]
}

Sample Response

Status code:

202

Operation-Location: {endpoint}/formrecognizer/operations/{operationId}?api-version=2022-08-31

정의

Name	Description
ApiVersion	API 버전.
ComponentDocumentModelDetails	구성된 문서 모델의 구성 요소입니다.
ComposeDocumentModelRequest	구성 요소 문서 모델에서 구성된 문서 모델을 만들도록 본문을 요청합니다.
Error	오류 정보입니다.
ErrorResponse	오류 응답 개체입니다.
InnerError	자세한 오류입니다.

ApiVersion

API 버전.

Name	형식	Description
2022-08-31	string

ComponentDocumentModelDetails

구성된 문서 모델의 구성 요소입니다.

Name	형식	Description
modelId	string	고유한 문서 모델 이름입니다.

ComposeDocumentModelRequest

구성 요소 문서 모델에서 구성된 문서 모델을 만들도록 본문을 요청합니다.

Name	형식	Description
componentModels	ComponentDocumentModelDetails[]	작성할 구성 요소 문서 모델 목록입니다.
description	string	문서 모델 설명입니다.
modelId	string	고유한 문서 모델 이름입니다.
tags	object	문서 모델과 연결된 키-값 태그 특성 목록입니다.

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	오류 메시지입니다.