SearchClientOptions interface

Paket:

@azure/search-documents

Clientoptionen, die zum Konfigurieren von API-Anforderungen für die kognitive Suche verwendet werden.

Extends

ExtendedCommonClientOptions

Eigenschaften

apiVersion	Die API-Version, die bei der Kommunikation mit dem Dienst verwendet werden soll.
audience	Die Zielgruppe, die für die Authentifizierung mit Azure Active Directory (AAD) verwendet werden soll. Die Zielgruppe wird bei Verwendung eines freigegebenen Schlüssels nicht berücksichtigt. KnownSearchAudience kann austauschbar mit Publikum verwendet werden
serviceVersion	Die Dienstversion, die bei der Kommunikation mit dem Dienst verwendet werden soll.

Geerbte Eigenschaften

additionalPolicies	Zusätzliche Richtlinien, die in die HTTP-Pipeline eingeschlossen werden sollen.
agent	Optionen zum Konfigurieren der Agent-Instanz für ausgehende Anforderungen
allowInsecureConnection	Auf "true" festgelegt, wenn die Anforderung über HTTP anstelle von HTTPS gesendet wird
httpClient	Der HttpClient, der zum Senden von HTTP-Anforderungen verwendet wird.
keepAliveOptions	Optionen zum Deaktivieren von Keep Alive.
proxyOptions	Optionen zum Konfigurieren eines Proxys für ausgehende Anforderungen.
redirectOptions	Optionen für die Behandlung von Umleitungsantworten.
retryOptions	Optionen, die steuern, wie fehlgeschlagene Anforderungen wiederholt werden.
telemetryOptions	Optionen zum Festlegen allgemeiner Telemetrie- und Ablaufverfolgungsinformationen für ausgehende Anforderungen.
tlsOptions	Optionen zum Konfigurieren der TLS-Authentifizierung
userAgentOptions	Optionen zum Hinzufügen von Benutzer-Agent-Details zu ausgehenden Anforderungen.

Details zur Eigenschaft

apiVersion

Warnung

Diese API ist nun veraltet.

use serviceVersion instead

Die API-Version, die bei der Kommunikation mit dem Dienst verwendet werden soll.

apiVersion?: string

Eigenschaftswert

string

audience

Die Zielgruppe, die für die Authentifizierung mit Azure Active Directory (AAD) verwendet werden soll. Die Zielgruppe wird bei Verwendung eines freigegebenen Schlüssels nicht berücksichtigt. KnownSearchAudience kann austauschbar mit Publikum verwendet werden

audience?: string

Eigenschaftswert

string

serviceVersion

Die Dienstversion, die bei der Kommunikation mit dem Dienst verwendet werden soll.

serviceVersion?: string

Eigenschaftswert

string

Geerbte Eigenschaftsdetails

additionalPolicies

Zusätzliche Richtlinien, die in die HTTP-Pipeline eingeschlossen werden sollen.

additionalPolicies?: AdditionalPolicyConfig[]

Eigenschaftswert

AdditionalPolicyConfig[]

Geerbt von ExtendedCommonClientOptions.additionalPolicies

agent

Optionen zum Konfigurieren der Agent-Instanz für ausgehende Anforderungen

agent?: Agent

Eigenschaftswert

Agent

geerbt von ExtendedCommonClientOptions.agent

allowInsecureConnection

Auf "true" festgelegt, wenn die Anforderung über HTTP anstelle von HTTPS gesendet wird

allowInsecureConnection?: boolean

Eigenschaftswert

boolean

geerbt von ExtendedCommonClientOptions.allowInsecureConnection

httpClient

Der HttpClient, der zum Senden von HTTP-Anforderungen verwendet wird.

httpClient?: HttpClient

Eigenschaftswert

HttpClient

von ExtendedCommonClientOptions.httpClient geerbt

keepAliveOptions

Optionen zum Deaktivieren von Keep Alive.

keepAliveOptions?: KeepAliveOptions

Eigenschaftswert

KeepAliveOptions

Geerbt von ExtendedCommonClientOptions.keepAliveOptions

proxyOptions

Optionen zum Konfigurieren eines Proxys für ausgehende Anforderungen.

proxyOptions?: ProxySettings

Eigenschaftswert

ProxySettings

geerbt von ExtendedCommonClientOptions.proxyOptions

redirectOptions

Optionen für die Behandlung von Umleitungsantworten.

redirectOptions?: RedirectPolicyOptions & RedirectOptions

Eigenschaftswert

RedirectPolicyOptions & RedirectOptions

Geerbt von ExtendedCommonClientOptions.redirectOptions

retryOptions

Optionen, die steuern, wie fehlgeschlagene Anforderungen wiederholt werden.

retryOptions?: PipelineRetryOptions

Eigenschaftswert

PipelineRetryOptions

von ExtendedCommonClientOptions.retryOptions geerbt

telemetryOptions

Optionen zum Festlegen allgemeiner Telemetrie- und Ablaufverfolgungsinformationen für ausgehende Anforderungen.

telemetryOptions?: TelemetryOptions

Eigenschaftswert

TelemetryOptions

Geerbt von ExtendedCommonClientOptions.telemetryOptions

tlsOptions

Optionen zum Konfigurieren der TLS-Authentifizierung

tlsOptions?: TlsSettings

Eigenschaftswert

TlsSettings

von ExtendedCommonClientOptions.tlsOptions geerbt

userAgentOptions

Optionen zum Hinzufügen von Benutzer-Agent-Details zu ausgehenden Anforderungen.

userAgentOptions?: UserAgentPolicyOptions

Eigenschaftswert

UserAgentPolicyOptions

geerbt von ExtendedCommonClientOptions.userAgentOptions