WebSearchClientOptions interface

Pakket:

@azure/cognitiveservices-websearch

Een interface die WebSearchClientOptions vertegenwoordigt.

Extends

ServiceClientOptions

Eigenschappen

endpoint

Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: "https://westus.api.cognitive.microsoft.com", "https://api.cognitive.microsoft.com"). Standaardwaarde: 'https://api.cognitive.microsoft.com'.

Overgenomen eigenschappen

agentSettings	HTTP- en HTTPS-agents die worden gebruikt voor elke HTTP-aanvraag (alleen Node.js).
baseUri	Indien opgegeven: Dit baseUri wordt de basis-URI waarvoor aanvragen worden ingediend voor deze ServiceClient. Als de baseUri overeenkomt met een bekend Resource Manager-eindpunt en als een TokenCredential is doorgegeven via de constructor, baseUri wordt het getToken bereik gedefinieerd als ${options.baseUri}/.default. Anders wordt het bereik standaard ingesteld op 'https://management.azure.com/.default". Als dit niet is opgegeven: Alle OperationSpecs moet een baseUrl-eigenschap bevatten. Als een TokenCredential is doorgegeven via de constructor, wordt het getToken bereik ingesteld op 'https://management.azure.com/.default".
clientRequestIdHeaderName	Als dit is opgegeven, wordt een GenerateRequestIdPolicy toegevoegd aan de HTTP-pijplijn die een header toevoegt aan alle uitgaande aanvragen met deze headernaam en een willekeurige UUID als de aanvraag-id.
deserializationContentTypes	De inhoudstypen die worden gekoppeld aan JSON- of XML-serialisatie.
generateClientRequestIdHeader	Of er voor elke HTTP-aanvraag een clientaanvraag-id-header moet worden gegenereerd.
httpClient	De HttpClient die wordt gebruikt voor het verzenden van HTTP-aanvragen.
httpPipelineLogger	De HttpPipelineLogger die kan worden gebruikt voor het opsporen van fouten in RequestPolicies binnen de HTTP-pijplijn.
noRetryPolicy	Als dit is ingesteld op true, schakelt u het standaardbeleid voor opnieuw proberen uit.
proxySettings	Proxy-instellingen die worden gebruikt voor elke HTTP-aanvraag (alleen Node.js).
redirectOptions	Opties voor hoe omleidingsreacties worden verwerkt.
requestPolicyFactories	Een matrix van factory's die worden aangeroepen om de RequestPolicy-pijplijn te maken die wordt gebruikt voor het verzenden van een HTTP-aanvraag op de wire, of een functie die de defaultRequestPolicyFactories opneemt en de requestPolicyFactories retourneert die wordt gebruikt.
rpRegistrationRetryTimeout	Hiermee wordt de time-out voor opnieuw proberen in seconden opgehaald of ingesteld voor AutomaticRPRegistration. De standaardwaarde is 30.
userAgent	De tekenreeks die moet worden ingesteld op de telemetrieheader tijdens het verzenden van de aanvraag, of een functie die de standaardtekenreeks user-agent opneemt en de tekenreeks user-agent retourneert die wordt gebruikt.
userAgentHeaderName	De headernaam die moet worden gebruikt voor de telemetrieheader tijdens het verzenden van de aanvraag. Als dit niet is opgegeven, wordt 'User-Agent' gebruikt bij het uitvoeren op Node.js en wordt 'x-ms-command-name' gebruikt bij het uitvoeren in een browser.
withCredentials	Of referenties moeten worden opgenomen in CORS-aanvragen in de browser. Zie https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials voor meer informatie.

Eigenschapdetails

endpoint

Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: "https://westus.api.cognitive.microsoft.com", "https://api.cognitive.microsoft.com"). Standaardwaarde: 'https://api.cognitive.microsoft.com'.

endpoint?: string

Waarde van eigenschap

string

Details van overgenomen eigenschap

agentSettings

HTTP- en HTTPS-agents die worden gebruikt voor elke HTTP-aanvraag (alleen Node.js).

agentSettings?: AgentSettings

Waarde van eigenschap

AgentSettings

Overgenomen van ServiceClientOptions.agentSettings

baseUri

Indien opgegeven:

• Dit baseUri wordt de basis-URI waarvoor aanvragen worden ingediend voor deze ServiceClient.
• Als de baseUri overeenkomt met een bekend Resource Manager-eindpunt en als een TokenCredential is doorgegeven via de constructor, baseUri wordt het getToken bereik gedefinieerd als ${options.baseUri}/.default. Anders wordt het bereik standaard ingesteld op 'https://management.azure.com/.default".

Als dit niet is opgegeven:

• Alle OperationSpecs moet een baseUrl-eigenschap bevatten.
• Als een TokenCredential is doorgegeven via de constructor, wordt het getToken bereik ingesteld op 'https://management.azure.com/.default".

baseUri?: string

Waarde van eigenschap

string

Overgenomen van ServiceClientOptions.baseUri

clientRequestIdHeaderName

Als dit is opgegeven, wordt een GenerateRequestIdPolicy toegevoegd aan de HTTP-pijplijn die een header toevoegt aan alle uitgaande aanvragen met deze headernaam en een willekeurige UUID als de aanvraag-id.

clientRequestIdHeaderName?: string

Waarde van eigenschap

string

Overgenomen van ServiceClientOptions.clientRequestIdHeaderName

deserializationContentTypes

De inhoudstypen die worden gekoppeld aan JSON- of XML-serialisatie.

deserializationContentTypes?: DeserializationContentTypes

Waarde van eigenschap

DeserializationContentTypes

Overgenomen van ServiceClientOptions.deserializationContentTypes

generateClientRequestIdHeader

Of er voor elke HTTP-aanvraag een clientaanvraag-id-header moet worden gegenereerd.

generateClientRequestIdHeader?: boolean

Waarde van eigenschap

boolean

Overgenomen van ServiceClientOptions.generateClientRequestIdHeader

httpClient

De HttpClient die wordt gebruikt voor het verzenden van HTTP-aanvragen.

httpClient?: HttpClient

Waarde van eigenschap

HttpClient

Overgenomen van ServiceClientOptions.httpClient

httpPipelineLogger

De HttpPipelineLogger die kan worden gebruikt voor het opsporen van fouten in RequestPolicies binnen de HTTP-pijplijn.

httpPipelineLogger?: HttpPipelineLogger

Waarde van eigenschap

HttpPipelineLogger

Overgenomen van ServiceClientOptions.httpPipelineLogger

noRetryPolicy

Als dit is ingesteld op true, schakelt u het standaardbeleid voor opnieuw proberen uit.

noRetryPolicy?: boolean

Waarde van eigenschap

boolean

Overgenomen van ServiceClientOptions.noRetryPolicy

proxySettings

Proxy-instellingen die worden gebruikt voor elke HTTP-aanvraag (alleen Node.js).

proxySettings?: ProxySettings

Waarde van eigenschap

ProxySettings

Overgenomen van ServiceClientOptions.proxySettings

redirectOptions

Opties voor hoe omleidingsreacties worden verwerkt.

redirectOptions?: RedirectOptions

Waarde van eigenschap

RedirectOptions

Overgenomen van ServiceClientOptions.redirectOptions

requestPolicyFactories

Een matrix van factory's die worden aangeroepen om de RequestPolicy-pijplijn te maken die wordt gebruikt voor het verzenden van een HTTP-aanvraag op de wire, of een functie die de defaultRequestPolicyFactories opneemt en de requestPolicyFactories retourneert die wordt gebruikt.

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

Waarde van eigenschap

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

Overgenomen van ServiceClientOptions.requestPolicyFactories

rpRegistrationRetryTimeout

Hiermee wordt de time-out voor opnieuw proberen in seconden opgehaald of ingesteld voor AutomaticRPRegistration. De standaardwaarde is 30.

rpRegistrationRetryTimeout?: number

Waarde van eigenschap

number

Overgenomen van ServiceClientOptions.rpRegistrationRetryTimeout

userAgent

De tekenreeks die moet worden ingesteld op de telemetrieheader tijdens het verzenden van de aanvraag, of een functie die de standaardtekenreeks user-agent opneemt en de tekenreeks user-agent retourneert die wordt gebruikt.

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

Waarde van eigenschap

string | (defaultUserAgent: string) => string

Overgenomen van ServiceClientOptions.userAgent

userAgentHeaderName

De headernaam die moet worden gebruikt voor de telemetrieheader tijdens het verzenden van de aanvraag. Als dit niet is opgegeven, wordt 'User-Agent' gebruikt bij het uitvoeren op Node.js en wordt 'x-ms-command-name' gebruikt bij het uitvoeren in een browser.

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

Waarde van eigenschap

string | (defaultUserAgentHeaderName: string) => string

Overgenomen van ServiceClientOptions.userAgentHeaderName

withCredentials

Of referenties moeten worden opgenomen in CORS-aanvragen in de browser. Zie https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials voor meer informatie.

withCredentials?: boolean

Waarde van eigenschap

boolean

Overgenomen van ServiceClientOptions.withCredentials