你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

AnalyzeDocumentOptions interface

文档分析作的选项。

扩展

属性

features

要在模型中启用的功能列表。 启用功能可能会产生额外的成本,因此请务必咨询服务文档,以了解功能的性质以及与使用这些功能相关的任何附加成本。

有关表单识别器中可用的功能的详细信息,请参阅服务文档:https://aka.ms/azsdk/formrecognizer/features

locale

文本识别和文档分析的区域设置提示。

该值只能指定双字母语言代码或指示语言和区域的 BCP-47 语言标记。

例子:

  • “en-US”(美国英语)
  • “fr”(法语 - 无区域)
pages

要分析的输入文档中的页面范围(1 索引)的列表,用逗号分隔

示例:“1”、“3-5”、“1,3-5”

继承属性

abortSignal

可用于中止请求的信号。

onProgress

轮询器状态更新时将调用的可选初始进度处理程序。 在初始化轮询器状态后,将立即调用此处理程序。

onResponse

在执行请求的作时,每次从服务器接收响应时调用的函数。 可以多次调用。

requestOptions

为此作创建和发送 HTTP 请求时使用的选项。

resumeFrom

序列化的轮询器状态。 如果提供,则轮询作将从给定状态恢复,而不是像它是新作一样启动。

serializerOptions

用于替代序列化/取消序列化行为的选项。

tracingOptions

启用跟踪时使用的选项。

updateIntervalInMs

与同一作相关的后续请求之间的等待时间(以毫秒为单位)。

属性详细信息

features

要在模型中启用的功能列表。 启用功能可能会产生额外的成本,因此请务必咨询服务文档,以了解功能的性质以及与使用这些功能相关的任何附加成本。

有关表单识别器中可用的功能的详细信息,请参阅服务文档:https://aka.ms/azsdk/formrecognizer/features

features?: FormRecognizerFeature[]

属性值

FormRecognizerFeature[]

locale

文本识别和文档分析的区域设置提示。

该值只能指定双字母语言代码或指示语言和区域的 BCP-47 语言标记。

例子:

  • “en-US”(美国英语)
  • “fr”(法语 - 无区域)
locale?: string

属性值

string

pages

要分析的输入文档中的页面范围(1 索引)的列表,用逗号分隔

示例:“1”、“3-5”、“1,3-5”

pages?: string

属性值

string

继承属性详细信息

abortSignal

可用于中止请求的信号。

abortSignal?: AbortSignalLike

属性值

继承自 PollerOptions.abortSignal

onProgress

轮询器状态更新时将调用的可选初始进度处理程序。 在初始化轮询器状态后,将立即调用此处理程序。

onProgress?: (state: DocumentAnalysisPollOperationState<Result>) => void

属性值

(state: DocumentAnalysisPollOperationState<Result>) => void

继承自PollerOptions.onProgress

onResponse

在执行请求的作时,每次从服务器接收响应时调用的函数。 可以多次调用。

onResponse?: RawResponseCallback

属性值

继承自PollerOptions.onResponse

requestOptions

为此作创建和发送 HTTP 请求时使用的选项。

requestOptions?: OperationRequestOptions

属性值

继承自 PollerOptions.requestOptions

resumeFrom

序列化的轮询器状态。 如果提供,则轮询作将从给定状态恢复,而不是像它是新作一样启动。

resumeFrom?: string

属性值

string

继承自 PollerOptions.resumeFrom

serializerOptions

用于替代序列化/取消序列化行为的选项。

serializerOptions?: SerializerOptions

属性值

继承自 PollerOptions.serializerOptions

tracingOptions

启用跟踪时使用的选项。

tracingOptions?: OperationTracingOptions

属性值

继承自PollerOptions.tracingOptions

updateIntervalInMs

与同一作相关的后续请求之间的等待时间(以毫秒为单位)。

updateIntervalInMs?: number

属性值

number

继承自PollerOptions.updateIntervalInMs