SearchClientOptions interface

Paquet:

@azure/search-documents

Options clientes utilisées pour configurer les demandes d’API Recherche cognitive.

Extends

ExtendedCommonClientOptions

Propriétés

apiVersion	Version de l’API à utiliser lors de la communication avec le service.
audience	Audience à utiliser pour l’authentification avec Azure Active Directory (AAD). L’audience n’est pas prise en compte lors de l’utilisation d’une clé partagée. KnownSearchAudience peut être utilisé de manière interchangeable avec le public
serviceVersion	Version du service à utiliser lors de la communication avec le service.

Propriétés héritées

additionalPolicies	Stratégies supplémentaires à inclure dans le pipeline HTTP.
allowInsecureConnection	Défini sur true si la requête est envoyée via HTTP au lieu de HTTPS
httpClient	HttpClient qui sera utilisé pour envoyer des requêtes HTTP.
keepAliveOptions	Options pour désactiver le maintien en vie.
proxyOptions	Options permettant de configurer un proxy pour les requêtes sortantes.
redirectOptions	Options pour la façon dont les réponses de redirection sont gérées.
retryOptions	Options qui contrôlent comment réessayer les demandes ayant échoué.
telemetryOptions	Options permettant de définir les données de télémétrie et de suivi courantes sur les requêtes sortantes.
tlsOptions	Options de configuration de l’authentification TLS
userAgentOptions	Options permettant d’ajouter les détails de l’agent utilisateur aux requêtes sortantes.

Détails de la propriété

apiVersion

Avertissement

Cette API est à présent déconseillée.

use serviceVersion instead

Version de l’API à utiliser lors de la communication avec le service.

apiVersion?: string

Valeur de propriété

string

audience

Audience à utiliser pour l’authentification avec Azure Active Directory (AAD). L’audience n’est pas prise en compte lors de l’utilisation d’une clé partagée. KnownSearchAudience peut être utilisé de manière interchangeable avec le public

audience?: string

Valeur de propriété

string

serviceVersion

Version du service à utiliser lors de la communication avec le service.

serviceVersion?: string

Valeur de propriété

string

Détails de la propriété héritée

additionalPolicies

Stratégies supplémentaires à inclure dans le pipeline HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Valeur de propriété

AdditionalPolicyConfig[]

Hérité de ExtendedCommonClientOptions.additionalPolicies

allowInsecureConnection

Défini sur true si la requête est envoyée via HTTP au lieu de HTTPS

allowInsecureConnection?: boolean

Valeur de propriété

boolean

Hérité de ExtendedCommonClientOptions.allowInsecureConnection

httpClient

HttpClient qui sera utilisé pour envoyer des requêtes HTTP.

httpClient?: HttpClient

Valeur de propriété

HttpClient

Hérité de ExtendedCommonClientOptions.httpClient

keepAliveOptions

Options pour désactiver le maintien en vie.

keepAliveOptions?: KeepAliveOptions

Valeur de propriété

KeepAliveOptions

Hérité de ExtendedCommonClientOptions.keepAliveOptions

proxyOptions

Options permettant de configurer un proxy pour les requêtes sortantes.

proxyOptions?: ProxySettings

Valeur de propriété

ProxySettings

Hérité de ExtendedCommonClientOptions.proxyOptions

redirectOptions

Options pour la façon dont les réponses de redirection sont gérées.

redirectOptions?: RedirectPolicyOptions & RedirectOptions

Valeur de propriété

RedirectPolicyOptions & RedirectOptions

Hérité de ExtendedCommonClientOptions.redirectOptions

retryOptions

Options qui contrôlent comment réessayer les demandes ayant échoué.

retryOptions?: PipelineRetryOptions

Valeur de propriété

PipelineRetryOptions

Hérité de ExtendedCommonClientOptions.retryOptions

telemetryOptions

Options permettant de définir les données de télémétrie et de suivi courantes sur les requêtes sortantes.

telemetryOptions?: TelemetryOptions

Valeur de propriété

TelemetryOptions

Hérité de ExtendedCommonClientOptions.telemetryOptions

tlsOptions

Options de configuration de l’authentification TLS

tlsOptions?: TlsSettings

Valeur de propriété

TlsSettings

Hérité de ExtendedCommonClientOptions.tlsOptions

userAgentOptions

Options permettant d’ajouter les détails de l’agent utilisateur aux requêtes sortantes.

userAgentOptions?: UserAgentPolicyOptions

Valeur de propriété

UserAgentPolicyOptions

Hérité de ExtendedCommonClientOptions.userAgentOptions