SearchClientOptions interface

Paket:

@azure/search-documents

Opsi klien yang digunakan untuk mengonfigurasi permintaan Cognitive Search API.

Memperluas

ExtendedCommonClientOptions

Properti

apiVersion	Versi API yang digunakan saat berkomunikasi dengan layanan.
audience	Audiens yang digunakan untuk autentikasi dengan Azure Active Directory (AAD). Audiens tidak dipertimbangkan saat menggunakan kunci bersama. KnownSearchAudience dapat digunakan secara bergantian dengan audiens
serviceVersion	Versi layanan yang digunakan saat berkomunikasi dengan layanan.

Properti yang Diwariskan

additionalPolicies	Kebijakan tambahan untuk disertakan dalam alur HTTP.
agent	Opsi untuk mengonfigurasi instans Agen untuk permintaan keluar
allowInsecureConnection	Atur ke true jika permintaan dikirim melalui HTTP alih-alih HTTPS
httpClient	HttpClient yang akan digunakan untuk mengirim permintaan HTTP.
keepAliveOptions	Opsi untuk menonaktifkan tetap hidup.
proxyOptions	Opsi untuk mengonfigurasi proksi untuk permintaan keluar.
redirectOptions	Opsi untuk bagaimana respons pengalihan ditangani.
retryOptions	Opsi yang mengontrol cara mencoba kembali permintaan yang gagal.
telemetryOptions	Opsi untuk mengatur telemetri umum dan melacak info ke permintaan keluar.
tlsOptions	Opsi untuk mengonfigurasi autentikasi TLS
userAgentOptions	Opsi untuk menambahkan detail agen pengguna ke permintaan keluar.

Detail Properti

apiVersion

Peringatan

API ini sudah tidak digunakan lagi.

use serviceVersion instead

Versi API yang digunakan saat berkomunikasi dengan layanan.

apiVersion?: string

Nilai Properti

string

audience

Audiens yang digunakan untuk autentikasi dengan Azure Active Directory (AAD). Audiens tidak dipertimbangkan saat menggunakan kunci bersama. KnownSearchAudience dapat digunakan secara bergantian dengan audiens

audience?: string

Nilai Properti

string

serviceVersion

Versi layanan yang digunakan saat berkomunikasi dengan layanan.

serviceVersion?: string

Nilai Properti

string

Detail Properti yang Diwariskan

additionalPolicies

Kebijakan tambahan untuk disertakan dalam alur HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Nilai Properti

AdditionalPolicyConfig[]

Diwariskan Dari ExtendedCommonClientOptions.additionalPolicies

agent

Opsi untuk mengonfigurasi instans Agen untuk permintaan keluar

agent?: Agent

Nilai Properti

Agent

Diwariskan Dari ExtendedCommonClientOptions.agent

allowInsecureConnection

Atur ke true jika permintaan dikirim melalui HTTP alih-alih HTTPS

allowInsecureConnection?: boolean

Nilai Properti

boolean

Diwarisi Dari ExtendedCommonClientOptions.allowInsecureConnection

httpClient

HttpClient yang akan digunakan untuk mengirim permintaan HTTP.

httpClient?: HttpClient

Nilai Properti

HttpClient

Diwariskan Dari ExtendedCommonClientOptions.httpClient

keepAliveOptions

Opsi untuk menonaktifkan tetap hidup.

keepAliveOptions?: KeepAliveOptions

Nilai Properti

KeepAliveOptions

Diwarisi Dari ExtendedCommonClientOptions.keepAliveOptions

proxyOptions

Opsi untuk mengonfigurasi proksi untuk permintaan keluar.

proxyOptions?: ProxySettings

Nilai Properti

ProxySettings

Diwariskan Dari ExtendedCommonClientOptions.proxyOptions

redirectOptions

Opsi untuk bagaimana respons pengalihan ditangani.

redirectOptions?: RedirectPolicyOptions & RedirectOptions

Nilai Properti

RedirectPolicyOptions & RedirectOptions

Diwariskan Dari ExtendedCommonClientOptions.redirectOptions

retryOptions

Opsi yang mengontrol cara mencoba kembali permintaan yang gagal.

retryOptions?: PipelineRetryOptions

Nilai Properti

PipelineRetryOptions

Diwariskan Dari ExtendedCommonClientOptions.retryOptions

telemetryOptions

Opsi untuk mengatur telemetri umum dan melacak info ke permintaan keluar.

telemetryOptions?: TelemetryOptions

Nilai Properti

TelemetryOptions

Diwariskan Dari ExtendedCommonClientOptions.telemetryOptions

tlsOptions

Opsi untuk mengonfigurasi autentikasi TLS

tlsOptions?: TlsSettings

Nilai Properti

TlsSettings

Diwariskan Dari ExtendedCommonClientOptions.tlsOptions

userAgentOptions

Opsi untuk menambahkan detail agen pengguna ke permintaan keluar.

userAgentOptions?: UserAgentPolicyOptions

Nilai Properti

UserAgentPolicyOptions

Diwarisi Dari ExtendedCommonClientOptions.userAgentOptions