Miscellaneous Operations - Get Document Model Build Operation

Service:

Azure AI Services

API Version:

2024-07-31-preview

Gets operation info.

GET {endpoint}/documentintelligence/operations/{operationId}?api-version=2024-07-31-preview

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string uri	The Document Intelligence service endpoint.
operationId	path	True	string	Operation ID
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	DocumentModelBuildOperationDetails	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 Operation - Document Model Build

Sample request

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2024-07-31-preview

Sample response

Status code:

200

{
  "operationId": "b704bb00-d130-4f3f-a1d8-ca96de3eabb4",
  "status": "succeeded",
  "percentCompleted": 100,
  "createdDateTime": "2021-09-23T09:12:57Z",
  "lastUpdatedDateTime": "2021-09-23T09:13:01Z",
  "kind": "documentModelBuild",
  "resourceLocation": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/myCustomModel",
  "result": {
    "modelId": "myCustomModel",
    "description": "Custom model description",
    "createdDateTime": "2021-09-23T09:13:01Z",
    "apiVersion": "2024-07-31-preview"
  }
}

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.
DocumentModelBuildOperationDetails	Get Operation response object.
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.
OperationKind	Type of operation.
OperationStatus	Operation status.
SplitMode	File splitting behavior.
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.

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
generative	string	Enable documents of all types using generative AI techniques.
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.

DocumentModelBuildOperationDetails

Get Operation response object.

Name	Type	Description
apiVersion	string	API version used to create this operation.
createdDateTime	string	Date and time (UTC) when the operation was created.
error	Error	Encountered error.
kind	string: documentModelBuild	Type of operation.
lastUpdatedDateTime	string	Date and time (UTC) when the status was last updated.
operationId	string	Operation ID
percentCompleted	integer	Operation progress (0-100).
resourceLocation	string	URL of the resource targeted by this operation.
result	DocumentModelDetails	Operation result upon success.
status	OperationStatus	Operation status. notStarted, running, completed, or failed
tags	object	List of key-value tag attributes associated with the document model.

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.
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	Warning[]		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"

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.

OperationKind

Type of operation.

Name	Type	Description
documentClassifierBuild	string	Build a new custom classifier model.
documentClassifierCopyTo	string	Copy an existing document classifier to potentially a different resource, region, or subscription.
documentModelBuild	string	Build a new custom document model.
documentModelCompose	string	Compose a new custom document model from existing models.
documentModelCopyTo	string	Copy an existing document model to potentially a different resource, region, or subscription.

OperationStatus

Operation status.

Name	Type	Description
canceled	string	The operation has been canceled.
completed	string	The operation has completed.
failed	string	The operation has failed.
notStarted	string	The operation has not started yet.
running	string	The operation is in progress.
succeeded	string	The operation has succeeded.

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.

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.