Document Models - Compose Model
기존 문서 모델의 문서 형식에서 새 문서 모델을 만듭니다.
POST {endpoint}/documentintelligence/documentModels:compose?api-version=2024-11-30URI 매개 변수
| Name | In(다음 안에) | 필수 | 형식 | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string uri |
문서 인텔리전스 서비스 엔드포인트입니다. |
|
api-version
|
query | True |
string |
이 작업에 사용할 API 버전입니다. |
요청 본문
| Name | 필수 | 형식 | Description |
|---|---|---|---|
| classifierId | True |
string |
입력 파일을 분할하고 분류하는 사용자 지정 분류자입니다. |
| docTypes | True |
<string,
Document |
지원되는 docTypes를 해당 문서 모델에 사전 매핑합니다. |
| modelId | True |
string |
고유한 문서 모델 이름입니다. |
| description |
string |
문서 모델 설명입니다. |
|
| split |
파일 분할 동작입니다. |
||
| tags |
object |
문서 모델과 연결된 키-값 태그 특성 목록입니다. |
응답
| Name | 형식 | Description |
|---|---|---|
| 202 Accepted |
처리를 위해 요청이 수락되었지만 처리가 아직 완료되지 않았습니다. 헤더
|
|
| Other Status Codes |
예기치 않은 오류 응답입니다. |
보안
Ocp-Apim-Subscription-Key
형식:
apiKey
In(다음 안에):
header
OAuth2Auth
형식:
oauth2
Flow:
accessCode
권한 부여 URL:
https://login.microsoftonline.com/common/oauth2/authorize
토큰 URL:
https://login.microsoftonline.com/common/oauth2/token
범위
| Name | Description |
|---|---|
| https://cognitiveservices.azure.com/.default |
예제
Compose Document Model
샘플 요청
POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels:compose?api-version=2024-11-30
{
"modelId": "composedModel",
"description": "Composed model description",
"classifierId": "customClassifier",
"docTypes": {
"formA": {
"modelId": "model1"
},
"formB": {
"modelId": "model2"
}
}
}
샘플 응답
Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2024-11-30정의
| Name | Description |
|---|---|
|
Compose |
구성 요소 문서 모델에서 구성된 문서 모델을 만들도록 본문을 요청합니다. |
|
Document |
사용하도록 설정할 문서 분석 기능입니다. |
|
Document |
사용자 지정 문서 모델 빌드 모드입니다. |
|
Document |
JSON 스키마 스타일 구문을 사용하는 필드 의미 체계 스키마에 대한 설명입니다. |
|
Document |
필드 값의 의미 체계 데이터 형식입니다. |
|
Document |
오류 개체입니다. |
|
Document |
오류 응답 개체입니다. |
|
Document |
오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. |
|
Document |
문서 유형 정보입니다. |
|
Split |
파일 분할 동작입니다. |
ComposeDocumentModelRequest
구성 요소 문서 모델에서 구성된 문서 모델을 만들도록 본문을 요청합니다.
| Name | 형식 | Default value | Description |
|---|---|---|---|
| classifierId |
string |
입력 파일을 분할하고 분류하는 사용자 지정 분류자입니다. |
|
| description |
string |
문서 모델 설명입니다. |
|
| docTypes |
<string,
Document |
지원되는 docTypes를 해당 문서 모델에 사전 매핑합니다. |
|
| modelId |
string |
고유한 문서 모델 이름입니다. |
|
| split | none |
파일 분할 동작입니다. |
|
| tags |
object |
문서 모델과 연결된 키-값 태그 특성 목록입니다. |
DocumentAnalysisFeature
사용하도록 설정할 문서 분석 기능입니다.
| Name | 형식 | Description |
|---|---|---|
| barcodes |
string |
문서에서 바코드 검색을 사용하도록 설정합니다. |
| formulas |
string |
문서에서 수학적 식을 검색할 수 있도록 설정합니다. |
| keyValuePairs |
string |
문서에서 일반 키 값 쌍(양식 필드)을 검색할 수 있도록 설정합니다. |
| languages |
string |
텍스트 콘텐츠 언어의 검색을 사용하도록 설정합니다. |
| ocrHighResolution |
string |
고해상도로 OCR을 수행하여 문서를 세밀하게 인쇄할 수 있습니다. |
| queryFields |
string |
queryFields 쿼리 매개 변수를 통해 추가 필드 추출을 사용하도록 설정합니다. |
| styleFont |
string |
다양한 글꼴 스타일을 인식할 수 있습니다. |
DocumentBuildMode
사용자 지정 문서 모델 빌드 모드입니다.
| Name | 형식 | Description |
|---|---|---|
| neural |
string |
다양한 시각적 템플릿이 있는 문서를 지원합니다. |
| template |
string |
유사한 시각적 템플릿을 사용하여 문서를 대상으로 지정합니다. |
DocumentFieldSchema
JSON 스키마 스타일 구문을 사용하는 필드 의미 체계 스키마에 대한 설명입니다.
| Name | 형식 | Description |
|---|---|---|
| description |
string |
필드 설명입니다. |
| example |
string |
예제 필드 콘텐츠입니다. |
| items |
각 배열 요소의 필드 형식 스키마입니다. |
|
| properties |
<string,
Document |
개체 필드의 명명된 하위 필드입니다. |
| type |
필드 값의 의미 체계 데이터 형식입니다. |
DocumentFieldType
필드 값의 의미 체계 데이터 형식입니다.
| Name | 형식 | Description |
|---|---|---|
| address |
string |
구문 분석된 주소입니다. |
| array |
string |
동일한 형식의 하위 필드 목록입니다. |
| boolean |
string |
true 또는 false로 정규화된 부울 값입니다. |
| countryRegion |
string |
ISO 3166-1 alpha-3 형식(예: 미국)으로 정규화된 국가/지역입니다. |
| currency |
string |
선택적 통화 기호 및 단위가 있는 통화 금액입니다. |
| date |
string |
ISO 8601(YYYY-MM-DD) 형식으로 정규화된 날짜입니다. |
| integer |
string |
부호 있는 64비트 정수로 정규화된 정수입니다. |
| number |
string |
배정밀도 부동 소수점으로 정규화된 부동 소수점 숫자입니다. |
| object |
string |
잠재적으로 다른 형식의 하위 필드의 명명된 목록입니다. |
| phoneNumber |
string |
E.164(+{CountryCode}{SubscriberNumber}) 형식으로 정규화된 전화 번호입니다. |
| selectionGroup |
string |
선택한 문자열 값의 배열입니다. |
| selectionMark |
string |
필드가 선택되었나요? |
| signature |
string |
서명이 있나요? |
| string |
string |
일반 텍스트입니다. |
| time |
string |
ISO 8601(hh:mm:ss) 형식으로 정규화된 시간입니다. |
DocumentIntelligenceError
오류 개체입니다.
| Name | 형식 | Description |
|---|---|---|
| code |
string |
서버에서 정의한 오류 코드 집합 중 하나입니다. |
| details |
이 보고된 오류로 이어진 특정 오류에 대한 세부 정보 배열입니다. |
|
| innererror |
오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다. |
|
| message |
string |
사람이 읽을 수 있는 오류 표현입니다. |
| target |
string |
오류의 대상입니다. |
DocumentIntelligenceErrorResponse
오류 응답 개체입니다.
| Name | 형식 | Description |
|---|---|---|
| error |
오류 정보입니다. |
DocumentIntelligenceInnerError
오류에 대한 보다 구체적인 정보를 포함하는 개체입니다.
| Name | 형식 | Description |
|---|---|---|
| code |
string |
서버에서 정의한 오류 코드 집합 중 하나입니다. |
| innererror |
내부 오류입니다. |
|
| message |
string |
사람이 읽을 수 있는 오류 표현입니다. |
DocumentTypeDetails
문서 유형 정보입니다.
| Name | 형식 | Description |
|---|---|---|
| buildMode |
사용자 지정 문서 모델 빌드 모드입니다. |
|
| confidenceThreshold |
number |
docType 신뢰도가 임계값을 초과하는 경우에만 분석을 수행합니다. |
| description |
string |
문서 모델 설명입니다. |
| features |
선택적 분석 기능 목록입니다. |
|
| fieldConfidence |
object |
각 필드에 대한 예상 신뢰도입니다. |
| fieldSchema |
<string,
Document |
JSON 스키마 스타일 구문을 사용하는 문서 의미 체계 스키마에 대한 설명입니다. |
| maxDocumentsToAnalyze |
integer |
분석할 지정된 형식의 최대 문서 수입니다. Default=all. |
| modelId |
string |
지정된 형식의 문서를 분석하는 데 사용할 문서 모델입니다. |
| queryFields |
string[] |
추출할 추가 필드 목록입니다. 전. "NumberOfGuests,StoreNumber" |
SplitMode
파일 분할 동작입니다.
| Name | 형식 | Description |
|---|---|---|
| auto |
string |
파일을 문서로 자동으로 분할합니다. |
| none |
string |
전체 파일을 단일 문서로 처리합니다. |
| perPage |
string |
파일의 각 페이지를 별도의 문서로 처리합니다. |