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.
agent	Options de configuration de l’instance de l’agent pour les demandes sortantes
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 permettant de désactiver la conservation en vie.
proxyOptions	Options de configuration d’un proxy pour les demandes sortantes.
redirectOptions	Options de gestion des réponses de redirection.
retryOptions	Options qui contrôlent la façon de réessayer les demandes ayant échoué.
telemetryOptions	Options permettant de définir les informations de télémétrie et de suivi courantes sur les requêtes sortantes.
tlsOptions	Options de configuration de l’authentification TLS
userAgentOptions	Options d’ajout de détails de l’agent utilisateur aux demandes 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ée de ExtendedCommonClientOptions.additionalPolicies

agent

Options de configuration de l’instance de l’agent pour les demandes sortantes

agent?: Agent

Valeur de propriété

Agent

héritée de ExtendedCommonClientOptions.agent

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ée de ExtendedCommonClientOptions.allowInsecureConnection

httpClient

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

httpClient?: HttpClient

Valeur de propriété

HttpClient

héritée de ExtendedCommonClientOptions.httpClient

keepAliveOptions

Options permettant de désactiver la conservation en vie.

keepAliveOptions?: KeepAliveOptions

Valeur de propriété

KeepAliveOptions

héritée de ExtendedCommonClientOptions.keepAliveOptions

proxyOptions

Options de configuration d’un proxy pour les demandes sortantes.

proxyOptions?: ProxySettings

Valeur de propriété

ProxySettings

héritée de ExtendedCommonClientOptions.proxyOptions

redirectOptions

Options de gestion des réponses de redirection.

redirectOptions?: RedirectPolicyOptions & RedirectOptions

Valeur de propriété

RedirectPolicyOptions & RedirectOptions

héritée de ExtendedCommonClientOptions.redirectOptions

retryOptions

Options qui contrôlent la façon de réessayer les demandes ayant échoué.

retryOptions?: PipelineRetryOptions

Valeur de propriété

PipelineRetryOptions

héritée de ExtendedCommonClientOptions.retryOptions

telemetryOptions

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

telemetryOptions?: TelemetryOptions

Valeur de propriété

TelemetryOptions

héritée de ExtendedCommonClientOptions.telemetryOptions

tlsOptions

Options de configuration de l’authentification TLS

tlsOptions?: TlsSettings

Valeur de propriété

TlsSettings

héritée de ExtendedCommonClientOptions.tlsOptions

userAgentOptions

Options d’ajout de détails de l’agent utilisateur aux demandes sortantes.

userAgentOptions?: UserAgentPolicyOptions

Valeur de propriété

UserAgentPolicyOptions

héritée de ExtendedCommonClientOptions.userAgentOptions