Sdílet prostřednictvím

WebSearchClientOptions interface

  • Reference
Balíček:
@azure/cognitiveservices-websearch

Rozhraní představující WebSearchClientOptions.

Extends
ServiceClientOptions

Vlastnosti

endpoint

Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například"https://westus.api.cognitive.microsoft.com", "https://api.cognitive.microsoft.com"). Výchozí hodnota: .https://api.cognitive.microsoft.com

Zděděné vlastnosti

agentSettings

Agenti HTTP a HTTPS, kteří se budou používat pro každý požadavek HTTP (pouze Node.js).
baseUri

Pokud je zadáno:

  • To baseUri se stane základním identifikátorem URI, proti kterému se budou provádět požadavky pro tohoto klienta služby ServiceClient.
  • Pokud odpovídá baseUri známému koncovému bodu Resource Manageru a TokenCredential konstruktorem byl předán, definuje getToken se baseUri obor na ${options.baseUri}/.default. V opačném případě by obor ve výchozím nastavení byl "https://management.azure.com/.default".

Pokud není zadaný:

  • Všechny objekty OperationSpecs musí obsahovat vlastnost baseUrl.
  • TokenCredential Pokud byl předán konstruktorem, getToken je obor nastaven na "https://management.azure.com/.default".
clientRequestIdHeaderName

Pokud je tato možnost zadána, přidá se do kanálu HTTP generateRequestIdPolicy, která přidá hlavičku do všech odchozích požadavků s tímto názvem hlavičky a náhodným UUID jako ID požadavku.
deserializationContentTypes

Typy obsahu, které budou přidruženy k serializaci JSON nebo XML.
generateClientRequestIdHeader

Jestli se má vygenerovat hlavička ID požadavku klienta pro každý požadavek HTTP.
httpClient

HttpClient, který se použije k odesílání požadavků HTTP.
httpPipelineLogger

HttpPipelineLogger, který lze použít k ladění RequestPolicies v rámci kanálu HTTP.
noRetryPolicy

Pokud je nastavená hodnota true, vypněte výchozí zásadu opakování.
proxySettings

Nastavení proxy serveru, které se použije pro každý požadavek HTTP (pouze Node.js).
redirectOptions

Možnosti zpracování odpovědí přesměrování
requestPolicyFactories

Pole továren, které jsou volány k vytvoření kanálu RequestPolicy sloužícího k odeslání požadavku HTTP na drátu, nebo funkce, která přebírá defaultRequestPolicyFactories a vrací requestPolicyFactories, která se použije.
rpRegistrationRetryTimeout

Získá nebo nastaví časový limit opakování v sekundách pro AutomaticRPRegistration. Výchozí hodnota je 30.
userAgent

Řetězec, který se má nastavit na hlavičku telemetrie při odesílání požadavku, nebo funkce, která převezme výchozí řetězec uživatelského agenta a vrátí řetězec uživatelského agenta, který se použije.
userAgentHeaderName

Název hlavičky, který se má použít pro hlavičku telemetrie při odesílání požadavku. Pokud tato možnost není zadána, použije se při spuštění na Node.js "User-Agent" a při spuštění v prohlížeči se použije "x-ms-command-name".
withCredentials

Jestli se mají přihlašovací údaje zahrnout do požadavků CORS v prohlížeči. Další informace naleznete v tématu https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials.

Podrobnosti vlastnosti

endpoint

Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například"https://westus.api.cognitive.microsoft.com", "https://api.cognitive.microsoft.com"). Výchozí hodnota: .https://api.cognitive.microsoft.com

endpoint?: string

Hodnota vlastnosti

string

Podrobnosti zděděných vlastností

agentSettings

Agenti HTTP a HTTPS, kteří se budou používat pro každý požadavek HTTP (pouze Node.js).

agentSettings?: AgentSettings

Hodnota vlastnosti

AgentSettings

Zděděno z ServiceClientOptions.agentSettings

baseUri

Pokud je zadáno:

  • To baseUri se stane základním identifikátorem URI, proti kterému se budou provádět požadavky pro tohoto klienta služby ServiceClient.
  • Pokud odpovídá baseUri známému koncovému bodu Resource Manageru a TokenCredential konstruktorem byl předán, definuje getToken se baseUri obor na ${options.baseUri}/.default. V opačném případě by obor ve výchozím nastavení byl "https://management.azure.com/.default".

Pokud není zadaný:

  • Všechny objekty OperationSpecs musí obsahovat vlastnost baseUrl.
  • TokenCredential Pokud byl předán konstruktorem, getToken je obor nastaven na "https://management.azure.com/.default".
baseUri?: string

Hodnota vlastnosti

string

Zděděno z ServiceClientOptions.baseUri

clientRequestIdHeaderName

Pokud je tato možnost zadána, přidá se do kanálu HTTP generateRequestIdPolicy, která přidá hlavičku do všech odchozích požadavků s tímto názvem hlavičky a náhodným UUID jako ID požadavku.

clientRequestIdHeaderName?: string

Hodnota vlastnosti

string

Zděděno z ServiceClientOptions.clientRequestIdHeaderName

deserializationContentTypes

Typy obsahu, které budou přidruženy k serializaci JSON nebo XML.

deserializationContentTypes?: DeserializationContentTypes

Hodnota vlastnosti

DeserializationContentTypes

Zděděno z ServiceClientOptions.deserializationContentTypes

generateClientRequestIdHeader

Jestli se má vygenerovat hlavička ID požadavku klienta pro každý požadavek HTTP.

generateClientRequestIdHeader?: boolean

Hodnota vlastnosti

boolean

Zděděno z ServiceClientOptions.generateClientRequestIdHeader

httpClient

HttpClient, který se použije k odesílání požadavků HTTP.

httpClient?: HttpClient

Hodnota vlastnosti

HttpClient

Zděděno z ServiceClientOptions.httpClient

httpPipelineLogger

HttpPipelineLogger, který lze použít k ladění RequestPolicies v rámci kanálu HTTP.

httpPipelineLogger?: HttpPipelineLogger

Hodnota vlastnosti

HttpPipelineLogger

Zděděno z ServiceClientOptions.httpPipelineLogger

noRetryPolicy

Pokud je nastavená hodnota true, vypněte výchozí zásadu opakování.

noRetryPolicy?: boolean

Hodnota vlastnosti

boolean

Zděděno z ServiceClientOptions.noRetryPolicy

proxySettings

Nastavení proxy serveru, které se použije pro každý požadavek HTTP (pouze Node.js).

proxySettings?: ProxySettings

Hodnota vlastnosti

ProxySettings

Zděděno z ServiceClientOptions.proxySettings

redirectOptions

Možnosti zpracování odpovědí přesměrování

redirectOptions?: RedirectOptions

Hodnota vlastnosti

RedirectOptions

Zděděno z ServiceClientOptions.redirectOptions

requestPolicyFactories

Pole továren, které jsou volány k vytvoření kanálu RequestPolicy sloužícího k odeslání požadavku HTTP na drátu, nebo funkce, která přebírá defaultRequestPolicyFactories a vrací requestPolicyFactories, která se použije.

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

Hodnota vlastnosti

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

Zděděno z ServiceClientOptions.requestPolicyFactories

rpRegistrationRetryTimeout

Získá nebo nastaví časový limit opakování v sekundách pro AutomaticRPRegistration. Výchozí hodnota je 30.

rpRegistrationRetryTimeout?: number

Hodnota vlastnosti

number

Zděděno z ServiceClientOptions.rpRegistrationRetryTimeout

userAgent

Řetězec, který se má nastavit na hlavičku telemetrie při odesílání požadavku, nebo funkce, která převezme výchozí řetězec uživatelského agenta a vrátí řetězec uživatelského agenta, který se použije.

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

Hodnota vlastnosti

string | (defaultUserAgent: string) => string

Zděděno z ServiceClientOptions.userAgent

userAgentHeaderName

Název hlavičky, který se má použít pro hlavičku telemetrie při odesílání požadavku. Pokud tato možnost není zadána, použije se při spuštění na Node.js "User-Agent" a při spuštění v prohlížeči se použije "x-ms-command-name".

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

Hodnota vlastnosti

string | (defaultUserAgentHeaderName: string) => string

Zděděno z ServiceClientOptions.userAgentHeaderName

withCredentials

Jestli se mají přihlašovací údaje zahrnout do požadavků CORS v prohlížeči. Další informace naleznete v tématu https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials.

withCredentials?: boolean

Hodnota vlastnosti

boolean

Zděděno z ServiceClientOptions.withCredentials