Sign in

v4

latestSwagger 2.02026-07-132779157.6 KB

Analyzes batch documents with document model.

post/documentModels/{modelId}:analyzeBatch

Path parameters

modelIdstring required

Unique document model name.

Query parameters

api-versionstring required

The API version to use for this operation.

pagesstring

1-based page numbers to analyze. Ex. "1-3,5,7-9"

localestring

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'textElements' | 'unicodeCodePoint' | 'utf16CodeUnit'

Method used to compute string offset and length.

featuresstring[]

List of optional analysis features.

queryFieldsstring[]

List of additional fields to extract. Ex. "NumberOfGuests,StoreNumber"

outputContentFormat'text' | 'markdown'

Format of the analyze result top-level content.

outputstring[]

Additional outputs to generate during analysis.

Request body

resultContainerUrlstring uri required

Azure Blob Storage container URL where analyze result files will be stored.

resultPrefixstring

Blob name prefix of result files.

overwriteExistingboolean

Overwrite existing analyze result files?

Response

The request has been accepted for processing, but processing has not yet completed.