WebSearchClientOptions interface

Pakiet:

@azure/cognitiveservices-websearch

Interfejs reprezentujący element WebSearchClientOptions.

Extends

ServiceClientOptions

Właściwości

endpoint

Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: ";, "https://westus.api.cognitive.microsoft.com"https://api.cognitive.microsoft.com"). Wartość domyślna: "https://api.cognitive.microsoft.com".

Właściwości dziedziczone

agentSettings	Agenci HTTP i HTTPS, którzy będą używać dla każdego żądania HTTP (tylko Node.js).
baseUri	Jeśli określono: Staje się to baseUri podstawowym identyfikatorem URI, względem którego będą wykonywane żądania dla tego elementu ServiceClient. Jeśli element baseUri pasuje do znanego punktu końcowego usługi Resource Manager i jeśli TokenCredential został przekazany przez konstruktor, definiuje getToken to baseUri zakres, który ma być ${options.baseUri}/.default. W przeciwnym razie zakres domyślnie ma wartość "https://management.azure.com/.default"". Jeśli nie zostanie określony: Wszystkie operacjeSpecs muszą zawierać właściwość baseUrl. TokenCredential Jeśli konstruktor został przekazany przez konstruktor, getToken zakres ma wartość "https://management.azure.com/.default"".
clientRequestIdHeaderName	Jeśli zostanie określony, element GenerateRequestIdPolicy zostanie dodany do potoku HTTP, który doda nagłówek do wszystkich żądań wychodzących o tej nazwie nagłówka i losowy identyfikator UUID jako identyfikator żądania.
deserializationContentTypes	Typy zawartości, które będą skojarzone z serializacji JSON lub XML.
generateClientRequestIdHeader	Niezależnie od tego, czy należy wygenerować nagłówek identyfikatora żądania klienta dla każdego żądania HTTP.
httpClient	Obiekt HttpClient, który będzie używany do wysyłania żądań HTTP.
httpPipelineLogger	HttpPipelineLogger, który może służyć do debugowania żądańPolicies w potoku HTTP.
noRetryPolicy	Jeśli ustawiono wartość true, wyłącz domyślne zasady ponawiania prób.
proxySettings	Ustawienia serwera proxy, które będą używane dla każdego żądania HTTP (tylko Node.js).
redirectOptions	Opcje obsługi odpowiedzi przekierowania.
requestPolicyFactories	Tablica fabryk, które są wywoływane w celu utworzenia potoku RequestPolicy używanego do wysyłania żądania HTTP w sieci lub funkcji, która przyjmuje wartość domyślnąRequestPolicyFactories i zwraca wartość requestPolicyFactories, która zostanie użyta.
rpRegistrationRetryTimeout	Pobiera lub ustawia limit czasu ponawiania w sekundach dla funkcji AutomaticRPRegistration. Wartość domyślna to 30.
userAgent	Ciąg, który ma zostać ustawiony na nagłówek telemetrii podczas wysyłania żądania, lub funkcji, która przyjmuje domyślny ciąg user-agent i zwraca ciąg agenta użytkownika, który zostanie użyty.
userAgentHeaderName	Nazwa nagłówka do użycia dla nagłówka telemetrii podczas wysyłania żądania. Jeśli ta wartość nie zostanie określona, podczas uruchamiania polecenia "User-Agent" będzie używany podczas uruchamiania w Node.js i "x-ms-command-name" będzie używany podczas uruchamiania w przeglądarce.
withCredentials	Czy należy dołączać poświadczenia do żądań CORS w przeglądarce. Aby uzyskać więcej informacji, zobacz https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials.

Szczegóły właściwości

endpoint

Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: ";, "https://westus.api.cognitive.microsoft.com"https://api.cognitive.microsoft.com"). Wartość domyślna: "https://api.cognitive.microsoft.com".

endpoint?: string

Wartość właściwości

string

Szczegóły właściwości dziedziczonej

agentSettings

Agenci HTTP i HTTPS, którzy będą używać dla każdego żądania HTTP (tylko Node.js).

agentSettings?: AgentSettings

Wartość właściwości

AgentSettings

Dziedziczone z ServiceClientOptions.agentSettings

baseUri

Jeśli określono:

• Staje się to baseUri podstawowym identyfikatorem URI, względem którego będą wykonywane żądania dla tego elementu ServiceClient.
• Jeśli element baseUri pasuje do znanego punktu końcowego usługi Resource Manager i jeśli TokenCredential został przekazany przez konstruktor, definiuje getToken to baseUri zakres, który ma być ${options.baseUri}/.default. W przeciwnym razie zakres domyślnie ma wartość "https://management.azure.com/.default"".

Jeśli nie zostanie określony:

• Wszystkie operacjeSpecs muszą zawierać właściwość baseUrl.
• TokenCredential Jeśli konstruktor został przekazany przez konstruktor, getToken zakres ma wartość "https://management.azure.com/.default"".

baseUri?: string

Wartość właściwości

string

Dziedziczone z ServiceClientOptions.baseUri

clientRequestIdHeaderName

Jeśli zostanie określony, element GenerateRequestIdPolicy zostanie dodany do potoku HTTP, który doda nagłówek do wszystkich żądań wychodzących o tej nazwie nagłówka i losowy identyfikator UUID jako identyfikator żądania.

clientRequestIdHeaderName?: string

Wartość właściwości

string

Dziedziczone z ServiceClientOptions.clientRequestIdHeaderName

deserializationContentTypes

Typy zawartości, które będą skojarzone z serializacji JSON lub XML.

deserializationContentTypes?: DeserializationContentTypes

Wartość właściwości

DeserializationContentTypes

Dziedziczone z ServiceClientOptions.deserializationContentTypes

generateClientRequestIdHeader

Niezależnie od tego, czy należy wygenerować nagłówek identyfikatora żądania klienta dla każdego żądania HTTP.

generateClientRequestIdHeader?: boolean

Wartość właściwości

boolean

Dziedziczone z ServiceClientOptions.generateClientRequestIdHeader

httpClient

Obiekt HttpClient, który będzie używany do wysyłania żądań HTTP.

httpClient?: HttpClient

Wartość właściwości

HttpClient

Dziedziczone z ServiceClientOptions.httpClient

httpPipelineLogger

HttpPipelineLogger, który może służyć do debugowania żądańPolicies w potoku HTTP.

httpPipelineLogger?: HttpPipelineLogger

Wartość właściwości

HttpPipelineLogger

Dziedziczone z ServiceClientOptions.httpPipelineLogger

noRetryPolicy

Jeśli ustawiono wartość true, wyłącz domyślne zasady ponawiania prób.

noRetryPolicy?: boolean

Wartość właściwości

boolean

Dziedziczone z ServiceClientOptions.noRetryPolicy

proxySettings

Ustawienia serwera proxy, które będą używane dla każdego żądania HTTP (tylko Node.js).

proxySettings?: ProxySettings

Wartość właściwości

ProxySettings

Dziedziczone z ServiceClientOptions.proxySettings

redirectOptions

Opcje obsługi odpowiedzi przekierowania.

redirectOptions?: RedirectOptions

Wartość właściwości

RedirectOptions

Dziedziczone z ServiceClientOptions.redirectOptions

requestPolicyFactories

Tablica fabryk, które są wywoływane w celu utworzenia potoku RequestPolicy używanego do wysyłania żądania HTTP w sieci lub funkcji, która przyjmuje wartość domyślnąRequestPolicyFactories i zwraca wartość requestPolicyFactories, która zostanie użyta.

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

Wartość właściwości

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

Dziedziczone z ServiceClientOptions.requestPolicyFactories

rpRegistrationRetryTimeout

Pobiera lub ustawia limit czasu ponawiania w sekundach dla funkcji AutomaticRPRegistration. Wartość domyślna to 30.

rpRegistrationRetryTimeout?: number

Wartość właściwości

number

Dziedziczone z ServiceClientOptions.rpRegistrationRetryTimeout

userAgent

Ciąg, który ma zostać ustawiony na nagłówek telemetrii podczas wysyłania żądania, lub funkcji, która przyjmuje domyślny ciąg user-agent i zwraca ciąg agenta użytkownika, który zostanie użyty.

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

Wartość właściwości

string | (defaultUserAgent: string) => string

Dziedziczone z ServiceClientOptions.userAgent

userAgentHeaderName

Nazwa nagłówka do użycia dla nagłówka telemetrii podczas wysyłania żądania. Jeśli ta wartość nie zostanie określona, podczas uruchamiania polecenia "User-Agent" będzie używany podczas uruchamiania w Node.js i "x-ms-command-name" będzie używany podczas uruchamiania w przeglądarce.

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

Wartość właściwości

string | (defaultUserAgentHeaderName: string) => string

Dziedziczone z ServiceClientOptions.userAgentHeaderName

withCredentials

Czy należy dołączać poświadczenia do żądań CORS w przeglądarce. Aby uzyskać więcej informacji, zobacz https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials.

withCredentials?: boolean

Wartość właściwości

boolean

Dziedziczone z ServiceClientOptions.withCredentials