Document Models - List Models

Reference

Service:: Azure AI Services

API Version:: 2024-11-30

List all document models

GET {endpoint}/documentintelligence/documentModels?api-version=2024-11-30

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string uri	The Document Intelligence service endpoint.
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	PagedDocumentModelDetails	The request has succeeded. Headers x-ms-client-request-id: string
Other Status Codes	DocumentIntelligenceErrorResponse	An unexpected error response.

Name

Type

Description

200 OK

PagedDocumentModelDetails

The request has succeeded.

Headers

x-ms-client-request-id: string

Other Status Codes

DocumentIntelligenceErrorResponse

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

Sample request

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels?api-version=2024-11-30

Sample response

Status code:: 200

{
  "value": [
    {
      "modelId": "prebuilt-layout",
      "createdDateTime": "2021-07-30T00:00:00Z",
      "description": "Prebuilt model to extract text, selection marks, tables, and other layout information.",
      "apiVersion": "2024-11-30"
    },
    {
      "modelId": "myCustomModel",
      "createdDateTime": "2021-09-24T12:54:35Z",
      "expirationDateTime": "2023-01-01T00:00:00Z",
      "description": "Custom model description",
      "apiVersion": "2024-11-30"
    }
  ],
  "nextLink": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels?nextLink=nextLinkData"
}

Definitions

Name	Description
AzureBlobContentSource	Azure Blob Storage content.
AzureBlobFileListContentSource	File list in Azure Blob Storage.
DocumentAnalysisFeature	Document analysis features to enable.
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.
DocumentIntelligenceError	The error object.
DocumentIntelligenceErrorResponse	Error response object.
DocumentIntelligenceInnerError	An object containing more specific information about the error.
DocumentIntelligenceWarning	The error object.
DocumentModelDetails	Document model info.
DocumentTypeDetails	Document type info.
PagedDocumentModelDetails	Paged collection of DocumentModelDetails items
SplitMode	File splitting behavior.

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.

DocumentAnalysisFeature

Document analysis features to enable.

Name	Type	Description
barcodes	string	Enable the detection of barcodes in the document.
formulas	string	Enable the detection of mathematical expressions in the document.
keyValuePairs	string	Enable the detection of general key value pairs (form fields) in the document.
languages	string	Enable the detection of the text content language.
ocrHighResolution	string	Perform OCR at a higher resolution to handle documents with fine print.
queryFields	string	Enable the extraction of additional fields via the queryFields query parameter.
styleFont	string	Enable the recognition of various font styles.

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.

DocumentIntelligenceError

The error object.

Name	Type	Description
code	string	One of a server-defined set of error codes.
details	DocumentIntelligenceError[]	An array of details about specific errors that led to this reported error.
innererror	DocumentIntelligenceInnerError	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.

DocumentIntelligenceErrorResponse

Error response object.

Name	Type	Description
error	DocumentIntelligenceError	Error info.

DocumentIntelligenceInnerError

An object containing more specific information about the error.

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

DocumentIntelligenceWarning

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.

DocumentModelDetails

Document model info.

Name	Type	Default value	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.
classifierId	string		For composed models, the custom classifier to split and classify the input file.
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.
modifiedDateTime	string		Date and time (UTC) when the document model was last modified.
split	SplitMode	none	For composed models, the file splitting behavior.
tags	object		List of key-value tag attributes associated with the document model.
trainingHours	number		Number of V100-equivalent GPU hours consumed for model training.
warnings	DocumentIntelligenceWarning[]		List of warnings encountered while building the model.

DocumentTypeDetails

Document type info.

Name	Type	Description
buildMode	DocumentBuildMode	Custom document model build mode.
confidenceThreshold	number	Only perform analysis if docType confidence is above threshold.
description	string	Document model description.
features	DocumentAnalysisFeature[]	List of optional analysis features.
fieldConfidence	object	Estimated confidence for each field.
fieldSchema	<string, DocumentFieldSchema>	Description of the document semantic schema using a JSON Schema style syntax.
maxDocumentsToAnalyze	integer	Maximum number of documents of specified type to analyze. Default=all.
modelId	string	Document model to use for analyzing documents with specified type.
queryFields	string[]	List of additional fields to extract. Ex. "NumberOfGuests,StoreNumber"

PagedDocumentModelDetails

Paged collection of DocumentModelDetails items

Name	Type	Description
nextLink	string	The link to the next page of items
value	DocumentModelDetails[]	The DocumentModelDetails items on this page

SplitMode

File splitting behavior.

Name	Type	Description
auto	string	Automatically split file into documents.
none	string	Treat the entire file as a single document.
perPage	string	Treat each page in the file as a separate document.

Dela via

Document Models - List Models

URI Parameters

Request Header

Responses

Security

Ocp-Apim-Subscription-Key

OAuth2Auth

Scopes

Examples

Get Document Models

Sample request

Sample response

Definitions

AzureBlobContentSource

AzureBlobFileListContentSource

DocumentAnalysisFeature

DocumentBuildMode

DocumentFieldSchema

DocumentFieldType

DocumentIntelligenceError

DocumentIntelligenceErrorResponse

DocumentIntelligenceInnerError

DocumentIntelligenceWarning

DocumentModelDetails

DocumentTypeDetails

PagedDocumentModelDetails

SplitMode

Ytterligare resurser