Azuredocumentintelligenceconnector v1.0

Version 1.0

Connector Overview: This page documents all 30 actions for the Azuredocumentintelligenceconnector v1.0.

General (29)

POST Analyzes batch documents with document model.

/documentModels/{modelId}:analyzeBatch

Analyzes batch documents with document model.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Api-version`	The API version to use for this operation.
`Modelid`	Unique document model name.
`Pages`	List of 1-based page numbers to analyze. Ex. "1-3,5,7-9"
`Locale`	Locale hint for text recognition and document analysis. Value may contain only the language code (ex. "en", "fr") or BCP 47 language tag (ex. "en-US").
`Stringindextype`	Method used to compute string offset and length.
`Features`	List of optional analysis features.
`Queryfields`	List of additional fields to extract. Ex. "NumberOfGuests,StoreNumber"
`Outputcontentformat`	Format of the analyze result top-level content.
`Output`	Additional outputs to generate during analysis.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Resultcontainerurl`	Azure Blob Storage container URL where analyze result files will be stored.
`Resultprefix`	Blob name prefix of result files.
`Overwriteexisting`	Overwrite existing analyze result files?

POST Analyzes document with document model.

/documentModels/{modelId}:analyze

Analyzes document with document model.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Api-version`	The API version to use for this operation.
`Overload`	Specifies the overload version of the analyze operation to use, if applicable.
`Modelid`	Unique document model name.
`Pages`	List of 1-based page numbers to analyze. Ex. "1-3,5,7-9"
`Locale`	Locale hint for text recognition and document analysis. Value may contain only the language code (ex. "en", "fr") or BCP 47 language tag (ex. "en-US").
`Stringindextype`	Method used to compute string offset and length.
`Features`	List of optional analysis features.
`Queryfields`	List of additional fields to extract. Ex. "NumberOfGuests,StoreNumber"
`Outputcontentformat`	Format of the analyze result top-level content.
`Output`	Additional outputs to generate during analysis.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Urlsource`	Document URL to analyze. Either urlSource or base64Source must be specified.
`Base64source`	Base64 encoding of the document to analyze. Either urlSource or base64Source must be specified.

POST Builds a custom document analysis model.

/documentModels:build

Builds a custom document analysis model.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Api-version`	The API version to use for this operation.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`Modelid`	Unique document model name.
`Description`	Document model description.
`Buildmode`	Custom document model build mode.
`Maxtraininghours`	Max number of V100-equivalent GPU hours to use for model training. Default=0.5.
`Allowoverwrite`	Allow overwriting an existing model with the same name.

POST Builds a custom document classifier.

/documentClassifiers:build

Builds a custom document classifier.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Api-version`	The API version to use for this operation.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Classifierid`	Unique document classifier name.
`Description`	Document classifier description.
`Baseclassifierid`	Base classifierId on top of which to train the classifier.
`Allowoverwrite`	Allow overwriting an existing classifier with the same name.

POST Classifies document with document classifier.

/documentClassifiers/{classifierId}:analyze

Classifies document with document classifier.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Api-version`	The API version to use for this operation.
`Overload`	Specifies the overload version of the classify operation to use, if applicable.
`Classifierid`	Unique document classifier name.
`Stringindextype`	Method used to compute string offset and length.
`Split`	Document splitting mode.
`Pages`	List of 1-based page numbers to analyze. Ex. "1-3,5,7-9"
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Urlsource`	Document URL to classify. Either urlSource or base64Source must be specified.
`Base64source`	Base64 encoding of the document to classify. Either urlSource or base64Source must be specified.

POST Copies document classifier to the target resource, region, and classifierId.

/documentClassifiers/{classifierId}:copyTo

Copies document classifier to the target resource, region, and classifierId.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Api-version`	The API version to use for this operation.
`Classifierid`	Unique document classifier name.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (6)

Option Name	Description
`Targetresourceid`	ID of the target Azure resource where the document classifier should be copied to.
`Targetresourceregion`	Location of the target Azure resource where the document classifier should be copied to.
`Targetclassifierid`	Identifier of the target document classifier.
`Targetclassifierlocation`	URL of the copied document classifier in the target account.
`Accesstoken`	Token used to authorize the request.
`Expirationdatetime`	Date/time when the access token expires.

POST Copies document model to the target resource, region, and modelId.

/documentModels/{modelId}:copyTo

Copies document model to the target resource, region, and modelId.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Api-version`	The API version to use for this operation.
`Modelid`	Unique document model name.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (6)

Option Name	Description
`Targetresourceid`	ID of the target Azure resource where the document model should be copied to.
`Targetresourceregion`	Location of the target Azure resource where the document model should be copied to.
`Targetmodelid`	Identifier of the target document model.
`Targetmodellocation`	URL of the copied document model in the target account.
`Accesstoken`	Token used to authorize the request.
`Expirationdatetime`	Date/time when the access token expires.

POST Creates a new document model from document types of existing document models.

/documentModels:compose

Creates a new document model from document types of existing document models.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Api-version`	The API version to use for this operation.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Modelid`	Unique document model name.
`Description`	Document model description.
`Classifierid`	Custom classifier to split and classify the input file.
`Split`	File splitting behavior.

DELETE Deletes document classifier.

/documentClassifiers/{classifierId}

Deletes document classifier.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Api-version`	The API version to use for this operation.
`Classifierid`	Unique document classifier name.
`X-ms-client-request-id`	An opaque, globally-unique, client-generated string identifier for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Deletes document model.

/documentModels/{modelId}

Deletes document model.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Api-version`	The API version to use for this operation.
`Modelid`	Unique document model name.
`X-ms-client-request-id`	An opaque, globally-unique, client-generated string identifier for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Generates authorization to copy a document classifier to this location with specified classifierId and optional description.

/documentClassifiers:authorizeCopy

Generates authorization to copy a document classifier to this location with
specified classifierId and optional description.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Api-version`	The API version to use for this operation.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Classifierid`	Unique document classifier name.
`Description`	Document classifier description.

POST Generates authorization to copy a document model to this location with specified modelId and optional description.

/documentModels:authorizeCopy

Generates authorization to copy a document model to this location with
specified modelId and optional description.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Api-version`	The API version to use for this operation.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Modelid`	Unique document model name.
`Description`	Document model description.

GET Gets detailed document classifier information.

/documentClassifiers/{classifierId}

Gets detailed document classifier information.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Api-version`	The API version to use for this operation.
`Classifierid`	Unique document classifier name.
`X-ms-client-request-id`	An opaque, globally-unique, client-generated string identifier for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Gets detailed document model information.

/documentModels/{modelId}

Gets detailed document model information.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Api-version`	The API version to use for this operation.
`Modelid`	Unique document model name.
`X-ms-client-request-id`	An opaque, globally-unique, client-generated string identifier for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Gets operation info.

/operations/{operationId}

Gets operation info.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Api-version`	The API version to use for this operation.
`Operationid`	Operation ID
`X-ms-client-request-id`	An opaque, globally-unique, client-generated string identifier for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Gets operation info.

/operations/{operationId}?_overload=getDocumentModelComposeOperation

Gets operation info.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Api-version`	The API version to use for this operation.
`Operationid`	Operation ID
`X-ms-client-request-id`	An opaque, globally-unique, client-generated string identifier for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Gets operation info.

/operations/{operationId}?_overload=getDocumentModelCopyToOperation

Gets operation info.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Api-version`	The API version to use for this operation.
`Operationid`	Operation ID
`X-ms-client-request-id`	An opaque, globally-unique, client-generated string identifier for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Gets operation info.

/operations/{operationId}?_overload=getDocumentClassifierCopyToOperation

Gets operation info.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Api-version`	The API version to use for this operation.
`Operationid`	Operation ID
`X-ms-client-request-id`	An opaque, globally-unique, client-generated string identifier for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Gets operation info.

/operations/{operationId}?_overload=getDocumentClassifierBuildOperation

Gets operation info.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Api-version`	The API version to use for this operation.
`Operationid`	Operation ID
`X-ms-client-request-id`	An opaque, globally-unique, client-generated string identifier for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Gets operation info.

/operations/{operationId}?_overload=getOperation

Gets operation info.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Api-version`	The API version to use for this operation.
`Operationid`	Operation ID
`X-ms-client-request-id`	An opaque, globally-unique, client-generated string identifier for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Gets the generated cropped image of specified figure from document analysis.

/documentModels/{modelId}/analyzeResults/{resultId}/figures/{figureId}

Gets the generated cropped image of specified figure from document analysis.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Api-version`	The API version to use for this operation.
`Modelid`	Unique document model name.
`Resultid`	Analyze operation result ID.
`Figureid`	Figure ID.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Gets the generated searchable PDF output from document analysis.

/documentModels/{modelId}/analyzeResults/{resultId}/pdf

Gets the generated searchable PDF output from document analysis.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Api-version`	The API version to use for this operation.
`Modelid`	Unique document model name.
`Resultid`	Analyze operation result ID.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Gets the result of batch document analysis.

/documentModels/{modelId}/analyzeBatchResults/{resultId}

Gets the result of batch document analysis.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Api-version`	The API version to use for this operation.
`Modelid`	Unique document model name.
`Resultid`	Analyze batch operation result ID.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Gets the result of document analysis.

/documentModels/{modelId}/analyzeResults/{resultId}

Gets the result of document analysis.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Api-version`	The API version to use for this operation.
`Modelid`	Unique document model name.
`Resultid`	Analyze operation result ID.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Gets the result of document classifier.

/documentClassifiers/{classifierId}/analyzeResults/{resultId}

Gets the result of document classifier.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Api-version`	The API version to use for this operation.
`Classifierid`	Unique document classifier name.
`Resultid`	Analyze operation result ID.
`Response Type`	The response format expected from the API (e.g. application/json).

GET List all document classifiers.

/documentClassifiers

List all document classifiers.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Api-version`	The API version to use for this operation.
`X-ms-client-request-id`	An opaque, globally-unique, client-generated string identifier for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

GET List all document models

/documentModels

List all document models

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Api-version`	The API version to use for this operation.
`X-ms-client-request-id`	An opaque, globally-unique, client-generated string identifier for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Lists all operations.

/operations

Lists all operations.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Api-version`	The API version to use for this operation.
`X-ms-client-request-id`	An opaque, globally-unique, client-generated string identifier for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Return information about the current resource.

/info

Return information about the current resource.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Api-version`	The API version to use for this operation.
`Response Type`	The response format expected from the API (e.g. application/json).

Download

GET Download Asset

x-oneteg-downloader-path-without-authorization

Downloads an asset from a specified URL using the provided HTTP method and connection settings.

Parameters

Parameter Name	Description
`HTTP Method`	Specifies the HTTP method to use for the download request, such as GET or POST.
`Download Url`	Specifies the URL from which the asset should be downloaded.
`Asset Name`	Specifies the name of the asset to be downloaded, used for identification or naming the downloaded file.
`Try Count`	Specifies the number of times to attempt the download in case of failure.
`Read Timeout (seconds)`	Specifies the timeout in seconds for reading data from the download stream.
`Connection Timeout (seconds)`	Specifies the timeout in seconds for establishing the connection to the download URL.
`Load File Content As Output`	This toggle enables you to load file content as the step output. Supported formats include JSON, XML, YML/YAML, CSV, TXT, and other text-based file types. Note that images, PDF files, and other binary formats cannot be loaded. Additionally, there is a file size limit for this feature; please check the logs for details.
`Follow Redirects`	Enable or disable following URL redirects. If it is enabled, it will follow the URL redirects.
`headers`	Additional HTTP header name/value pairs to include in the request.