Document Models - Compose Model

Service:

Azure AI Services

API Version:

2024-02-29-preview

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

POST {endpoint}/documentintelligence/documentModels:compose?api-version=2024-02-29-preview

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
endpoint	path	True	string	Document Intelligence 서비스 엔드포인트입니다.
api-version	query	True	string	이 작업에 사용할 API 버전입니다.

요청 본문

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

응답

Name	형식	Description
202 Accepted		처리를 위해 요청이 수락되었지만 처리가 아직 완료되지 않았습니다. Headers Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	예기치 않은 오류 응답입니다.

보안

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Flow: accessCode
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Scopes

Name	Description
https://cognitiveservices.azure.com/.default

예제

Compose Document Model

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels:compose?api-version=2024-02-29-preview

{
  "modelId": "composedModel",
  "description": "Composed model description",
  "componentModels": [
    {
      "modelId": "model1"
    },
    {
      "modelId": "model2"
    }
  ]
}

Sample Response

Status code:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2024-02-29-preview

정의

Name	Description
ComponentDocumentModelDetails	구성된 문서 모델의 구성 요소입니다.
ComposeDocumentModelRequest	구성 요소 문서 모델에서 구성된 문서 모델을 만들도록 본문을 요청합니다.
Error	Error 개체.
ErrorResponse	오류 응답 개체입니다.
InnerError	오류에 대한 보다 구체적인 정보를 포함하는 개체입니다.

ComponentDocumentModelDetails

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

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

ComposeDocumentModelRequest

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

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

Error

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	사람이 읽을 수 있는 오류 표현입니다.