Udostępnij przez

SearchClientOptions interface

Pakiet:
@azure/search-documents

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

Rozszerzenie
ExtendedCommonClientOptions

Właściwości

apiVersion

Wersja interfejsu API do użycia podczas komunikacji 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ółużytkowanego. KnownSearchAudience można używać zamiennie z odbiorcami
serviceVersion

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

Właściwości dziedziczone

additionalPolicies

Dodatkowe zasady do uwzględnienia w potoku HTTP.
agent

Opcje konfigurowania wystąpienia agenta dla żądań wychodzących
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 komunikacji 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ółużytkowanego. KnownSearchAudience 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 komunikacji 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

agent

Opcje konfigurowania wystąpienia agenta dla żądań wychodzących

agent?: Agent

Wartość właściwości

Agent

dziedziczone z ExtendedCommonClientOptions.agent

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