SearchClientOptions interface

Paket:

@azure/search-documents

Clientoptionen, die zum Konfigurieren von API-Anforderungen der kognitiven 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 gemeinsam verwendeten Schlüssels nicht berücksichtigt. KnownSearchAudience kann austauschbar mit der Zielgruppe 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 aufgenommen werden sollen.
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, mit denen gesteuert wird, wie fehlerhafte Anforderungen wiederholt werden.
telemetryOptions	Optionen zum Festlegen allgemeiner Telemetriedaten und Ablaufverfolgungsinformationen auf 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 gemeinsam verwendeten Schlüssels nicht berücksichtigt. KnownSearchAudience kann austauschbar mit der Zielgruppe 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 aufgenommen werden sollen.

additionalPolicies?: AdditionalPolicyConfig[]

Eigenschaftswert

AdditionalPolicyConfig[]

Geerbt von ExtendedCommonClientOptions.additionalPolicies

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

Geerbt von ExtendedCommonClientOptions.httpClient

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, mit denen gesteuert wird, wie fehlerhafte Anforderungen wiederholt werden.

retryOptions?: PipelineRetryOptions

Eigenschaftswert

PipelineRetryOptions

Geerbt von ExtendedCommonClientOptions.retryOptions

telemetryOptions

Optionen zum Festlegen allgemeiner Telemetriedaten und Ablaufverfolgungsinformationen auf ausgehende Anforderungen.

telemetryOptions?: TelemetryOptions

Eigenschaftswert

TelemetryOptions

Geerbt von ExtendedCommonClientOptions.telemetryOptions

tlsOptions

Optionen zum Konfigurieren der TLS-Authentifizierung

tlsOptions?: TlsSettings

Eigenschaftswert

TlsSettings

Geerbt von ExtendedCommonClientOptions.tlsOptions

userAgentOptions

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

userAgentOptions?: UserAgentPolicyOptions

Eigenschaftswert

UserAgentPolicyOptions

Geerbt von ExtendedCommonClientOptions.userAgentOptions