SearchClientOptions interface

Paket:
@azure/search-documents

Klientalternativ som används för att konfigurera AI Search API-begäranden.

Extends
ClientOptions

Egenskaper

apiVersion

DEN API-version som ska användas när du kommunicerar med tjänsten.
audience

Målgruppen som ska användas för autentisering med Azure Active Directory (AAD). Målgruppen beaktas inte när du använder en delad nyckel. KnownSearchAudience kan användas utbytbart med målgruppen
serviceVersion

Den tjänstversion som ska användas när du kommunicerar med tjänsten.

Ärvda egenskaper

additionalPolicies

Ytterligare principer som ska ingå i HTTP-pipelinen.
agent

Alternativ för att konfigurera agentinstans för utgående begäranden
allowInsecureConnection

Alternativ för att tillåta att http-slutpunkter (osäkra) anropas
baseUrl

Bas-URL för klienten
credentials

Information om autentiseringsuppgifter
endpoint

Slutpunkt för klienten
httpClient

Ange en anpassad HttpClient när du gör begäranden.
loggingOptions

Alternativ för att konfigurera loggning av begäran/svar.
pipeline

Pipeline att använda för klienten. Om den inte tillhandahålls kommer en standardpipeline att skapas med hjälp av de angivna alternativen. Använd med försiktighet – när du ställer in detta alternativ kommer alla klientalternativ som används vid skapandet av standardpipelinen att ignoreras.
proxyOptions

Alternativ för att konfigurera en proxy för utgående begäranden.
redirectOptions

Alternativ för hur omdirigeringssvar hanteras.
retryOptions

Alternativ som styr hur du försöker utföra misslyckade begäranden igen.
telemetryOptions

Alternativ för att ange vanlig telemetri och spårningsinformation för utgående begäranden.
tlsOptions

Alternativ för att konfigurera TLS-autentisering
userAgentOptions

Alternativ för att lägga till information om användaragenten i utgående begäranden.

Egenskapsinformation

apiVersion

Varning

Det här API:et är nu inaktuellt.

use serviceVersion instead

DEN API-version som ska användas när du kommunicerar med tjänsten.

apiVersion?: string

Egenskapsvärde

string

audience

Målgruppen som ska användas för autentisering med Azure Active Directory (AAD). Målgruppen beaktas inte när du använder en delad nyckel. KnownSearchAudience kan användas utbytbart med målgruppen

audience?: string

Egenskapsvärde

string

serviceVersion

Den tjänstversion som ska användas när du kommunicerar med tjänsten.

serviceVersion?: string

Egenskapsvärde

string

Information om ärvda egenskaper

additionalPolicies

Ytterligare principer som ska ingå i HTTP-pipelinen.

additionalPolicies?: AdditionalPolicyConfig[]

Egenskapsvärde

AdditionalPolicyConfig[]

ärvd från ClientOptions.additionalPolicies

agent

Alternativ för att konfigurera agentinstans för utgående begäranden

agent?: Agent

Egenskapsvärde

Agent

ärvd från ClientOptions.agent

allowInsecureConnection

Alternativ för att tillåta att http-slutpunkter (osäkra) anropas

allowInsecureConnection?: boolean

Egenskapsvärde

boolean

ärvd från ClientOptions.allowInsecureConnection

baseUrl

Varning

Det här API:et är nu inaktuellt.

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

Bas-URL för klienten

baseUrl?: string

Egenskapsvärde

string

ärvd från ClientOptions.baseUrl

credentials

Information om autentiseringsuppgifter

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

Egenskapsvärde

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

ärvd från ClientOptions.credentials

endpoint

Slutpunkt för klienten

endpoint?: string

Egenskapsvärde

string

ärvd från ClientOptions.endpoint

httpClient

Ange en anpassad HttpClient när du gör begäranden.

httpClient?: HttpClient

Egenskapsvärde

HttpClient

ärvd från ClientOptions.httpClient

loggingOptions

Alternativ för att konfigurera loggning av begäran/svar.

loggingOptions?: LogPolicyOptions

Egenskapsvärde

LogPolicyOptions

ärvs från ClientOptions.loggingOptions

pipeline

Pipeline att använda för klienten. Om den inte tillhandahålls kommer en standardpipeline att skapas med hjälp av de angivna alternativen. Använd med försiktighet – när du ställer in detta alternativ kommer alla klientalternativ som används vid skapandet av standardpipelinen att ignoreras.

pipeline?: Pipeline

Egenskapsvärde

Pipeline

Ärvt från ClientOptions.pipeline

proxyOptions

Alternativ för att konfigurera en proxy för utgående begäranden.

proxyOptions?: ProxySettings

Egenskapsvärde

ProxySettings

ärvd från ClientOptions.proxyOptions

redirectOptions

Alternativ för hur omdirigeringssvar hanteras.

redirectOptions?: RedirectPolicyOptions

Egenskapsvärde

RedirectPolicyOptions

ärvs från ClientOptions.redirectOptions

retryOptions

Alternativ som styr hur du försöker utföra misslyckade begäranden igen.

retryOptions?: PipelineRetryOptions

Egenskapsvärde

PipelineRetryOptions

ärvd från ClientOptions.retryOptions

telemetryOptions

Alternativ för att ange vanlig telemetri och spårningsinformation för utgående begäranden.

telemetryOptions?: TelemetryOptions

Egenskapsvärde

TelemetryOptions

ärvd från ClientOptions.telemetryOptions

tlsOptions

Alternativ för att konfigurera TLS-autentisering

tlsOptions?: TlsSettings

Egenskapsvärde

TlsSettings

ärvs från ClientOptions.tlsOptions

userAgentOptions

Alternativ för att lägga till information om användaragenten i utgående begäranden.

userAgentOptions?: UserAgentPolicyOptions

Egenskapsvärde

UserAgentPolicyOptions

ärvd från ClientOptions.userAgentOptions