Поделиться через

SearchClientOptions interface

  • Ссылка
Пакет:
@azure/search-documents

Параметры клиента, используемые для настройки запросов API Когнитивного поиска.

Extends
ExtendedCommonClientOptions

Свойства

apiVersion

Версия API, используемая при взаимодействии со службой.
audience

Аудитория, используемая для проверки подлинности с помощью Azure Active Directory (AAD). Аудитория не учитывается при использовании общего ключа. KnownSearchAudience можно использовать взаимозаменяемо с аудиторией
serviceVersion

Версия службы, используемая при взаимодействии со службой.

Унаследованные свойства

additionalPolicies

Дополнительные политики для включения в конвейер HTTP.
allowInsecureConnection

Задайте значение true, если запрос отправляется по протоколу HTTP, а не по протоколу HTTPS.
httpClient

HttpClient, который будет использоваться для отправки HTTP-запросов.
keepAliveOptions

Параметры для отключения режима поддержания активности.
proxyOptions

Параметры настройки прокси-сервера для исходящих запросов.
redirectOptions

Параметры обработки ответов перенаправления.
retryOptions

Параметры, управляющие повторными попытками неудачных запросов.
telemetryOptions

Параметры для настройки общих данных телеметрии и трассировки для исходящих запросов.
tlsOptions

Параметры настройки проверки подлинности TLS
userAgentOptions

Параметры добавления сведений об агенте пользователя в исходящие запросы.

Сведения о свойстве

apiVersion

Предупреждение

Теперь этот API является нерекомендуемым.

use serviceVersion instead

Версия API, используемая при взаимодействии со службой.

apiVersion?: string

Значение свойства

string

audience

Аудитория, используемая для проверки подлинности с помощью Azure Active Directory (AAD). Аудитория не учитывается при использовании общего ключа. KnownSearchAudience можно использовать взаимозаменяемо с аудиторией

audience?: string

Значение свойства

string

serviceVersion

Версия службы, используемая при взаимодействии со службой.

serviceVersion?: string

Значение свойства

string

Сведения об унаследованном свойстве

additionalPolicies

Дополнительные политики для включения в конвейер HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Значение свойства

AdditionalPolicyConfig[]

Наследуется от ExtendedCommonClientOptions.additionalPolicies

allowInsecureConnection

Задайте значение true, если запрос отправляется по протоколу HTTP, а не по протоколу HTTPS.

allowInsecureConnection?: boolean

Значение свойства

boolean

Наследуется от ExtendedCommonClientOptions.allowInsecureConnection

httpClient

HttpClient, который будет использоваться для отправки HTTP-запросов.

httpClient?: HttpClient

Значение свойства

HttpClient

Наследуется от ExtendedCommonClientOptions.httpClient

keepAliveOptions

Параметры для отключения режима поддержания активности.

keepAliveOptions?: KeepAliveOptions

Значение свойства

KeepAliveOptions

Наследуется от ExtendedCommonClientOptions.keepAliveOptions

proxyOptions

Параметры настройки прокси-сервера для исходящих запросов.

proxyOptions?: ProxySettings

Значение свойства

ProxySettings

Наследуется от ExtendedCommonClientOptions.proxyOptions

redirectOptions

Параметры обработки ответов перенаправления.

redirectOptions?: RedirectPolicyOptions & RedirectOptions

Значение свойства

RedirectPolicyOptions & RedirectOptions

Наследуется от ExtendedCommonClientOptions.redirectOptions

retryOptions

Параметры, управляющие повторными попытками неудачных запросов.

retryOptions?: PipelineRetryOptions

Значение свойства

PipelineRetryOptions

Наследуется от ExtendedCommonClientOptions.retryOptions

telemetryOptions

Параметры для настройки общих данных телеметрии и трассировки для исходящих запросов.

telemetryOptions?: TelemetryOptions

Значение свойства

TelemetryOptions

Наследуется от ExtendedCommonClientOptions.telemetryOptions

tlsOptions

Параметры настройки проверки подлинности TLS

tlsOptions?: TlsSettings

Значение свойства

TlsSettings

Наследуется от ExtendedCommonClientOptions.tlsOptions

userAgentOptions

Параметры добавления сведений об агенте пользователя в исходящие запросы.

userAgentOptions?: UserAgentPolicyOptions

Значение свойства

UserAgentPolicyOptions

Наследуется от ExtendedCommonClientOptions.userAgentOptions