SearchClientOptions interface

Balíček:

@azure/search-documents

Možnosti klienta používané ke konfiguraci požadavků rozhraní API kognitivního vyhledávání

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). Cílová skupina se při použití sdíleného klíče nepovažuje za cílovou skupinu. PoleSearchAudience 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.
agent	Možnosti konfigurace instance agenta pro odchozí požadavky
allowInsecureConnection	Nastavte hodnotu true, pokud se požadavek odesílá přes protokol HTTP místo HTTPS.
httpClient	HttpClient, který se použije k odesílání požadavků HTTP.
keepAliveOptions	Možnosti pro zakázání zachování aktivního života
proxyOptions	Možnosti konfigurace proxy serveru pro odchozí požadavky
redirectOptions	Možnosti zpracování odpovědí na přesměrování
retryOptions	Možnosti, které řídí, jak opakovat neúspěšné požadavky.
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 přidání podrobností o uživatelském agentu do odchozích požadavků

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). Cílová skupina se při použití sdíleného klíče nepovažuje za cílovou skupinu. PoleSearchAudience 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ěné z ExtendedCommonClientOptions.additionalPolicies

agent

Možnosti konfigurace instance agenta pro odchozí požadavky

agent?: Agent

Hodnota vlastnosti

Agent

zděděno z ExtendedCommonClientOptions.agent

allowInsecureConnection

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

allowInsecureConnection?: boolean

Hodnota vlastnosti

boolean

zděděné 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í zachování aktivního života

keepAliveOptions?: KeepAliveOptions

Hodnota vlastnosti

KeepAliveOptions

zděděné z ExtendedCommonClientOptions.keepAliveOptions

proxyOptions

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

proxyOptions?: ProxySettings

Hodnota vlastnosti

ProxySettings

zděděné z ExtendedCommonClientOptions.proxyOptions

redirectOptions

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

redirectOptions?: RedirectPolicyOptions & RedirectOptions

Hodnota vlastnosti

RedirectPolicyOptions & RedirectOptions

zděděné z ExtendedCommonClientOptions.redirectOptions

retryOptions

Možnosti, které řídí, jak opakovat neúspěšné požadavky.

retryOptions?: PipelineRetryOptions

Hodnota vlastnosti

PipelineRetryOptions

zděděné 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ěné z ExtendedCommonClientOptions.telemetryOptions

tlsOptions

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

tlsOptions?: TlsSettings

Hodnota vlastnosti

TlsSettings

zděděné z ExtendedCommonClientOptions.tlsOptions

userAgentOptions

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

userAgentOptions?: UserAgentPolicyOptions

Hodnota vlastnosti

UserAgentPolicyOptions

zděděné z ExtendedCommonClientOptions.userAgentOptions