KnowledgeRetrievalClientOptions interface

Paket:

@azure/search-documents

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

Extends

ClientOptions

Eigenschaften

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	Option zum Zulassen des Aufrufens von HTTP-Endpunkten (unsicher)
apiVersion	Optionen zum Festlegen einer benutzerdefinierten apiVersion.
baseUrl	Basis-URL für den Client
credentials	Anmeldeinformationen
endpoint	Endpunkt für den Client
httpClient	Geben Sie beim Senden von Anforderungen einen benutzerdefinierten HttpClient an.
loggingOptions	Optionen zum Konfigurieren der Anforderungs-/Antwortprotokollierung.
pipeline	Pipeline, die für den Client verwendet werden soll. Wenn nicht bereitgestellt, wird eine Standardpipeline mit den bereitgestellten Optionen erstellt. Verwenden Sie mit Vorsicht – bei der Einstellung dieser Option werden alle Client-Optionen, die bei der Erstellung der Standardpipeline verwendet werden, ignoriert.
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

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 ClientOptions.additionalPolicies

agent

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

agent?: Agent

Eigenschaftswert

Agent

geerbt von ClientOptions.agent

allowInsecureConnection

Option zum Zulassen des Aufrufens von HTTP-Endpunkten (unsicher)

allowInsecureConnection?: boolean

Eigenschaftswert

boolean

Geerbt von ClientOptions.allowInsecureConnection

apiVersion

Optionen zum Festlegen einer benutzerdefinierten apiVersion.

apiVersion?: string

Eigenschaftswert

string

geerbt von ClientOptions.apiVersion

baseUrl

Warnung

Diese API ist nun veraltet.

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

Basis-URL für den Client

baseUrl?: string

Eigenschaftswert

string

geerbt von ClientOptions.baseUrl

credentials

Anmeldeinformationen

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

Eigenschaftswert

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

Von ClientOptions.credentials geerbt

endpoint

Endpunkt für den Client

endpoint?: string

Eigenschaftswert

string

von ClientOptions.endpoint geerbt

httpClient

Geben Sie beim Senden von Anforderungen einen benutzerdefinierten HttpClient an.

httpClient?: HttpClient

Eigenschaftswert

HttpClient

von ClientOptions.httpClient geerbt

loggingOptions

Optionen zum Konfigurieren der Anforderungs-/Antwortprotokollierung.

loggingOptions?: LogPolicyOptions

Eigenschaftswert

LogPolicyOptions

Geerbt von ClientOptions.loggingOptions

pipeline

Pipeline, die für den Client verwendet werden soll. Wenn nicht bereitgestellt, wird eine Standardpipeline mit den bereitgestellten Optionen erstellt. Verwenden Sie mit Vorsicht – bei der Einstellung dieser Option werden alle Client-Optionen, die bei der Erstellung der Standardpipeline verwendet werden, ignoriert.

pipeline?: Pipeline

Eigenschaftswert

Pipeline

Geerbt von ClientOptions.pipeline

proxyOptions

Optionen zum Konfigurieren eines Proxys für ausgehende Anforderungen.

proxyOptions?: ProxySettings

Eigenschaftswert

ProxySettings

von ClientOptions.proxyOptions geerbt

redirectOptions

Optionen für die Behandlung von Umleitungsantworten.

redirectOptions?: RedirectPolicyOptions

Eigenschaftswert

RedirectPolicyOptions

geerbt von ClientOptions.redirectOptions

retryOptions

Optionen, die steuern, wie fehlgeschlagene Anforderungen wiederholt werden.

retryOptions?: PipelineRetryOptions

Eigenschaftswert

PipelineRetryOptions

geerbt von ClientOptions.retryOptions

telemetryOptions

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

telemetryOptions?: TelemetryOptions

Eigenschaftswert

TelemetryOptions

Geerbt von ClientOptions.telemetryOptions

tlsOptions

Optionen zum Konfigurieren der TLS-Authentifizierung

tlsOptions?: TlsSettings

Eigenschaftswert

TlsSettings

geerbt von ClientOptions.tlsOptions

userAgentOptions

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

userAgentOptions?: UserAgentPolicyOptions

Eigenschaftswert

UserAgentPolicyOptions

von ClientOptions.userAgentOptions geerbt