KnowledgeRetrievalClientOptions interface

Pakiet:

@azure/search-documents

Opcje klienta używane do konfigurowania żądań interfejsu API usługi Cognitive Search.

Rozszerzenie

ExtendedCommonClientOptions

Właściwości

audience	Odbiorcy do użycia do uwierzytelniania za pomocą usługi Azure Active Directory (AAD). Odbiorcy nie są brani pod uwagę w przypadku korzystania z klucza wspólnego. KnownSearchAudience może być używany zamiennie z audience
serviceVersion	Wersja usługi, która ma być używana podczas komunikowania się z usługą.

Właściwości dziedziczone

additionalPolicies	Dodatkowe zasady do uwzględnienia w potoku HTTP.
agent	Opcje konfigurowania wystąpienia agenta dla żądań wychodzących
allowInsecureConnection	Ustaw wartość true, jeśli żądanie jest wysyłane za pośrednictwem protokołu HTTP zamiast HTTPS
httpClient	Obiekt HttpClient, który będzie używany do wysyłania żądań HTTP.
keepAliveOptions	Opcje wyłączania utrzymywania przy życiu.
proxyOptions	Opcje konfigurowania serwera proxy dla żądań wychodzących.
redirectOptions	Opcje obsługi odpowiedzi przekierowania.
retryOptions	Opcje kontrolujące sposób ponawiania żądań, które zakończyły się niepowodzeniem.
telemetryOptions	Opcje ustawiania typowych danych telemetrycznych i informacji śledzenia na żądania wychodzące.
tlsOptions	Opcje konfigurowania uwierzytelniania TLS
userAgentOptions	Opcje dodawania szczegółów agenta użytkownika do żądań wychodzących.

Szczegóły właściwości

audience

Odbiorcy do użycia do uwierzytelniania za pomocą usługi Azure Active Directory (AAD). Odbiorcy nie są brani pod uwagę w przypadku korzystania z klucza wspólnego. KnownSearchAudience może być używany zamiennie z audience

audience?: string

Wartość właściwości

string

serviceVersion

Wersja usługi, która ma być używana podczas komunikowania się z usługą.

serviceVersion?: string

Wartość właściwości

string

Szczegóły właściwości dziedziczonej

additionalPolicies

Dodatkowe zasady do uwzględnienia w potoku HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Wartość właściwości

AdditionalPolicyConfig[]

Odziedziczone po ExtendedCommonClientOptions.additionalPolicies

agent

Opcje konfigurowania wystąpienia agenta dla żądań wychodzących

agent?: Agent

Wartość właściwości

Agent

Odziedziczone po ExtendedCommonClientOptions.agent

allowInsecureConnection

Ustaw wartość true, jeśli żądanie jest wysyłane za pośrednictwem protokołu HTTP zamiast HTTPS

allowInsecureConnection?: boolean

Wartość właściwości

boolean

Odziedziczone po ExtendedCommonClientOptions.allowInsecureConnection

httpClient

Obiekt HttpClient, który będzie używany do wysyłania żądań HTTP.

httpClient?: HttpClient

Wartość właściwości

HttpClient

Odziedziczone po ExtendedCommonClientOptions.httpClient

keepAliveOptions

Opcje wyłączania utrzymywania przy życiu.

keepAliveOptions?: KeepAliveOptions

Wartość właściwości

KeepAliveOptions

Odziedziczone po ExtendedCommonClientOptions.keepAliveOptions

proxyOptions

Opcje konfigurowania serwera proxy dla żądań wychodzących.

proxyOptions?: ProxySettings

Wartość właściwości

ProxySettings

Odziedziczone po ExtendedCommonClientOptions.proxyOptions

redirectOptions

Opcje obsługi odpowiedzi przekierowania.

redirectOptions?: RedirectPolicyOptions & RedirectOptions

Wartość właściwości

RedirectPolicyOptions & RedirectOptions

Odziedziczone po ExtendedCommonClientOptions.redirectOptions

retryOptions

Opcje kontrolujące sposób ponawiania żądań, które zakończyły się niepowodzeniem.

retryOptions?: PipelineRetryOptions

Wartość właściwości

PipelineRetryOptions

Odziedziczone po ExtendedCommonClientOptions.retryOptions

telemetryOptions

Opcje ustawiania typowych danych telemetrycznych i informacji śledzenia na żądania wychodzące.

telemetryOptions?: TelemetryOptions

Wartość właściwości

TelemetryOptions

Odziedziczone po ExtendedCommonClientOptions.telemetryOptions

tlsOptions

Opcje konfigurowania uwierzytelniania TLS

tlsOptions?: TlsSettings

Wartość właściwości

TlsSettings

Odziedziczone po ExtendedCommonClientOptions.tlsOptions

userAgentOptions

Opcje dodawania szczegółów agenta użytkownika do żądań wychodzących.

userAgentOptions?: UserAgentPolicyOptions

Wartość właściwości

UserAgentPolicyOptions

Odziedziczone po ExtendedCommonClientOptions.userAgentOptions