DocumentAnalysisClientOptions interface
DocumentAnalysisClient 的可配置选项。
属性
| audience | 用于使用 Azure Active Directory 进行身份验证的受众（范围）。 仅需要设置此选项
将从此受众设置身份验证范围。 有关已知的受众值，请参阅 KnownFormRecognizerAudience 。 |
| string |
服务返回的字符串偏移/长度值的单位。 在 JavaScript 中，字符串由 UTF-16 代码单元编制索引。 请勿 不 设置此值，除非确定需要 Unicode 码位单位。 默认值：“utf16CodeUnit” |
继承属性
| additional |
要包含在 HTTP 管道中的其他策略。 |
| agent | 为传出请求配置代理实例的选项 |
| allow |
如果请求通过 HTTP 而不是 HTTPS 发送，则设置为 true |
| http |
将用于发送 HTTP 请求的 HttpClient。 |
| proxy |
为传出请求配置代理的选项。 |
| redirect |
有关如何处理重定向响应的选项。 |
| retry |
控制如何重试失败请求的选项。 |
| telemetry |
用于将常见遥测和跟踪信息设置为传出请求的选项。 |
| tls |
配置 TLS 身份验证的选项 |
| user |
用于将用户代理详细信息添加到传出请求的选项。 |
属性详细信息
audience
用于使用 Azure Active Directory 进行身份验证的受众（范围）。
仅需要设置此选项
- 如果您使用的是 Entra ID （and）
- 如果您使用的是
AzurePublicCloud（“https://cognitiveservices.azure.com")
将从此受众设置身份验证范围。 有关已知的受众值，请参阅 KnownFormRecognizerAudience 。
audience?: string属性值
string
stringIndexType
服务返回的字符串偏移/长度值的单位。
在 JavaScript 中，字符串由 UTF-16 代码单元编制索引。 请勿 不 设置此值，除非确定需要 Unicode 码位单位。
默认值：“utf16CodeUnit”
stringIndexType?: StringIndexType属性值
StringIndexType
继承属性详细信息
additionalPolicies
要包含在 HTTP 管道中的其他策略。
additionalPolicies?: AdditionalPolicyConfig[]属性值
继承自 CommonClientOptions.additionalPolicies
agent
allowInsecureConnection
如果请求通过 HTTP 而不是 HTTPS 发送，则设置为 true
allowInsecureConnection?: boolean属性值
boolean
继承自 CommonClientOptions.allowInsecureConnection
httpClient
将用于发送 HTTP 请求的 HttpClient。
httpClient?: HttpClient属性值
继承自 CommonClientOptions.httpClient
proxyOptions
redirectOptions
有关如何处理重定向响应的选项。
redirectOptions?: RedirectPolicyOptions属性值
继承自 CommonClientOptions.redirectOptions
retryOptions
控制如何重试失败请求的选项。
retryOptions?: PipelineRetryOptions属性值
继承自 CommonClientOptions.retryOptions
telemetryOptions
用于将常见遥测和跟踪信息设置为传出请求的选项。
telemetryOptions?: TelemetryOptions属性值
继承自 CommonClientOptions.telemetryOptions
tlsOptions
userAgentOptions
用于将用户代理详细信息添加到传出请求的选项。
userAgentOptions?: UserAgentPolicyOptions属性值
继承自 CommonClientOptions.userAgentOptions