DocumentAnalysisClientOptions interface

套件:

@azure/ai-form-recognizer

DocumentAnalysisClient 的可設定選項。

Extends

CommonClientOptions

屬性

audience	用於使用 Azure Active Directory 進行身份驗證的受眾（範圍）。 僅需要設置此選項 如果您使用的是 Entra ID （and） 如果您使用的是 AzurePublicCloud （“https://cognitiveservices.azure.com") 驗證範圍將會從這個物件設定。 有關已知的受眾值，請參閱 KnownFormRecognizerAudience 。
stringIndexType	服務傳回的字串位移/長度值單位。 在 JavaScript 中，字串會以 UTF-16 程式代碼單位編制索引。 除非您確定需要 Unicode 字碼點單位，否則 請勿 設定此值。 默認值：“utf16CodeUnit”

繼承的屬性

additionalPolicies	要包含在 HTTP 管線中的其他原則。
agent	針對傳出要求設定 Agent 實例的選項
allowInsecureConnection	如果要求是透過 HTTP 而不是 HTTPS 傳送，則設定為 true
httpClient	將用來傳送 HTTP 要求的 HttpClient。
proxyOptions	設定連出要求 Proxy 的選項。
redirectOptions	如何處理重新導向響應的選項。
retryOptions	控制如何重試失敗要求的選項。
telemetryOptions	將一般遙測和追蹤資訊設定為傳出要求的選項。
tlsOptions	設定 TLS 驗證的選項
userAgentOptions	將使用者代理程式詳細數據新增至傳出要求的選項。

屬性詳細資料

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[]

屬性值

AdditionalPolicyConfig[]

繼承自 CommonClientOptions.additionalPolicies

agent

針對傳出要求設定 Agent 實例的選項

agent?: Agent

屬性值

Agent

繼承自 CommonClientOptions.agent

allowInsecureConnection

如果要求是透過 HTTP 而不是 HTTPS 傳送，則設定為 true

allowInsecureConnection?: boolean

屬性值

boolean

繼承自 CommonClientOptions.allowInsecureConnection

httpClient

將用來傳送 HTTP 要求的 HttpClient。

httpClient?: HttpClient

屬性值

HttpClient

繼承自 CommonClientOptions.HTTPClient

proxyOptions

設定連出要求 Proxy 的選項。

proxyOptions?: ProxySettings

屬性值

ProxySettings

繼承自 CommonClientOptions.proxyOptions

redirectOptions

如何處理重新導向響應的選項。

redirectOptions?: RedirectPolicyOptions

屬性值

RedirectPolicyOptions

繼承自 CommonClientOptions.redirectOptions

retryOptions

控制如何重試失敗要求的選項。

retryOptions?: PipelineRetryOptions

屬性值

PipelineRetryOptions

繼承自 CommonClientOptions.retryOptions

telemetryOptions

將一般遙測和追蹤資訊設定為傳出要求的選項。

telemetryOptions?: TelemetryOptions

屬性值

TelemetryOptions

繼承自 CommonClientOptions.telemetryOptions

tlsOptions

設定 TLS 驗證的選項

tlsOptions?: TlsSettings

屬性值

TlsSettings

繼承自 CommonClientOptions.tlsOptions

userAgentOptions

將使用者代理程式詳細數據新增至傳出要求的選項。

userAgentOptions?: UserAgentPolicyOptions

屬性值

UserAgentPolicyOptions

繼承自 CommonClientOptions.userAgentOptions