Document Models - Build Model

Service:

Azure AI Services

API Version:

2024-02-29-preview

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

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

URI 매개 변수

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

요청 본문

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 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

예제

Build Document Model

Sample Request

HTTP

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

{
  "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/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2024-02-29-preview

정의

Name	Description
AzureBlobContentSource	콘텐츠를 Azure Blob Storage.
AzureBlobFileListContentSource	Azure Blob Storage 파일 목록입니다.
BuildDocumentModelRequest	새 사용자 지정 문서 모델을 빌드하도록 본문을 요청합니다.
DocumentBuildMode	사용자 지정 문서 모델 빌드 모드입니다.
Error	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

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