KnowledgeRetrievalClientOptions interface

パッケージ:

@azure/search-documents

Cognitive Search API 要求の構成に使用されるクライアント オプション。

Extends

ExtendedCommonClientOptions

プロパティ

audience	Azure Active Directory (AAD) での認証に使用する対象ユーザー。 共有キーを使用する場合、対象ユーザーは考慮されません。 KnownSearchAudience は、audience と同じ意味で使用できます
serviceVersion	サービスとの通信時に使用するサービスバージョン。

継承されたプロパティ

additionalPolicies	HTTP パイプラインに含める追加のポリシー。
agent	送信要求のエージェント インスタンスを構成するためのオプション
allowInsecureConnection	要求が HTTPS ではなく HTTP 経由で送信される場合は true に設定します
httpClient	HTTP 要求の送信に使用される HttpClient。
keepAliveOptions	キープアライブを無効にするオプション。
proxyOptions	送信要求のプロキシを構成するためのオプション。
redirectOptions	リダイレクト応答の処理方法のオプション。
retryOptions	失敗した要求を再試行する方法を制御するオプション。
telemetryOptions	一般的なテレメトリとトレース情報を送信要求に設定するためのオプション。
tlsOptions	TLS 認証を構成するためのオプション
userAgentOptions	送信要求にユーザー エージェントの詳細を追加するためのオプション。

プロパティの詳細

audience

Azure Active Directory (AAD) での認証に使用する対象ユーザー。 共有キーを使用する場合、対象ユーザーは考慮されません。 KnownSearchAudience は、audience と同じ意味で使用できます

audience?: string

プロパティ値

string

serviceVersion

サービスとの通信時に使用するサービスバージョン。

serviceVersion?: string

プロパティ値

string

継承されたプロパティの詳細

additionalPolicies

HTTP パイプラインに含める追加のポリシー。

additionalPolicies?: AdditionalPolicyConfig[]

プロパティ値

AdditionalPolicyConfig[]

継承元 ExtendedCommonClientOptions.additionalPolicies (拡張された CommonClientOptions.additionalPolicies)

agent

送信要求のエージェント インスタンスを構成するためのオプション

agent?: Agent

プロパティ値

Agent

継承元 ExtendedCommonClientOptions.agent です。

allowInsecureConnection

要求が HTTPS ではなく HTTP 経由で送信される場合は true に設定します

allowInsecureConnection?: boolean

プロパティ値

boolean

継承元 ExtendedCommonClientOptions.allowInsecureConnection

httpClient

HTTP 要求の送信に使用される HttpClient。

httpClient?: HttpClient

プロパティ値

HttpClient

継承元 ExtendedCommonClientOptions.httpクライアント

keepAliveOptions

キープアライブを無効にするオプション。

keepAliveOptions?: KeepAliveOptions

プロパティ値

KeepAliveOptions

継承元 ExtendedCommonClientOptions.keepAliveOptions (拡張CommonClientOptions.keepAliveOptions)

proxyOptions

送信要求のプロキシを構成するためのオプション。

proxyOptions?: ProxySettings

プロパティ値

ProxySettings

継承元 ExtendedCommonClientOptions.proxyOptions (拡張 CommonClientOptions.proxyOptions)

redirectOptions

リダイレクト応答の処理方法のオプション。

redirectOptions?: RedirectPolicyOptions & RedirectOptions

プロパティ値

RedirectPolicyOptions & RedirectOptions

継承元 ExtendedCommonClientOptions.redirectOptions (拡張された CommonClientOptions.redirectOptions)

retryOptions

失敗した要求を再試行する方法を制御するオプション。

retryOptions?: PipelineRetryOptions

プロパティ値

PipelineRetryOptions

継承元 ExtendedCommonClientOptions.retryOptions

telemetryOptions

一般的なテレメトリとトレース情報を送信要求に設定するためのオプション。

telemetryOptions?: TelemetryOptions

プロパティ値

TelemetryOptions

継承元 ExtendedCommonClientOptions.telemetryOptions

tlsOptions

TLS 認証を構成するためのオプション

tlsOptions?: TlsSettings

プロパティ値

TlsSettings

継承元 ExtendedCommonClientOptions.tlsオプション

userAgentOptions

送信要求にユーザー エージェントの詳細を追加するためのオプション。

userAgentOptions?: UserAgentPolicyOptions

プロパティ値

UserAgentPolicyOptions

継承元 ExtendedCommonClientOptions.userAgentOptions (拡張CommonClientOptions.userAgentオプション)