SearchClientOptions interface

Balíček:

@azure/search-documents

Možnosti klienta používané ke konfiguraci požadavků rozhraní API služby Cognitive Search

Extends

ExtendedCommonClientOptions

Vlastnosti

apiVersion	Verze rozhraní API, která se má použít při komunikaci se službou
audience	Cílová skupina, která se má použít k ověřování pomocí Azure Active Directory (AAD). Při použití sdíleného klíče se nezohlední cílová skupina. KnownSearchAudience lze použít zaměnitelně s cílovou skupinou.
serviceVersion	Verze služby, která se má použít při komunikaci se službou.

Zděděné vlastnosti

additionalPolicies	Další zásady, které se mají zahrnout do kanálu HTTP.
allowInsecureConnection	Nastavte na hodnotu true, pokud se požadavek odesílá přes HTTP místo https.
httpClient	HttpClient, který se použije k odesílání požadavků HTTP.
keepAliveOptions	Možnosti pro zakázání funkce Udržovat při životě
proxyOptions	Možnosti konfigurace proxy serveru pro odchozí požadavky
redirectOptions	Možnosti zpracování odpovědí přesměrování
retryOptions	Možnosti, které určují, jak opakovat neúspěšné žádosti.
telemetryOptions	Možnosti nastavení běžné telemetrie a trasování informací pro odchozí požadavky
tlsOptions	Možnosti konfigurace ověřování TLS
userAgentOptions	Možnosti pro přidání podrobností o uživatelském agentu k odchozím požadavkům

Podrobnosti vlastnosti

apiVersion

Upozornění

Toto rozhraní API je teď zastaralé.

use serviceVersion instead

Verze rozhraní API, která se má použít při komunikaci se službou

apiVersion?: string

Hodnota vlastnosti

string

audience

Cílová skupina, která se má použít k ověřování pomocí Azure Active Directory (AAD). Při použití sdíleného klíče se nezohlední cílová skupina. KnownSearchAudience lze použít zaměnitelně s cílovou skupinou.

audience?: string

Hodnota vlastnosti

string

serviceVersion

Verze služby, která se má použít při komunikaci se službou.

serviceVersion?: string

Hodnota vlastnosti

string

Podrobnosti zděděných vlastností

additionalPolicies

Další zásady, které se mají zahrnout do kanálu HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Hodnota vlastnosti

AdditionalPolicyConfig[]

Zděděno z ExtendedCommonClientOptions.additionalPolicies

allowInsecureConnection

Nastavte na hodnotu true, pokud se požadavek odesílá přes HTTP místo https.

allowInsecureConnection?: boolean

Hodnota vlastnosti

boolean

Zděděno z ExtendedCommonClientOptions.allowInsecureConnection

httpClient

HttpClient, který se použije k odesílání požadavků HTTP.

httpClient?: HttpClient

Hodnota vlastnosti

HttpClient

Zděděno z ExtendedCommonClientOptions.httpClient

keepAliveOptions

Možnosti pro zakázání funkce Udržovat při životě

keepAliveOptions?: KeepAliveOptions

Hodnota vlastnosti

KeepAliveOptions

Zděděno z ExtendedCommonClientOptions.keepAliveOptions

proxyOptions

Možnosti konfigurace proxy serveru pro odchozí požadavky

proxyOptions?: ProxySettings

Hodnota vlastnosti

ProxySettings

Zděděno z ExtendedCommonClientOptions.proxyOptions

redirectOptions

Možnosti zpracování odpovědí přesměrování

redirectOptions?: RedirectPolicyOptions & RedirectOptions

Hodnota vlastnosti

RedirectPolicyOptions & RedirectOptions

Zděděno z ExtendedCommonClientOptions.redirectOptions

retryOptions

Možnosti, které určují, jak opakovat neúspěšné žádosti.

retryOptions?: PipelineRetryOptions

Hodnota vlastnosti

PipelineRetryOptions

Zděděno z ExtendedCommonClientOptions.retryOptions

telemetryOptions

Možnosti nastavení běžné telemetrie a trasování informací pro odchozí požadavky

telemetryOptions?: TelemetryOptions

Hodnota vlastnosti

TelemetryOptions

Zděděno z ExtendedCommonClientOptions.telemetryOptions

tlsOptions

Možnosti konfigurace ověřování TLS

tlsOptions?: TlsSettings

Hodnota vlastnosti

TlsSettings

Zděděno z ExtendedCommonClientOptions.tlsOptions

userAgentOptions

Možnosti pro přidání podrobností o uživatelském agentu k odchozím požadavkům

userAgentOptions?: UserAgentPolicyOptions

Hodnota vlastnosti

UserAgentPolicyOptions

Zděděno z ExtendedCommonClientOptions.userAgentOptions