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 použijí pro každý požadavek HTTP (pouzeNode.js).
baseUri

Pokud je zadáno:

  • Tento baseUri se stane základním identifikátorem URI, proti kterému budou požadavky provedeny pro tohoto klienta služby.
  • Pokud baseUri odpovídá známému koncovému bodu Resource Manageru a pokud byl konstruktor předán TokenCredential, definuje tento baseUri rozsah getToken, který se má ${options.baseUri}/.default. Jinak by obor ve výchozím nastaveníhttps://management.azure.com/.default".

Pokud není zadán:

  • All OperationSpecs musí obsahovat vlastnost baseUrl.
  • Pokud byl konstruktor předán TokenCredential, je rozsah getToken nastaven na "https://management.azure.com/.default".
clientRequestIdHeaderName

Pokud je zadána hodnota GenerateRequestIdPolicy, přidá se do kanálu HTTP, 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 chcete vygenerovat hlavičku ID požadavku klienta pro každý požadavek HTTP, nebo ne.
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ásady opakování.
proxySettings

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

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

Pole továren, které se volala k vytvoření kanálu RequestPolicy sloužícího k odeslání požadavku HTTP na drátu, nebo funkce, která přebírá výchozíRequestPolicyFactories a vrací požadavek 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řebírá výchozí řetězec uživatelského agenta a vrací ř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 tento parametr nezadáte, použijí 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

Zda zahrnout přihlašovací údaje do požadavků CORS v prohlížeči. Další informace najdete 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 použijí pro každý požadavek HTTP (pouzeNode.js).

agentSettings?: AgentSettings

Hodnota vlastnosti

AgentSettings

zděděno ze služby ServiceClientOptions.agentSettings

baseUri

Pokud je zadáno:

  • Tento baseUri se stane základním identifikátorem URI, proti kterému budou požadavky provedeny pro tohoto klienta služby.
  • Pokud baseUri odpovídá známému koncovému bodu Resource Manageru a pokud byl konstruktor předán TokenCredential, definuje tento baseUri rozsah getToken, který se má ${options.baseUri}/.default. Jinak by obor ve výchozím nastaveníhttps://management.azure.com/.default".

Pokud není zadán:

  • All OperationSpecs musí obsahovat vlastnost baseUrl.
  • Pokud byl konstruktor předán TokenCredential, je rozsah getToken nastaven na "https://management.azure.com/.default".
baseUri?: string

Hodnota vlastnosti

string

zděděno z ServiceClientOptions.baseUri

clientRequestIdHeaderName

Pokud je zadána hodnota GenerateRequestIdPolicy, přidá se do kanálu HTTP, 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 ze služby 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 chcete vygenerovat hlavičku ID požadavku klienta pro každý požadavek HTTP, nebo ne.

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ěný z ServiceClientOptions.httpPipelineLogger

noRetryPolicy

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

noRetryPolicy?: boolean

Hodnota vlastnosti

boolean

zděděné z ServiceClientOptions.noRetryPolicy

proxySettings

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

proxySettings?: ProxySettings

Hodnota vlastnosti

ProxySettings

zděděné z ServiceClientOptions.proxySettings

redirectOptions

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

redirectOptions?: RedirectOptions

Hodnota vlastnosti

RedirectOptions

zděděné z ServiceClientOptions.redirectOptions

requestPolicyFactories

Pole továren, které se volala k vytvoření kanálu RequestPolicy sloužícího k odeslání požadavku HTTP na drátu, nebo funkce, která přebírá výchozíRequestPolicyFactories a vrací požadavek requestPolicyFactories, který se použije.

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

Hodnota vlastnosti

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

zděděno ze služby 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řebírá výchozí řetězec uživatelského agenta a vrací ř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 tento parametr nezadáte, použijí 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 ze služby ServiceClientOptions.userAgentHeaderName

withCredentials

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

withCredentials?: boolean

Hodnota vlastnosti

boolean

zděděné z ServiceClientOptions.withCredentials