Document Models - Build Model

Service:

Azure AI Services

API Version:

2023-07-31

사용자 지정 문서 분석 모델을 빌드합니다.

POST {endpoint}/formrecognizer/documentModels:build?api-version=2023-07-31

URI 매개 변수

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

요청 헤더

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

요청 본문

Name	필수	형식	Description
buildMode	True	DocumentBuildMode	사용자 지정 문서 모델 빌드 모드입니다.
modelId	True	string	고유한 문서 모델 이름입니다.
azureBlobFileListSource		AzureBlobFileListContentSource	학습 데이터를 지정하는 파일 목록을 Azure Blob Storage. azureBlobSource 또는 azureBlobFileListSource를 지정해야 합니다.
azureBlobSource		AzureBlobContentSource	학습 데이터를 포함하는 위치를 Azure Blob Storage. azureBlobSource 또는 azureBlobFileListSource를 지정해야 합니다.
description		string	문서 모델 설명입니다.
tags		object	문서 모델과 연결된 키-값 태그 특성 목록입니다.

응답

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

보안

Ocp-Apim-Subscription-Key

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

Type: apiKey
In: header

예제

Build Document Model

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels:build?api-version=2023-07-31

{
  "modelId": "myCustomModel",
  "description": "Custom model description",
  "buildMode": "template",
  "azureBlobSource": {
    "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken",
    "prefix": "trainingDocs/"
  },
  "tags": {
    "createdBy": "myUserId"
  }
}

Sample Response

Status code:

202

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

정의

Name	Description
AzureBlobContentSource	콘텐츠를 Azure Blob Storage.
AzureBlobFileListContentSource	Azure Blob Storage 파일 목록입니다.
BuildDocumentModelRequest	새 사용자 지정 문서 모델을 빌드하기 위한 요청 본문입니다.
DocumentBuildMode	사용자 지정 문서 모델 빌드 모드입니다.
Error	오류 정보입니다.
ErrorResponse	오류 응답 개체입니다.
InnerError	자세한 오류입니다.

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 파일 경로입니다.

BuildDocumentModelRequest

새 사용자 지정 문서 모델을 빌드하기 위한 요청 본문입니다.

Name	형식	Description
azureBlobFileListSource	AzureBlobFileListContentSource	학습 데이터를 지정하는 파일 목록을 Azure Blob Storage. azureBlobSource 또는 azureBlobFileListSource를 지정해야 합니다.
azureBlobSource	AzureBlobContentSource	학습 데이터를 포함하는 위치를 Azure Blob Storage. azureBlobSource 또는 azureBlobFileListSource를 지정해야 합니다.
buildMode	DocumentBuildMode	사용자 지정 문서 모델 빌드 모드입니다.
description	string	문서 모델 설명입니다.
modelId	string	고유한 문서 모델 이름입니다.
tags	object	문서 모델과 연결된 키-값 태그 특성 목록입니다.

DocumentBuildMode

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

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

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