Miscellaneous Operations - Get Document Classifier Build Operation

Service:

Azure AI Services

API Version:

2024-02-29-preview

Gets operation info.

GET {endpoint}/documentintelligence/operations/{operationId}?_overload=getDocumentClassifierBuildOperation&api-version=2024-02-29-preview

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string	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	DocumentClassifierBuildOperationDetails	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 Classifier Build

Sample Request

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?_overload=getDocumentClassifierBuildOperation&api-version=2024-02-29-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": "documentClassifierBuild",
  "resourceLocation": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/myClassifier",
  "result": {
    "classifierId": "myClassifier",
    "description": "Classifier description",
    "createdDateTime": "2022-07-30T00:00:00Z",
    "expirationDateTime": "2023-01-01T00:00:00Z",
    "apiVersion": "2024-02-29-preview",
    "docTypes": {
      "formA": {
        "azureBlobSource": {
          "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
          "prefix": "formADocs/"
        }
      },
      "formB": {
        "azureBlobFileListSource": {
          "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
          "fileList": "formB.jsonl"
        }
      }
    }
  }
}

Definitions

Name	Description
AzureBlobContentSource	Azure Blob Storage content.
AzureBlobFileListContentSource	File list in Azure Blob Storage.
ClassifierDocumentTypeDetails	Classifier document type info.
ContentSourceKind	Type of content source.
DocumentClassifierBuildOperationDetails	Get Operation response object.
DocumentClassifierDetails	Document classifier 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.
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.

ClassifierDocumentTypeDetails

Classifier document type info.

Name	Type	Description
azureBlobFileListSource	AzureBlobFileListContentSource	Azure Blob Storage file list specifying the training data for a classifier document type. Either azureBlobSource or azureBlobFileListSource must be specified.
azureBlobSource	AzureBlobContentSource	Azure Blob Storage location containing the training data for a classifier document type. Either azureBlobSource or azureBlobFileListSource must be specified.
sourceKind	ContentSourceKind	Type of training data source.

ContentSourceKind

Type of content source.

Name	Type	Description
azureBlob	string	Files in a path within an Azure Blob Storage container.
azureBlobFileList	string	A file list specifying individual files in an Azure Blob Storage container.
base64	string	Content represented via Base64 encoding.
url	string	Content at a specific URL.

DocumentClassifierBuildOperationDetails

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: documentClassifierBuild	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	DocumentClassifierDetails	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.

DocumentClassifierDetails

Document classifier info.

Name	Type	Description
apiVersion	string	API version used to create this document classifier.
baseClassifierId	string	Base classifierId on top of which the classifier was trained.
classifierId	string	Unique document classifier name.
createdDateTime	string	Date and time (UTC) when the document classifier was created.
description	string	Document classifier description.
docTypes	<string,  ClassifierDocumentTypeDetails>	List of document types to classify against.
expirationDateTime	string	Date and time (UTC) when the document classifier will expire.
warnings	Warning[]	List of warnings encountered while building the classifier.

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.
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.

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.