Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DocumentAnalysisClientOptions

Package version

Configurable options for DocumentAnalysisClient.

Hierarchy

Index

Properties

Optional apiVersion

The version of the Form Recognizer REST API to call. Service versions 2.1 and lower (non-date-based versions) are not supported by this client. To use API version 2.1, please use version 3 of the Azure Form Recognizer SDK for JavaScript (@azure/ai-form-recognizer@^3.2.0).

Default: FormRecognizerApiVersion.Stable ("2022-08-31")

Optional stringIndexType

stringIndexType: StringIndexType

The unit of string offset/length values that the service returns.

In JavaScript, strings are indexed by UTF-16 code units. Do NOT set this value unless you are certain you need Unicode code-point units instead.

Default: "utf16CodeUnit"

Generated using TypeDoc