SearchIndexClientOptions interface

Paquet:
@azure/search-documents

Options client utilisées pour configurer les demandes d’API AI Search.

Extends
ClientOptions

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

Option permettant d’autoriser l’appel de points de terminaison http (non sécurisés)
baseUrl

URL de base pour le client
credentials

Informations d’identification
endpoint

Point de terminaison pour le client
httpClient

Spécifiez un HttpClient personnalisé lors de l’établissement de requêtes.
loggingOptions

Options de configuration de la journalisation des demandes/réponses.
pipeline

Pipeline à utiliser pour le client. Si cela n’est pas fourni, un pipeline par défaut sera créé en utilisant les options fournies. Utilisez avec prudence — lors de la définition de cette option, toutes les options client utilisées lors de la création du pipeline par défaut seront ignorées.
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 {@Link 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 ClientOptions.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 ClientOptions.agent

allowInsecureConnection

Option permettant d’autoriser l’appel de points de terminaison http (non sécurisés)

allowInsecureConnection?: boolean

Valeur de propriété

boolean

héritée de ClientOptions.allowInsecureConnection

baseUrl

Avertissement

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

This property is deprecated and will be removed soon, please use endpoint instead

URL de base pour le client

baseUrl?: string

Valeur de propriété

string

héritée de ClientOptions.baseUrl

credentials

Informations d’identification

credentials?: { apiKeyHeaderName?: string, scopes?: string[] }

Valeur de propriété

{ apiKeyHeaderName?: string, scopes?: string[] }

héritée de ClientOptions.credentials

endpoint

Point de terminaison pour le client

endpoint?: string

Valeur de propriété

string

héritée de ClientOptions.endpoint

httpClient

Spécifiez un HttpClient personnalisé lors de l’établissement de requêtes.

httpClient?: HttpClient

Valeur de propriété

HttpClient

héritée de ClientOptions.httpClient

loggingOptions

Options de configuration de la journalisation des demandes/réponses.

loggingOptions?: LogPolicyOptions

Valeur de propriété

LogPolicyOptions

héritée de ClientOptions.loggingOptions

pipeline

Pipeline à utiliser pour le client. Si cela n’est pas fourni, un pipeline par défaut sera créé en utilisant les options fournies. Utilisez avec prudence — lors de la définition de cette option, toutes les options client utilisées lors de la création du pipeline par défaut seront ignorées.

pipeline?: Pipeline

Valeur de propriété

Pipeline

Hérité de ClientOptions.pipeline

proxyOptions

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

proxyOptions?: ProxySettings

Valeur de propriété

ProxySettings

héritée de ClientOptions.proxyOptions

redirectOptions

Options de gestion des réponses de redirection.

redirectOptions?: RedirectPolicyOptions

Valeur de propriété

RedirectPolicyOptions

héritée de ClientOptions.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 ClientOptions.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 ClientOptions.telemetryOptions

tlsOptions

Options de configuration de l’authentification TLS

tlsOptions?: TlsSettings

Valeur de propriété

TlsSettings

héritée de ClientOptions.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 ClientOptions.userAgentOptions