Share via

AnalyzeDocumentQueryParamProperties interface

Package:
@azure-rest/ai-document-intelligence

Properties

features

List of optional analysis features.
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").
output

Additional outputs to generate during analysis.
outputContentFormat

Format of the analyze result top-level content.

Possible values: "text", "markdown"
pages

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

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

Method used to compute string offset and length.

Possible values: "textElements", "unicodeCodePoint", "utf16CodeUnit"

Property Details

features

List of optional analysis features.

features?: string[]

Property Value

string[]

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

locale?: string

Property Value

string

output

Additional outputs to generate during analysis.

output?: string[]

Property Value

string[]

outputContentFormat

Format of the analyze result top-level content.

Possible values: "text", "markdown"

outputContentFormat?: string

Property Value

string

pages

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

pages?: string

Property Value

string

queryFields

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

queryFields?: string[]

Property Value

string[]

stringIndexType

Method used to compute string offset and length.

Possible values: "textElements", "unicodeCodePoint", "utf16CodeUnit"

stringIndexType?: string

Property Value

string