Share via


SearchClientOptions interface

Opzioni client usate per configurare le richieste dell'API Ricerca cognitiva.

Extends

Proprietà

apiVersion

Versione dell'API da usare durante la comunicazione con il servizio.

audience

Destinatari da usare per l'autenticazione con Azure Active Directory (AAD). Il gruppo di destinatari non viene considerato quando si usa una chiave condivisa. KnownSearchAudience può essere usato in modo intercambiabile con il pubblico

serviceVersion

Versione del servizio da usare durante la comunicazione con il servizio.

Proprietà ereditate

additionalPolicies

Criteri aggiuntivi da includere nella pipeline HTTP.

allowInsecureConnection

Impostare su true se la richiesta viene inviata tramite HTTP anziché HTTPS

httpClient

HttpClient che verrà usato per inviare richieste HTTP.

keepAliveOptions

Opzioni per disabilitare keep-alive.

proxyOptions

Opzioni per configurare un proxy per le richieste in uscita.

redirectOptions

Opzioni per la gestione delle risposte di reindirizzamento.

retryOptions

Opzioni che controllano come ripetere le richieste non riuscite.

telemetryOptions

Opzioni per impostare dati di telemetria comuni e informazioni di traccia alle richieste in uscita.

tlsOptions

Opzioni per la configurazione dell'autenticazione TLS

userAgentOptions

Opzioni per aggiungere i dettagli dell'agente utente alle richieste in uscita.

Dettagli proprietà

apiVersion

Avviso

Questa API è ora deprecata.

use serviceVersion instead

Versione dell'API da usare durante la comunicazione con il servizio.

apiVersion?: string

Valore della proprietà

string

audience

Destinatari da usare per l'autenticazione con Azure Active Directory (AAD). Il gruppo di destinatari non viene considerato quando si usa una chiave condivisa. KnownSearchAudience può essere usato in modo intercambiabile con il pubblico

audience?: string

Valore della proprietà

string

serviceVersion

Versione del servizio da usare durante la comunicazione con il servizio.

serviceVersion?: string

Valore della proprietà

string

Dettagli proprietà ereditate

additionalPolicies

Criteri aggiuntivi da includere nella pipeline HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Valore della proprietà

Ereditato da ExtendedCommonClientOptions.additionalPolicies

allowInsecureConnection

Impostare su true se la richiesta viene inviata tramite HTTP anziché HTTPS

allowInsecureConnection?: boolean

Valore della proprietà

boolean

Ereditato da ExtendedCommonClientOptions.allowInsecureConnection

httpClient

HttpClient che verrà usato per inviare richieste HTTP.

httpClient?: HttpClient

Valore della proprietà

Ereditato da ExtendedCommonClientOptions.httpClient

keepAliveOptions

Opzioni per disabilitare keep-alive.

keepAliveOptions?: KeepAliveOptions

Valore della proprietà

Ereditato da ExtendedCommonClientOptions.keepAliveOptions

proxyOptions

Opzioni per configurare un proxy per le richieste in uscita.

proxyOptions?: ProxySettings

Valore della proprietà

Ereditato da ExtendedCommonClientOptions.proxyOptions

redirectOptions

Opzioni per la gestione delle risposte di reindirizzamento.

redirectOptions?: RedirectPolicyOptions & RedirectOptions

Valore della proprietà

Ereditato da ExtendedCommonClientOptions.redirectOptions

retryOptions

Opzioni che controllano come ripetere le richieste non riuscite.

retryOptions?: PipelineRetryOptions

Valore della proprietà

Ereditato da ExtendedCommonClientOptions.retryOptions

telemetryOptions

Opzioni per impostare dati di telemetria comuni e informazioni di traccia alle richieste in uscita.

telemetryOptions?: TelemetryOptions

Valore della proprietà

Ereditato da ExtendedCommonClientOptions.telemetryOptions

tlsOptions

Opzioni per la configurazione dell'autenticazione TLS

tlsOptions?: TlsSettings

Valore della proprietà

Ereditato da ExtendedCommonClientOptions.tlsOptions

userAgentOptions

Opzioni per aggiungere i dettagli dell'agente utente alle richieste in uscita.

userAgentOptions?: UserAgentPolicyOptions

Valore della proprietà

Ereditato da ExtendedCommonClientOptions.userAgentOptions