WebSearchClientOptions interface

Paket:

@azure/cognitiveservices-websearch

Eine Schnittstelle, die WebSearchClientOptions darstellt.

Extends

ServiceClientOptions

Eigenschaften

endpoint

Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. "https://westus.api.cognitive.microsoft.com", "https://api.cognitive.microsoft.com"). Standardwert: 'https://api.cognitive.microsoft.com'.

Geerbte Eigenschaften

agentSettings	HTTP- und HTTPS-Agents, die für jede HTTP-Anforderung (nur Node.js) verwendet werden.
baseUri	Falls angegeben: Dies baseUri wird der Basis-URI, für den Anforderungen für diesen ServiceClient gestellt werden. Wenn der baseUri einem bekannten Ressourcen-Manager-Endpunkt entspricht und ein TokenCredential über den Konstruktor übergeben wurde, baseUri definiert dies den getToken Bereich als ${options.baseUri}/.default. Andernfalls wird der Bereich standardmäßig auf ";"https://management.azure.com/.default" festgelegt. Wenn sie nicht angegeben ist: Alle OperationSpecs müssen eine baseUrl-Eigenschaft enthalten. Wenn ein TokenCredential über den Konstruktor übergeben wurde, wird der getToken Bereich auf "https://management.azure.com/.default"" festgelegt.
clientRequestIdHeaderName	Wenn angegeben, wird der HTTP-Pipeline eine GenerateRequestIdPolicy hinzugefügt, die allen ausgehenden Anforderungen einen Header mit diesem Headernamen und einer zufälligen UUID als Anforderungs-ID hinzufügt.
deserializationContentTypes	Die Inhaltstypen, die der JSON- oder XML-Serialisierung zugeordnet werden.
generateClientRequestIdHeader	Gibt an, ob ein Clientanforderungs-ID-Header für jede HTTP-Anforderung generiert werden soll.
httpClient	Der HttpClient, der zum Senden von HTTP-Anforderungen verwendet wird.
httpPipelineLogger	Der HttpPipelineLogger, der zum Debuggen von RequestPolicies innerhalb der HTTP-Pipeline verwendet werden kann.
noRetryPolicy	Wenn auf "true" festgelegt ist, deaktivieren Sie die Standard-Wiederholungsrichtlinie.
proxySettings	Proxyeinstellungen, die für jede HTTP-Anforderung verwendet werden (nur Node.js).
redirectOptions	Optionen für die Behandlung von Umleitungsantworten.
requestPolicyFactories	Ein Array von Fabriken, die aufgerufen werden, um die RequestPolicy-Pipeline zu erstellen, die zum Senden einer HTTP-Anforderung über die Verbindung verwendet wird, oder eine Funktion, die die defaultRequestPolicyFactories übernimmt und die verwendete requestPolicyFactories zurückgibt.
rpRegistrationRetryTimeout	Ruft das Wiederholungstimeout in Sekunden für AutomaticRPRegistration ab oder legt es fest. Standardwert: 30.
userAgent	Die Zeichenfolge, die beim Senden der Anforderung auf den Telemetrieheader festgelegt werden soll, oder eine Funktion, die die Standardzeichenfolge des Benutzer-Agents übernimmt und die verwendete Benutzer-Agent-Zeichenfolge zurückgibt.
userAgentHeaderName	Der Headername, der beim Senden der Anforderung für den Telemetrieheader verwendet werden soll. Wenn dies nicht angegeben ist, wird "User-Agent" verwendet, wenn auf Node.js ausgeführt wird, und "x-ms-command-name" wird bei der Ausführung in einem Browser verwendet.
withCredentials	Gibt an, ob Anmeldeinformationen in CORS-Anforderungen im Browser eingeschlossen werden sollen. Weitere Informationen finden Sie unter https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials.

Details zur Eigenschaft

endpoint

Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. "https://westus.api.cognitive.microsoft.com", "https://api.cognitive.microsoft.com"). Standardwert: 'https://api.cognitive.microsoft.com'.

endpoint?: string

Eigenschaftswert

string

Geerbte Eigenschaftsdetails

agentSettings

HTTP- und HTTPS-Agents, die für jede HTTP-Anforderung (nur Node.js) verwendet werden.

agentSettings?: AgentSettings

Eigenschaftswert

AgentSettings

Geerbt von ServiceClientOptions.agentSettings

baseUri

Falls angegeben:

• Dies baseUri wird der Basis-URI, für den Anforderungen für diesen ServiceClient gestellt werden.
• Wenn der baseUri einem bekannten Ressourcen-Manager-Endpunkt entspricht und ein TokenCredential über den Konstruktor übergeben wurde, baseUri definiert dies den getToken Bereich als ${options.baseUri}/.default. Andernfalls wird der Bereich standardmäßig auf ";"https://management.azure.com/.default" festgelegt.

Wenn sie nicht angegeben ist:

• Alle OperationSpecs müssen eine baseUrl-Eigenschaft enthalten.
• Wenn ein TokenCredential über den Konstruktor übergeben wurde, wird der getToken Bereich auf "https://management.azure.com/.default"" festgelegt.

baseUri?: string

Eigenschaftswert

string

Geerbt von ServiceClientOptions.baseUri

clientRequestIdHeaderName

Wenn angegeben, wird der HTTP-Pipeline eine GenerateRequestIdPolicy hinzugefügt, die allen ausgehenden Anforderungen einen Header mit diesem Headernamen und einer zufälligen UUID als Anforderungs-ID hinzufügt.

clientRequestIdHeaderName?: string

Eigenschaftswert

string

Geerbt von ServiceClientOptions.clientRequestIdHeaderName

deserializationContentTypes

Die Inhaltstypen, die der JSON- oder XML-Serialisierung zugeordnet werden.

deserializationContentTypes?: DeserializationContentTypes

Eigenschaftswert

DeserializationContentTypes

Geerbt von ServiceClientOptions.deserializationContentTypes

generateClientRequestIdHeader

Gibt an, ob ein Clientanforderungs-ID-Header für jede HTTP-Anforderung generiert werden soll.

generateClientRequestIdHeader?: boolean

Eigenschaftswert

boolean

Geerbt von ServiceClientOptions.generateClientRequestIdHeader

httpClient

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

httpClient?: HttpClient

Eigenschaftswert

HttpClient

Geerbt von ServiceClientOptions.httpClient

httpPipelineLogger

Der HttpPipelineLogger, der zum Debuggen von RequestPolicies innerhalb der HTTP-Pipeline verwendet werden kann.

httpPipelineLogger?: HttpPipelineLogger

Eigenschaftswert

HttpPipelineLogger

Geerbt von ServiceClientOptions.httpPipelineLogger

noRetryPolicy

Wenn auf "true" festgelegt ist, deaktivieren Sie die Standard-Wiederholungsrichtlinie.

noRetryPolicy?: boolean

Eigenschaftswert

boolean

Geerbt von ServiceClientOptions.noRetryPolicy

proxySettings

Proxyeinstellungen, die für jede HTTP-Anforderung verwendet werden (nur Node.js).

proxySettings?: ProxySettings

Eigenschaftswert

ProxySettings

Geerbt von ServiceClientOptions.proxySettings

redirectOptions

Optionen für die Behandlung von Umleitungsantworten.

redirectOptions?: RedirectOptions

Eigenschaftswert

RedirectOptions

Geerbt von ServiceClientOptions.redirectOptions

requestPolicyFactories

Ein Array von Fabriken, die aufgerufen werden, um die RequestPolicy-Pipeline zu erstellen, die zum Senden einer HTTP-Anforderung über die Verbindung verwendet wird, oder eine Funktion, die die defaultRequestPolicyFactories übernimmt und die verwendete requestPolicyFactories zurückgibt.

requestPolicyFactories?: RequestPolicyFactory[] | (defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | RequestPolicyFactory[]

Eigenschaftswert

RequestPolicyFactory[] | (defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | RequestPolicyFactory[]

Geerbt von ServiceClientOptions.requestPolicyFactories

rpRegistrationRetryTimeout

Ruft das Wiederholungstimeout in Sekunden für AutomaticRPRegistration ab oder legt es fest. Standardwert: 30.

rpRegistrationRetryTimeout?: number

Eigenschaftswert

number

Geerbt von ServiceClientOptions.rpRegistrationRetryTimeout

userAgent

Die Zeichenfolge, die beim Senden der Anforderung auf den Telemetrieheader festgelegt werden soll, oder eine Funktion, die die Standardzeichenfolge des Benutzer-Agents übernimmt und die verwendete Benutzer-Agent-Zeichenfolge zurückgibt.

userAgent?: string | (defaultUserAgent: string) => string

Eigenschaftswert

string | (defaultUserAgent: string) => string

Geerbt von ServiceClientOptions.userAgent

userAgentHeaderName

Der Headername, der beim Senden der Anforderung für den Telemetrieheader verwendet werden soll. Wenn dies nicht angegeben ist, wird "User-Agent" verwendet, wenn auf Node.js ausgeführt wird, und "x-ms-command-name" wird bei der Ausführung in einem Browser verwendet.

userAgentHeaderName?: string | (defaultUserAgentHeaderName: string) => string

Eigenschaftswert

string | (defaultUserAgentHeaderName: string) => string

Geerbt von ServiceClientOptions.userAgentHeaderName

withCredentials

Gibt an, ob Anmeldeinformationen in CORS-Anforderungen im Browser eingeschlossen werden sollen. Weitere Informationen finden Sie unter https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials.

withCredentials?: boolean

Eigenschaftswert

boolean

Geerbt von ServiceClientOptions.withCredentials