Partilhar via

SearchClientOptions interface

  • Referência
Pacote:
@azure/search-documents

Opções de cliente utilizadas para configurar pedidos da API de Pesquisa Cognitiva.

Extends
ExtendedCommonClientOptions

Propriedades

apiVersion

A versão da API a utilizar ao comunicar com o serviço.
audience

A Audiência a utilizar para autenticação com o Azure Active Directory (AAD). A audiência não é considerada ao utilizar uma chave partilhada. KnownSearchAudience pode ser utilizado alternadamente com o público
serviceVersion

A versão do serviço a utilizar ao comunicar com o serviço.

Propriedades Herdadas

additionalPolicies

Políticas adicionais a incluir no pipeline HTTP.
allowInsecureConnection

Defina como verdadeiro se o pedido for enviado através de HTTP em vez de HTTPS
httpClient

O HttpClient que será utilizado para enviar pedidos HTTP.
keepAliveOptions

Opções para desativar manter-se vivo.
proxyOptions

Opções para configurar um proxy para pedidos de saída.
redirectOptions

Opções para a forma como as respostas de redirecionamento são processadas.
retryOptions

Opções que controlam como repetir pedidos falhados.
telemetryOptions

Opções para definir informações comuns de telemetria e rastreio para pedidos enviados.
tlsOptions

Opções para configurar a autenticação TLS
userAgentOptions

Opções para adicionar detalhes do agente de utilizador aos pedidos enviados.

Detalhes de Propriedade

apiVersion

Aviso

Esta API foi preterida.

use serviceVersion instead

A versão da API a utilizar ao comunicar com o serviço.

apiVersion?: string

Valor de Propriedade

string

audience

A Audiência a utilizar para autenticação com o Azure Active Directory (AAD). A audiência não é considerada ao utilizar uma chave partilhada. KnownSearchAudience pode ser utilizado alternadamente com o público

audience?: string

Valor de Propriedade

string

serviceVersion

A versão do serviço a utilizar ao comunicar com o serviço.

serviceVersion?: string

Valor de Propriedade

string

Detalhes da Propriedade Herdada

additionalPolicies

Políticas adicionais a incluir no pipeline HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Valor de Propriedade

AdditionalPolicyConfig[]

Herdado de ExtendedCommonClientOptions.additionalPolicies

allowInsecureConnection

Defina como verdadeiro se o pedido for enviado através de HTTP em vez de HTTPS

allowInsecureConnection?: boolean

Valor de Propriedade

boolean

Herdado de ExtendedCommonClientOptions.allowInsecureConnection

httpClient

O HttpClient que será utilizado para enviar pedidos HTTP.

httpClient?: HttpClient

Valor de Propriedade

HttpClient

Herdado de ExtendedCommonClientOptions.httpClient

keepAliveOptions

Opções para desativar manter-se vivo.

keepAliveOptions?: KeepAliveOptions

Valor de Propriedade

KeepAliveOptions

Herdado de ExtendedCommonClientOptions.keepAliveOptions

proxyOptions

Opções para configurar um proxy para pedidos de saída.

proxyOptions?: ProxySettings

Valor de Propriedade

ProxySettings

Herdado de ExtendedCommonClientOptions.proxyOptions

redirectOptions

Opções para a forma como as respostas de redirecionamento são processadas.

redirectOptions?: RedirectPolicyOptions & RedirectOptions

Valor de Propriedade

RedirectPolicyOptions & RedirectOptions

Herdado de ExtendedCommonClientOptions.redirectOptions

retryOptions

Opções que controlam como repetir pedidos falhados.

retryOptions?: PipelineRetryOptions

Valor de Propriedade

PipelineRetryOptions

Herdado de ExtendedCommonClientOptions.retryOptions

telemetryOptions

Opções para definir informações comuns de telemetria e rastreio para pedidos enviados.

telemetryOptions?: TelemetryOptions

Valor de Propriedade

TelemetryOptions

Herdado de ExtendedCommonClientOptions.telemetryOptions

tlsOptions

Opções para configurar a autenticação TLS

tlsOptions?: TlsSettings

Valor de Propriedade

TlsSettings

Herdado de ExtendedCommonClientOptions.tlsOptions

userAgentOptions

Opções para adicionar detalhes do agente de utilizador aos pedidos enviados.

userAgentOptions?: UserAgentPolicyOptions

Valor de Propriedade

UserAgentPolicyOptions

Herdado de ExtendedCommonClientOptions.userAgentOptions