SearchClientOptions interface

Pakiet:

@azure/search-documents

Opcje klienta używane do konfigurowania żądań interfejsu API wyszukiwania poznawczego.

Extends

ExtendedCommonClientOptions

Właściwości

apiVersion	Wersja interfejsu API do użycia podczas komunikowania się z usługą.
audience	Odbiorcy do użycia do uwierzytelniania w usłudze Azure Active Directory (AAD). Odbiorcy nie są brani pod uwagę podczas korzystania z klucza wspólnego. ZnaneSearchAudience można używać zamiennie z odbiorcami
serviceVersion	Wersja usługi, która ma być używana podczas komunikowania się z usługą.

Właściwości dziedziczone

additionalPolicies	Dodatkowe zasady do uwzględnienia w potoku HTTP.
allowInsecureConnection	Ustaw wartość true, jeśli żądanie jest wysyłane za pośrednictwem protokołu HTTP zamiast HTTPS
httpClient	Obiekt HttpClient, który będzie używany do wysyłania żądań HTTP.
keepAliveOptions	Opcje wyłączania zachowania aktywności.
proxyOptions	Opcje konfigurowania serwera proxy dla żądań wychodzących.
redirectOptions	Opcje obsługi odpowiedzi przekierowania.
retryOptions	Opcje kontrolujące sposób ponawiania żądań, które zakończyły się niepowodzeniem.
telemetryOptions	Opcje ustawiania typowych danych telemetrycznych i informacji śledzenia na żądania wychodzące.
tlsOptions	Opcje konfigurowania uwierzytelniania TLS
userAgentOptions	Opcje dodawania szczegółów agenta użytkownika do żądań wychodzących.

Szczegóły właściwości

apiVersion

Ostrzeżenie

Ten interfejs API jest już przestarzały.

use serviceVersion instead

Wersja interfejsu API do użycia podczas komunikowania się z usługą.

apiVersion?: string

Wartość właściwości

string

audience

Odbiorcy do użycia do uwierzytelniania w usłudze Azure Active Directory (AAD). Odbiorcy nie są brani pod uwagę podczas korzystania z klucza wspólnego. ZnaneSearchAudience można używać zamiennie z odbiorcami

audience?: string

Wartość właściwości

string

serviceVersion

Wersja usługi, która ma być używana podczas komunikowania się z usługą.

serviceVersion?: string

Wartość właściwości

string

Szczegóły właściwości dziedziczonej

additionalPolicies

Dodatkowe zasady do uwzględnienia w potoku HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Wartość właściwości

AdditionalPolicyConfig[]

Dziedziczone z ExtendedCommonClientOptions.additionalPolicies

allowInsecureConnection

Ustaw wartość true, jeśli żądanie jest wysyłane za pośrednictwem protokołu HTTP zamiast HTTPS

allowInsecureConnection?: boolean

Wartość właściwości

boolean

Dziedziczone z ExtendedCommonClientOptions.allowInsecureConnection

httpClient

Obiekt HttpClient, który będzie używany do wysyłania żądań HTTP.

httpClient?: HttpClient

Wartość właściwości

HttpClient

Dziedziczone z ExtendedCommonClientOptions.httpClient

keepAliveOptions

Opcje wyłączania zachowania aktywności.

keepAliveOptions?: KeepAliveOptions

Wartość właściwości

KeepAliveOptions

Dziedziczone z ExtendedCommonClientOptions.keepAliveOptions

proxyOptions

Opcje konfigurowania serwera proxy dla żądań wychodzących.

proxyOptions?: ProxySettings

Wartość właściwości

ProxySettings

Dziedziczone z ExtendedCommonClientOptions.proxyOptions

redirectOptions

Opcje obsługi odpowiedzi przekierowania.

redirectOptions?: RedirectPolicyOptions & RedirectOptions

Wartość właściwości

RedirectPolicyOptions & RedirectOptions

Dziedziczone z ExtendedCommonClientOptions.redirectOptions

retryOptions

Opcje kontrolujące sposób ponawiania żądań, które zakończyły się niepowodzeniem.

retryOptions?: PipelineRetryOptions

Wartość właściwości

PipelineRetryOptions

Dziedziczone z ExtendedCommonClientOptions.retryOptions

telemetryOptions

Opcje ustawiania typowych danych telemetrycznych i informacji śledzenia na żądania wychodzące.

telemetryOptions?: TelemetryOptions

Wartość właściwości

TelemetryOptions

Dziedziczone z ExtendedCommonClientOptions.telemetryOptions

tlsOptions

Opcje konfigurowania uwierzytelniania TLS

tlsOptions?: TlsSettings

Wartość właściwości

TlsSettings

Dziedziczone z ExtendedCommonClientOptions.tlsOptions

userAgentOptions

Opcje dodawania szczegółów agenta użytkownika do żądań wychodzących.

userAgentOptions?: UserAgentPolicyOptions

Wartość właściwości

UserAgentPolicyOptions

Dziedziczone z ExtendedCommonClientOptions.userAgentOptions