Condividi tramite

WebSearchClientOptions interface

  • Riferimento
Pacchetto:
@azure/cognitiveservices-websearch

Interfaccia che rappresenta WebSearchClientOptions.

Extends
ServiceClientOptions

Proprietà

endpoint

Endpoint di Servizi cognitivi supportati (protocollo e nome host, ad esempio: "https://westus.api.cognitive.microsoft.com", "https://api.cognitive.microsoft.com"). Valore predefinito: 'https://api.cognitive.microsoft.com'.

Proprietà ereditate

agentSettings

Agenti HTTP e HTTPS che verranno usati per ogni richiesta HTTP ( soloNode.js).
baseUri

Se specificato:

  • Questo baseUri diventa l'URI di base a cui verranno effettuate richieste per questo ServiceClient.
  • Se il baseUri corrisponde a un endpoint di Resource Manager noto e se un TokenCredential è stato passato attraverso il costruttore, questo baseUri definisce l'ambito getToken da ${options.baseUri}/.default. In caso contrario, per impostazione predefinita l'ambito è "https://management.azure.com/.default".

Se non è specificato:

  • All OperationSpecs deve contenere una proprietà baseUrl.
  • Se un TokenCredential è stato passato attraverso il costruttore, l'ambito di getToken è impostato su "https://management.azure.com/.default".
clientRequestIdHeaderName

Se specificato, alla pipeline HTTP verrà aggiunta un'intestazione GenerateRequestIdPolicy che aggiungerà un'intestazione a tutte le richieste in uscita con questo nome di intestazione e un UUID casuale come ID richiesta.
deserializationContentTypes

Tipi di contenuto che verranno associati alla serializzazione JSON o XML.
generateClientRequestIdHeader

Indica se generare o meno un'intestazione ID richiesta client per ogni richiesta HTTP.
httpClient

HttpClient che verrà usato per inviare richieste HTTP.
httpPipelineLogger

HttpPipelineLogger che può essere usato per eseguire il debug di RequestPolicies all'interno della pipeline HTTP.
noRetryPolicy

Se impostato su true, disattivare il criterio di ripetizione dei tentativi predefinito.
proxySettings

Impostazioni proxy che verranno usate per ogni richiesta HTTP ( soloNode.js).
redirectOptions

Opzioni per la gestione delle risposte di reindirizzamento.
requestPolicyFactories

Matrice di factory che vengono chiamate per creare la pipeline RequestPolicy usata per inviare una richiesta HTTP in transito o una funzione che accetta defaultRequestPolicyFactories e restituisce requestPolicyFactories che verrà usata.
rpRegistrationRetryTimeout

Ottiene o imposta il timeout dei tentativi in secondi per AutomaticRPRegistration. Il valore predefinito è 30.
userAgent

Stringa da impostare sull'intestazione di telemetria durante l'invio della richiesta o una funzione che accetta la stringa dell'agente utente predefinita e restituisce la stringa dell'agente utente che verrà usata.
userAgentHeaderName

Nome dell'intestazione da usare per l'intestazione di telemetria durante l'invio della richiesta. Se non viene specificato, verrà usato "User-Agent" durante l'esecuzione in Node.js e "x-ms-command-name" verrà usato durante l'esecuzione in un browser.
withCredentials

Indica se includere le credenziali nelle richieste CORS nel browser. Per altre informazioni, vedere https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials.

Dettagli proprietà

endpoint

Endpoint di Servizi cognitivi supportati (protocollo e nome host, ad esempio: "https://westus.api.cognitive.microsoft.com", "https://api.cognitive.microsoft.com"). Valore predefinito: 'https://api.cognitive.microsoft.com'.

endpoint?: string

Valore della proprietà

string

Dettagli proprietà ereditate

agentSettings

Agenti HTTP e HTTPS che verranno usati per ogni richiesta HTTP ( soloNode.js).

agentSettings?: AgentSettings

Valore della proprietà

AgentSettings

Ereditato da ServiceClientOptions.agentSettings

baseUri

Se specificato:

  • Questo baseUri diventa l'URI di base a cui verranno effettuate richieste per questo ServiceClient.
  • Se il baseUri corrisponde a un endpoint di Resource Manager noto e se un TokenCredential è stato passato attraverso il costruttore, questo baseUri definisce l'ambito getToken da ${options.baseUri}/.default. In caso contrario, per impostazione predefinita l'ambito è "https://management.azure.com/.default".

Se non è specificato:

  • All OperationSpecs deve contenere una proprietà baseUrl.
  • Se un TokenCredential è stato passato attraverso il costruttore, l'ambito di getToken è impostato su "https://management.azure.com/.default".
baseUri?: string

Valore della proprietà

string

Ereditato da ServiceClientOptions.baseUri

clientRequestIdHeaderName

Se specificato, alla pipeline HTTP verrà aggiunta un'intestazione GenerateRequestIdPolicy che aggiungerà un'intestazione a tutte le richieste in uscita con questo nome di intestazione e un UUID casuale come ID richiesta.

clientRequestIdHeaderName?: string

Valore della proprietà

string

Ereditato da ServiceClientOptions.clientRequestIdHeaderName

deserializationContentTypes

Tipi di contenuto che verranno associati alla serializzazione JSON o XML.

deserializationContentTypes?: DeserializationContentTypes

Valore della proprietà

DeserializationContentTypes

Ereditato da ServiceClientOptions.deserializationContentTypes

generateClientRequestIdHeader

Indica se generare o meno un'intestazione ID richiesta client per ogni richiesta HTTP.

generateClientRequestIdHeader?: boolean

Valore della proprietà

boolean

Ereditato da ServiceClientOptions.generateClientRequestIdHeader

httpClient

HttpClient che verrà usato per inviare richieste HTTP.

httpClient?: HttpClient

Valore della proprietà

HttpClient

Ereditato da ServiceClientOptions.httpClient

httpPipelineLogger

HttpPipelineLogger che può essere usato per eseguire il debug di RequestPolicies all'interno della pipeline HTTP.

httpPipelineLogger?: HttpPipelineLogger

Valore della proprietà

HttpPipelineLogger

Ereditato da ServiceClientOptions.httpPipelineLogger

noRetryPolicy

Se impostato su true, disattivare il criterio di ripetizione dei tentativi predefinito.

noRetryPolicy?: boolean

Valore della proprietà

boolean

Ereditato da ServiceClientOptions.noRetryPolicy

proxySettings

Impostazioni proxy che verranno usate per ogni richiesta HTTP ( soloNode.js).

proxySettings?: ProxySettings

Valore della proprietà

ProxySettings

Ereditato da ServiceClientOptions.proxySettings

redirectOptions

Opzioni per la gestione delle risposte di reindirizzamento.

redirectOptions?: RedirectOptions

Valore della proprietà

RedirectOptions

Ereditato da ServiceClientOptions.redirectOptions

requestPolicyFactories

Matrice di factory che vengono chiamate per creare la pipeline RequestPolicy usata per inviare una richiesta HTTP in transito o una funzione che accetta defaultRequestPolicyFactories e restituisce requestPolicyFactories che verrà usata.

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

Valore della proprietà

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

Ereditato da ServiceClientOptions.requestPolicyFactories

rpRegistrationRetryTimeout

Ottiene o imposta il timeout dei tentativi in secondi per AutomaticRPRegistration. Il valore predefinito è 30.

rpRegistrationRetryTimeout?: number

Valore della proprietà

number

Ereditato da ServiceClientOptions.rpRegistrationRetryTimeout

userAgent

Stringa da impostare sull'intestazione di telemetria durante l'invio della richiesta o una funzione che accetta la stringa dell'agente utente predefinita e restituisce la stringa dell'agente utente che verrà usata.

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

Valore della proprietà

string | (defaultUserAgent: string) => string

Ereditato da ServiceClientOptions.userAgent

userAgentHeaderName

Nome dell'intestazione da usare per l'intestazione di telemetria durante l'invio della richiesta. Se non viene specificato, verrà usato "User-Agent" durante l'esecuzione in Node.js e "x-ms-command-name" verrà usato durante l'esecuzione in un browser.

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

Valore della proprietà

string | (defaultUserAgentHeaderName: string) => string

Ereditato da ServiceClientOptions.userAgentHeaderName

withCredentials

Indica se includere le credenziali nelle richieste CORS nel browser. Per altre informazioni, vedere https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials.

withCredentials?: boolean

Valore della proprietà

boolean

Ereditato da ServiceClientOptions.withCredentials