Document Intelligence (formerly Form Recognizer) (stable:2024-11-30)

2024/12/11 • 1 updated methods

DocumentModels_AnalyzeBatchDocuments (updated)
Description :  Analyzes batch documents with document model.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DocumentModels_AnalyzeBatchDocuments",
  "$parameters": [
    {
      "#name": "analyzeBatchRequest",
      "Required": {
        "new": true,
        "old": false
      }
    }
  ]
}

⚼ Request

POST:  /documentModels/{modelId}:analyzeBatch
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
modelId:
{
Description: Unique document model name. ,
Required: True ,
}
string ,
pages:
{
Description: 1-based page numbers to analyze. Ex. "1-3,5,7-9" ,
Required: False ,
}
string ,
locale:
{
Description: 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"). ,
Required: False ,
}
string ,
stringIndexType:
{
Description: Method used to compute string offset and length. ,
Required: False ,
}
string ,
features:
{
Description: List of optional analysis features. ,
Required: False ,
}
array ,
queryFields:
{
Description: List of additional fields to extract. Ex. "NumberOfGuests,StoreNumber" ,
Required: False ,
}
array ,
outputContentFormat:
{
Description: Format of the analyze result top-level content. ,
Required: False ,
}
string ,
output:
{
Description: Additional outputs to generate during analysis. ,
Required: False ,
}
array ,
analyzeBatchRequest:
{
Description: Analyze batch request parameters. ,
Required: True ,
}
{
azureBlobSource:
{
Description: Azure Blob Storage location containing the batch documents. Either azureBlobSource or azureBlobFileListSource must be specified. ,
Required: False ,
}
{
containerUrl:
{
Description: Azure Blob Storage container URL. ,
Format: uri ,
Required: True ,
}
string ,
prefix:
{
Description: Blob name prefix. ,
Required: False ,
}
string ,
}
,
azureBlobFileListSource:
{
Description: Azure Blob Storage file list specifying the batch documents. Either azureBlobSource or azureBlobFileListSource must be specified. ,
Required: False ,
}
{
containerUrl:
{
Description: Azure Blob Storage container URL. ,
Format: uri ,
Required: True ,
}
string ,
fileList:
{
Description: Path to a JSONL file within the container specifying a subset of documents. ,
Required: True ,
}
string ,
}
,
resultContainerUrl:
{
Description: Azure Blob Storage container URL where analyze result files will be stored. ,
Format: uri ,
Required: True ,
}
string ,
resultPrefix:
{
Description: Blob name prefix of result files. ,
Required: False ,
}
string ,
overwriteExisting:
{
Description: Overwrite existing analyze result files? ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{
operation-location:
{
Description: The location of an instance of AnalyzeBatchOperation ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: Error info. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}