Document Models - Get Model

Reference

Service:: Azure AI Services

API Version:: 2024-02-29-preview

Gets detailed document model information.

GET {endpoint}/documentintelligence/documentModels/{modelId}?api-version=2024-02-29-preview

URI Parameters

Name In Required Type Description

Name	In	Required	Type	Description
endpoint	path	True	string	The Document Intelligence service endpoint.
modelId	path	True	string	Unique document model name. Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$`
api-version	query	True	string	The API version to use for this operation.

endpoint

path

True

string

The Document Intelligence service endpoint.

modelId

path

True

string

Unique document model name.

Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$

api-version

query

True

string

The API version to use for this operation.

Request Header

Name	Required	Type	Description
x-ms-client-request-id		string uuid	An opaque, globally-unique, client-generated string identifier for the request.

Responses

Name	Type	Description
200 OK	DocumentModelDetails	The request has succeeded. Headers x-ms-client-request-id: string
Other Status Codes	ErrorResponse	An unexpected error response.

Name

Type

Description

200 OK

DocumentModelDetails

The request has succeeded.

Headers

x-ms-client-request-id: string

Other Status Codes

ErrorResponse

An unexpected error response.

Security

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

Examples

Get Custom Document Model

Get Prebuilt Document Model

Get Custom Document Model

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "modelId": "myCustomModel",
  "description": "Custom model description",
  "createdDateTime": "2021-09-24T12:54:35Z",
  "expirationDateTime": "2023-01-01T00:00:00Z",
  "apiVersion": "2024-02-29-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

Sample Request

HTTP

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

Sample Response

Status code:: 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-02-29-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": {}
}

Definitions

Name	Description
AzureBlobContentSource	Azure Blob Storage content.
AzureBlobFileListContentSource	File list in Azure Blob Storage.
DocumentBuildMode	Custom document model build mode.
DocumentFieldSchema	Description of the field semantic schema using a JSON Schema style syntax.
DocumentFieldType	Semantic data type of the field value.
DocumentModelDetails	Document model info.
DocumentTypeDetails	Document type info.
Error	The error object.
ErrorResponse	Error response object.
InnerError	An object containing more specific information about the error.
Warning	The error object.

AzureBlobContentSource

Azure Blob Storage content.

Name	Type	Description
containerUrl	string	Azure Blob Storage container URL.
prefix	string	Blob name prefix.

AzureBlobFileListContentSource

File list in Azure Blob Storage.

Name	Type	Description
containerUrl	string	Azure Blob Storage container URL.
fileList	string	Path to a JSONL file within the container specifying a subset of documents.

DocumentBuildMode

Custom document model build mode.

Name	Type	Description
neural	string	Support documents with diverse visual templates.
template	string	Target documents with similar visual templates.

DocumentFieldSchema

Description of the field semantic schema using a JSON Schema style syntax.

Name	Type	Description
description	string	Field description.
example	string	Example field content.
items	DocumentFieldSchema	Field type schema of each array element.
properties	<string, DocumentFieldSchema>	Named sub-fields of the object field.
type	DocumentFieldType	Semantic data type of the field value.

DocumentFieldType

Semantic data type of the field value.

Name	Type	Description
address	string	Parsed address.
array	string	List of subfields of the same type.
boolean	string	Boolean value, normalized to true or false.
countryRegion	string	Country/region, normalized to ISO 3166-1 alpha-3 format (ex. USA).
currency	string	Currency amount with optional currency symbol and unit.
date	string	Date, normalized to ISO 8601 (YYYY-MM-DD) format.
integer	string	Integer number, normalized to 64-bit signed integer.
number	string	Floating point number, normalized to double precision floating point.
object	string	Named list of subfields of potentially different types.
phoneNumber	string	Phone number, normalized to E.164 (+{CountryCode}{SubscriberNumber}) format.
selectionGroup	string	Array of selected string values.
selectionMark	string	Is field selected?
signature	string	Is signature present?
string	string	Plain text.
time	string	Time, normalized to ISO 8601 (hh:mm:ss) format.

DocumentModelDetails

Document model info.

Name	Type	Description
apiVersion	string	API version used to create this document model.
azureBlobFileListSource	AzureBlobFileListContentSource	Azure Blob Storage file list specifying the training data. Either azureBlobSource or azureBlobFileListSource must be specified.
azureBlobSource	AzureBlobContentSource	Azure Blob Storage location containing the training data. Either azureBlobSource or azureBlobFileListSource must be specified.
buildMode	DocumentBuildMode	Custom document model build mode.
createdDateTime	string	Date and time (UTC) when the document model was created.
description	string	Document model description.
docTypes	<string, DocumentTypeDetails>	Supported document types.
expirationDateTime	string	Date and time (UTC) when the document model will expire.
modelId	string	Unique document model name.
tags	object	List of key-value tag attributes associated with the document model.
warnings	Warning[]	List of warnings encountered while building the model.

DocumentTypeDetails

Document type info.

Name	Type	Description
buildMode	DocumentBuildMode	Custom document model build mode.
description	string	Document model description.
fieldConfidence	object	Estimated confidence for each field.
fieldSchema	<string, DocumentFieldSchema>	Description of the document semantic schema using a JSON Schema style syntax.

Error

The error object.

Name	Type	Description
code	string	One of a server-defined set of error codes.
details	Error[]	An array of details about specific errors that led to this reported error.
innererror	InnerError	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.
target	string	The target of the error.

ErrorResponse

Error response object.

Name	Type	Description
error	Error	Error info.

InnerError

An object containing more specific information about the error.

Name	Type	Description
code	string	One of a server-defined set of error codes.
innererror	InnerError	Inner error.
message	string	A human-readable representation of the error.

Warning

The error object.

Name	Type	Description
code	string	One of a server-defined set of warning codes.
message	string	A human-readable representation of the warning.
target	string	The target of the error.

Share via

Document Models - Get Model

URI Parameters

Request Header

Responses

Security

Ocp-Apim-Subscription-Key

OAuth2Auth

Scopes

Examples

Get Custom Document Model

Sample Request

Sample Response

Get Prebuilt Document Model

Sample Request

Sample Response

Definitions

AzureBlobContentSource

AzureBlobFileListContentSource

DocumentBuildMode

DocumentFieldSchema

DocumentFieldType

DocumentModelDetails

DocumentTypeDetails

Error

ErrorResponse

InnerError

Warning

Additional resources