KnowledgeRetrievalClientOptions interface

Pacchetto:
@azure/search-documents

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

Extends
ClientOptions

Proprietà

audience

Gruppo di 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

La versione del servizio da utilizzare per la comunicazione con il servizio.

Proprietà ereditate

additionalPolicies

Criteri aggiuntivi da includere nella pipeline HTTP.
agent

Opzioni per la configurazione dell'istanza di Agent per le richieste in uscita
allowInsecureConnection

Opzione per consentire la chiamata di endpoint HTTP (non sicuri)
apiVersion

Opzioni per l'impostazione di un'apiVersion personalizzata.
baseUrl

URL di base per il client
credentials

Informazioni sulle credenziali
endpoint

Endpoint per il client
httpClient

Specificare un HttpClient personalizzato durante l'esecuzione di richieste.
loggingOptions

Opzioni per configurare la registrazione delle richieste/risposte.
pipeline

Pipeline da usare per il client. Se non viene fornita, verrà creata una pipeline predefinita utilizzando le opzioni fornite. Usa con cautela: quando si imposta questa opzione, tutte le opzioni client utilizzate nella creazione della pipeline predefinita verranno ignorate.
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 l'aggiunta dei dettagli dell'agente utente alle richieste in uscita.

Dettagli proprietà

audience

Gruppo di 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

La versione del servizio da utilizzare per 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à

AdditionalPolicyConfig[]

Ereditato da ClientOptions.additionalPolicies

agent

Opzioni per la configurazione dell'istanza di Agent per le richieste in uscita

agent?: Agent

Valore della proprietà

Agent

Ereditato da ClientOptions.agent

allowInsecureConnection

Opzione per consentire la chiamata di endpoint HTTP (non sicuri)

allowInsecureConnection?: boolean

Valore della proprietà

boolean

Ereditato da ClientOptions.allowInsecureConnection

apiVersion

Opzioni per l'impostazione di un'apiVersion personalizzata.

apiVersion?: string

Valore della proprietà

string

Ereditato da ClientOptions.apiVersion

baseUrl

Avviso

Questa API è ora deprecata.

This property is deprecated and will be removed soon, please use endpoint instead

URL di base per il client

baseUrl?: string

Valore della proprietà

string

Ereditato da ClientOptions.baseUrl

credentials

Informazioni sulle credenziali

credentials?: { apiKeyHeaderName?: string, scopes?: string[] }

Valore della proprietà

{ apiKeyHeaderName?: string, scopes?: string[] }

Ereditato da ClientOptions.credentials

endpoint

Endpoint per il client

endpoint?: string

Valore della proprietà

string

Ereditato da ClientOptions.endpoint

httpClient

Specificare un HttpClient personalizzato durante l'esecuzione di richieste.

httpClient?: HttpClient

Valore della proprietà

HttpClient

ereditato da ClientOptions.httpClient

loggingOptions

Opzioni per configurare la registrazione delle richieste/risposte.

loggingOptions?: LogPolicyOptions

Valore della proprietà

LogPolicyOptions

Ereditato da ClientOptions.loggingOptions

pipeline

Pipeline da usare per il client. Se non viene fornita, verrà creata una pipeline predefinita utilizzando le opzioni fornite. Usa con cautela: quando si imposta questa opzione, tutte le opzioni client utilizzate nella creazione della pipeline predefinita verranno ignorate.

pipeline?: Pipeline

Valore della proprietà

Pipeline

Ereditato da ClientOptions.pipeline

proxyOptions

Opzioni per configurare un proxy per le richieste in uscita.

proxyOptions?: ProxySettings

Valore della proprietà

ProxySettings

Ereditato da ClientOptions.proxyOptions

redirectOptions

Opzioni per la gestione delle risposte di reindirizzamento.

redirectOptions?: RedirectPolicyOptions

Valore della proprietà

RedirectPolicyOptions

Ereditato da ClientOptions.redirectOptions

retryOptions

Opzioni che controllano come ripetere le richieste non riuscite.

retryOptions?: PipelineRetryOptions

Valore della proprietà

PipelineRetryOptions

Ereditato da ClientOptions.retryOptions

telemetryOptions

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

telemetryOptions?: TelemetryOptions

Valore della proprietà

TelemetryOptions

Ereditato da ClientOptions.telemetryOptions

tlsOptions

Opzioni per la configurazione dell'autenticazione TLS

tlsOptions?: TlsSettings

Valore della proprietà

TlsSettings

Ereditato da ClientOptions.tlsOptions

userAgentOptions

Opzioni per l'aggiunta dei dettagli dell'agente utente alle richieste in uscita.

userAgentOptions?: UserAgentPolicyOptions

Valore della proprietà

UserAgentPolicyOptions

Ereditato da ClientOptions.userAgentOptions