Document Models - Get Model

참조

서비스:: Azure AI Services

API 버전:: 2024-07-31-preview

자세한 문서 모델 정보를 가져옵니다.

GET {endpoint}/documentintelligence/documentModels/{modelId}?api-version=2024-07-31-preview

URI 매개 변수

Name In(다음 안에) 필수 형식 Description

Name	In(다음 안에)	필수	형식	Description
endpoint	path	True	string uri	문서 인텔리전스 서비스 엔드포인트입니다.
modelId	path	True	string	고유한 문서 모델 이름입니다. regex 패턴: `^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$`
api-version	query	True	string	이 작업에 사용할 API 버전입니다.

endpoint

path

True

string

uri

문서 인텔리전스 서비스 엔드포인트입니다.

modelId

path

True

string

고유한 문서 모델 이름입니다.

regex 패턴: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$

api-version

query

True

string

이 작업에 사용할 API 버전입니다.

요청 헤더

Name	필수	형식	Description
x-ms-client-request-id		string uuid	요청에 대한 불투명하고 전역적으로 고유한 클라이언트 생성 문자열 식별자입니다.

응답

Name	형식	Description
200 OK	DocumentModelDetails	요청이 성공했습니다. 헤더 x-ms-client-request-id: string
Other Status Codes	ErrorResponse	예기치 않은 오류 응답입니다.

Name

형식

Description

200 OK

DocumentModelDetails

요청이 성공했습니다.

헤더

x-ms-client-request-id: string

Other Status Codes

ErrorResponse

예기치 않은 오류 응답입니다.

보안

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

예제

Get Custom Document Model

Get Prebuilt Document Model

Get Custom Document Model

샘플 요청

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/myCustomModel?api-version=2024-07-31-preview

샘플 응답

상태 코드:: 200

{
  "modelId": "myCustomModel",
  "description": "Custom model description",
  "createdDateTime": "2021-09-24T12:54:35Z",
  "expirationDateTime": "2023-01-01T00:00:00Z",
  "apiVersion": "2024-07-31-preview",
  "docTypes": {
    "myForm": {
      "fieldSchema": {
        "Name": {
          "type": "string"
        },
        "Date": {
          "type": "date"
        },
        "Amount": {
          "type": "number"
        }
      },
      "buildMode": "template",
      "fieldConfidence": {
        "Name": 0.9,
        "Date": 0.95,
        "Amount": 0.93
      }
    }
  },
  "tags": {
    "createdBy": "myUserId"
  }
}

Get Prebuilt Document Model

샘플 요청

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-invoice?api-version=2024-07-31-preview

샘플 응답

상태 코드:: 200

{
  "modelId": "prebuilt-invoice",
  "description": "Prebuilt model to extract key information from English invoices, including customer, vendor, invoice ID, due date, total, and more.",
  "createdDateTime": "2021-07-30T00:00:00Z",
  "apiVersion": "2024-07-31-preview",
  "docTypes": {
    "prebuilt:invoice": {
      "fieldSchema": {
        "CustomerName": {
          "type": "string"
        },
        "CustomerId": {
          "type": "string"
        },
        "PurchaseOrder": {
          "type": "string"
        },
        "InvoiceId": {
          "type": "string"
        },
        "InvoiceDate": {
          "type": "date"
        },
        "DueDate": {
          "type": "date"
        },
        "VendorName": {
          "type": "string"
        },
        "VendorAddress": {
          "type": "string"
        },
        "VendorAddressRecipient": {
          "type": "string"
        },
        "CustomerAddress": {
          "type": "string"
        },
        "CustomerAddressRecipient": {
          "type": "string"
        },
        "BillingAddress": {
          "type": "string"
        },
        "BillingAddressRecipient": {
          "type": "string"
        },
        "ShippingAddress": {
          "type": "string"
        },
        "ShippingAddressRecipient": {
          "type": "string"
        },
        "SubTotal": {
          "type": "number"
        },
        "TotalTax": {
          "type": "number"
        },
        "InvoiceTotal": {
          "type": "number"
        },
        "AmountDue": {
          "type": "number"
        },
        "PreviousUnpaidBalance": {
          "type": "number"
        },
        "RemittanceAddress": {
          "type": "string"
        },
        "RemittanceAddressRecipient": {
          "type": "string"
        },
        "ServiceAddress": {
          "type": "string"
        },
        "ServiceAddressRecipient": {
          "type": "string"
        },
        "ServiceStartDate": {
          "type": "date"
        },
        "ServiceEndDate": {
          "type": "date"
        },
        "Items": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "Amount": {
                "type": "number"
              },
              "Date": {
                "type": "date"
              },
              "Description": {
                "type": "string"
              },
              "Quantity": {
                "type": "number"
              },
              "ProductCode": {
                "type": "string"
              },
              "Tax": {
                "type": "number"
              },
              "Unit": {
                "type": "string"
              },
              "UnitPrice": {
                "type": "number"
              }
            }
          }
        }
      }
    }
  },
  "tags": {}
}

정의

Name	Description
AzureBlobContentSource	Azure Blob Storage 콘텐츠.
AzureBlobFileListContentSource	Azure Blob Storage의 파일 목록입니다.
DocumentAnalysisFeature	사용하도록 설정할 문서 분석 기능입니다.
DocumentBuildMode	사용자 지정 문서 모델 빌드 모드입니다.
DocumentFieldSchema	JSON 스키마 스타일 구문을 사용하는 필드 의미 체계 스키마에 대한 설명입니다.
DocumentFieldType	필드 값의 의미 체계 데이터 형식입니다.
DocumentModelDetails	문서 모델 정보입니다.
DocumentTypeDetails	문서 유형 정보입니다.
Error	오류 개체입니다.
ErrorResponse	오류 응답 개체입니다.
InnerError	오류에 대한 보다 구체적인 정보를 포함하는 개체입니다.
SplitMode	파일 분할 동작입니다.
Warning	오류 개체입니다.

AzureBlobContentSource

Azure Blob Storage 콘텐츠.

Name	형식	Description
containerUrl	string	Azure Blob Storage 컨테이너 URL입니다.
prefix	string	Blob 이름 접두사입니다.

AzureBlobFileListContentSource

Azure Blob Storage의 파일 목록입니다.

Name	형식	Description
containerUrl	string	Azure Blob Storage 컨테이너 URL입니다.
fileList	string	문서의 하위 집합을 지정하는 컨테이너 내의 JSONL 파일 경로입니다.

DocumentAnalysisFeature

사용하도록 설정할 문서 분석 기능입니다.

Name	형식	Description
barcodes	string	문서에서 바코드 검색을 사용하도록 설정합니다.
formulas	string	문서에서 수학적 식을 검색할 수 있도록 설정합니다.
keyValuePairs	string	문서에서 일반 키 값 쌍(양식 필드)을 검색할 수 있도록 설정합니다.
languages	string	텍스트 콘텐츠 언어의 검색을 사용하도록 설정합니다.
ocrHighResolution	string	고해상도로 OCR을 수행하여 문서를 세밀하게 인쇄할 수 있습니다.
queryFields	string	queryFields 쿼리 매개 변수를 통해 추가 필드 추출을 사용하도록 설정합니다.
styleFont	string	다양한 글꼴 스타일을 인식할 수 있습니다.

DocumentBuildMode

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

Name	형식	Description
generative	string	생성 AI 기술을 사용하여 모든 유형의 문서를 사용하도록 설정합니다.
neural	string	다양한 시각적 템플릿이 있는 문서를 지원합니다.
template	string	유사한 시각적 템플릿을 사용하여 문서를 대상으로 지정합니다.

DocumentFieldSchema

JSON 스키마 스타일 구문을 사용하는 필드 의미 체계 스키마에 대한 설명입니다.

Name	형식	Description
description	string	필드 설명입니다.
example	string	예제 필드 콘텐츠입니다.
items	DocumentFieldSchema	각 배열 요소의 필드 형식 스키마입니다.
properties	<string, DocumentFieldSchema>	개체 필드의 명명된 하위 필드입니다.
type	DocumentFieldType	필드 값의 의미 체계 데이터 형식입니다.

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) 형식으로 정규화된 시간입니다.

DocumentModelDetails

문서 모델 정보입니다.

Name	형식	Default value	Description
apiVersion	string		이 문서 모델을 만드는 데 사용되는 API 버전입니다.
azureBlobFileListSource	AzureBlobFileListContentSource		학습 데이터를 지정하는 Azure Blob Storage 파일 목록입니다. azureBlobSource 또는 azureBlobFileListSource를 지정해야 합니다.
azureBlobSource	AzureBlobContentSource		학습 데이터를 포함하는 Azure Blob Storage 위치입니다. azureBlobSource 또는 azureBlobFileListSource를 지정해야 합니다.
buildMode	DocumentBuildMode		사용자 지정 문서 모델 빌드 모드입니다.
classifierId	string		구성된 모델의 경우 입력 파일을 분할하고 분류하는 사용자 지정 분류자입니다.
createdDateTime	string		문서 모델을 만든 날짜 및 시간(UTC)입니다.
description	string		문서 모델 설명입니다.
docTypes	<string, DocumentTypeDetails>		지원되는 문서 형식입니다.
expirationDateTime	string		문서 모델이 만료되는 날짜 및 시간(UTC)입니다.
modelId	string		고유한 문서 모델 이름입니다.
split	SplitMode	none	구성된 모델의 경우 파일 분할 동작입니다.
tags	object		문서 모델과 연결된 키-값 태그 특성 목록입니다.
trainingHours	number		모델 학습에 사용된 V100에 해당하는 GPU 시간 수입니다.
warnings	Warning[]		모델을 빌드하는 동안 발생한 경고 목록입니다.

DocumentTypeDetails

문서 유형 정보입니다.

Name	형식	Description
buildMode	DocumentBuildMode	사용자 지정 문서 모델 빌드 모드입니다.
confidenceThreshold	number	docType 신뢰도가 임계값을 초과하는 경우에만 분석을 수행합니다.
description	string	문서 모델 설명입니다.
features	DocumentAnalysisFeature[]	선택적 분석 기능 목록입니다.
fieldConfidence	object	각 필드에 대한 예상 신뢰도입니다.
fieldSchema	<string, DocumentFieldSchema>	JSON 스키마 스타일 구문을 사용하는 문서 의미 체계 스키마에 대한 설명입니다.
maxDocumentsToAnalyze	integer	분석할 지정된 형식의 최대 문서 수입니다. Default=all.
modelId	string	지정된 형식의 문서를 분석하는 데 사용할 문서 모델입니다.
queryFields	string[]	추출할 추가 필드 목록입니다. 전. "NumberOfGuests,StoreNumber"

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

SplitMode

파일 분할 동작입니다.

Name	형식	Description
auto	string	파일을 문서로 자동으로 분할합니다.
none	string	전체 파일을 단일 문서로 처리합니다.
perPage	string	파일의 각 페이지를 별도의 문서로 처리합니다.

Warning

오류 개체입니다.

Name	형식	Description
code	string	서버에서 정의한 경고 코드 집합 중 하나입니다.
message	string	사람이 읽을 수 있는 경고 표현입니다.
target	string	오류의 대상입니다.

다음을 통해 공유

Document Models - Get Model

URI 매개 변수

요청 헤더

응답

보안

Ocp-Apim-Subscription-Key

OAuth2Auth

범위

예제

Get Custom Document Model

샘플 요청

샘플 응답

Get Prebuilt Document Model

샘플 요청

샘플 응답

정의

AzureBlobContentSource

AzureBlobFileListContentSource

DocumentAnalysisFeature

DocumentBuildMode

DocumentFieldSchema

DocumentFieldType

DocumentModelDetails

DocumentTypeDetails

Error

ErrorResponse

InnerError

SplitMode

Warning

추가 리소스