Dela via

WebSearchClientOptions interface

  • Referens
Paket:
@azure/cognitiveservices-websearch

Ett gränssnitt som representerar WebSearchClientOptions.

Extends
ServiceClientOptions

Egenskaper

endpoint

Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: "https://westus.api.cognitive.microsoft.com", "https://api.cognitive.microsoft.com"). Standardvärde: 'https://api.cognitive.microsoft.com'.

Ärvda egenskaper

agentSettings

HTTP- och HTTPS-agenter som kommer att användas för varje HTTP-begäran (endast Node.js).
baseUri

Om detta anges:

  • Detta baseUri blir den bas-URI som begäranden görs mot för denna ServiceClient.
  • baseUri Om matchar en känd Resource Manager-slutpunkt och om en TokenCredential skickades via konstruktorn definierar detta baseUri omfånget getToken som ${options.baseUri}/.default. Annars skulle omfånget som standard vara "https://management.azure.com/.default".

Om det inte anges:

  • Alla OperationSpecs måste innehålla en baseUrl-egenskap.
  • Om en TokenCredential skickades via konstruktorn anges omfånget getToken till "https://management.azure.com/.default".
clientRequestIdHeaderName

Om detta anges läggs en GenerateRequestIdPolicy till i HTTP-pipelinen som lägger till en rubrik i alla utgående begäranden med det här rubriknamnet och ett slumpmässigt UUID som begärande-ID.
deserializationContentTypes

De innehållstyper som ska associeras med JSON- eller XML-serialisering.
generateClientRequestIdHeader

Om du vill generera ett klientbegärande-ID för varje HTTP-begäran eller inte.
httpClient

Den HttpClient som ska användas för att skicka HTTP-begäranden.
httpPipelineLogger

Den HttpPipelineLogger som kan användas för att felsöka RequestPolicies i HTTP-pipelinen.
noRetryPolicy

Om värdet är true inaktiverar du standardprincipen för återförsök.
proxySettings

Proxyinställningar som används för varje HTTP-begäran (endast Node.js).
redirectOptions

Alternativ för hur omdirigeringssvar hanteras.
requestPolicyFactories

En matris med fabriker som anropas för att skapa RequestPolicy-pipelinen som används för att skicka en HTTP-begäran på tråden, eller en funktion som tar in defaultRequestPolicyFactories och returnerar de requestPolicyFactories som ska användas.
rpRegistrationRetryTimeout

Hämtar eller anger tidsgränsen för återförsök i sekunder för AutomaticRPRegistration. Standardvärdet är 30.
userAgent

Strängen som ska anges till telemetrihuvudet när begäran skickas, eller en funktion som tar in standardsträngen för användaragenten och returnerar användaragentsträngen som ska användas.
userAgentHeaderName

Rubriknamnet som ska användas för telemetrihuvudet när begäran skickas. Om detta inte anges används "User-Agent" när den körs på Node.js och "x-ms-command-name" används när du kör i en webbläsare.
withCredentials

Om autentiseringsuppgifter ska inkluderas i CORS-begäranden i webbläsaren. Mer information finns i https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials.

Egenskapsinformation

endpoint

Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: "https://westus.api.cognitive.microsoft.com", "https://api.cognitive.microsoft.com"). Standardvärde: 'https://api.cognitive.microsoft.com'.

endpoint?: string

Egenskapsvärde

string

Information om ärvda egenskaper

agentSettings

HTTP- och HTTPS-agenter som kommer att användas för varje HTTP-begäran (endast Node.js).

agentSettings?: AgentSettings

Egenskapsvärde

AgentSettings

Ärvd från ServiceClientOptions.agentSettings

baseUri

Om detta anges:

  • Detta baseUri blir den bas-URI som begäranden görs mot för denna ServiceClient.
  • baseUri Om matchar en känd Resource Manager-slutpunkt och om en TokenCredential skickades via konstruktorn definierar detta baseUri omfånget getToken som ${options.baseUri}/.default. Annars skulle omfånget som standard vara "https://management.azure.com/.default".

Om det inte anges:

  • Alla OperationSpecs måste innehålla en baseUrl-egenskap.
  • Om en TokenCredential skickades via konstruktorn anges omfånget getToken till "https://management.azure.com/.default".
baseUri?: string

Egenskapsvärde

string

Ärvd från ServiceClientOptions.baseUri

clientRequestIdHeaderName

Om detta anges läggs en GenerateRequestIdPolicy till i HTTP-pipelinen som lägger till en rubrik i alla utgående begäranden med det här rubriknamnet och ett slumpmässigt UUID som begärande-ID.

clientRequestIdHeaderName?: string

Egenskapsvärde

string

Ärvd från ServiceClientOptions.clientRequestIdHeaderName

deserializationContentTypes

De innehållstyper som ska associeras med JSON- eller XML-serialisering.

deserializationContentTypes?: DeserializationContentTypes

Egenskapsvärde

DeserializationContentTypes

Ärvd från ServiceClientOptions.deserializationContentTypes

generateClientRequestIdHeader

Om du vill generera ett klientbegärande-ID för varje HTTP-begäran eller inte.

generateClientRequestIdHeader?: boolean

Egenskapsvärde

boolean

Ärvd från ServiceClientOptions.generateClientRequestIdHeader

httpClient

Den HttpClient som ska användas för att skicka HTTP-begäranden.

httpClient?: HttpClient

Egenskapsvärde

HttpClient

Ärvd från ServiceClientOptions.httpClient

httpPipelineLogger

Den HttpPipelineLogger som kan användas för att felsöka RequestPolicies i HTTP-pipelinen.

httpPipelineLogger?: HttpPipelineLogger

Egenskapsvärde

HttpPipelineLogger

Ärvd från ServiceClientOptions.httpPipelineLogger

noRetryPolicy

Om värdet är true inaktiverar du standardprincipen för återförsök.

noRetryPolicy?: boolean

Egenskapsvärde

boolean

Ärvd från ServiceClientOptions.noRetryPolicy

proxySettings

Proxyinställningar som används för varje HTTP-begäran (endast Node.js).

proxySettings?: ProxySettings

Egenskapsvärde

ProxySettings

Ärvd från ServiceClientOptions.proxySettings

redirectOptions

Alternativ för hur omdirigeringssvar hanteras.

redirectOptions?: RedirectOptions

Egenskapsvärde

RedirectOptions

Ärvd från ServiceClientOptions.redirectOptions

requestPolicyFactories

En matris med fabriker som anropas för att skapa RequestPolicy-pipelinen som används för att skicka en HTTP-begäran på tråden, eller en funktion som tar in defaultRequestPolicyFactories och returnerar de requestPolicyFactories som ska användas.

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

Egenskapsvärde

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

Ärvd från ServiceClientOptions.requestPolicyFactories

rpRegistrationRetryTimeout

Hämtar eller anger tidsgränsen för återförsök i sekunder för AutomaticRPRegistration. Standardvärdet är 30.

rpRegistrationRetryTimeout?: number

Egenskapsvärde

number

Ärvd från ServiceClientOptions.rpRegistrationRetryTimeout

userAgent

Strängen som ska anges till telemetrihuvudet när begäran skickas, eller en funktion som tar in standardsträngen för användaragenten och returnerar användaragentsträngen som ska användas.

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

Egenskapsvärde

string | (defaultUserAgent: string) => string

Ärvd från ServiceClientOptions.userAgent

userAgentHeaderName

Rubriknamnet som ska användas för telemetrihuvudet när begäran skickas. Om detta inte anges används "User-Agent" när den körs på Node.js och "x-ms-command-name" används när du kör i en webbläsare.

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

Egenskapsvärde

string | (defaultUserAgentHeaderName: string) => string

Ärvd från ServiceClientOptions.userAgentHeaderName

withCredentials

Om autentiseringsuppgifter ska inkluderas i CORS-begäranden i webbläsaren. Mer information finns i https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials.

withCredentials?: boolean

Egenskapsvärde

boolean

Ärvd från ServiceClientOptions.withCredentials