KnowledgeRetrievalClientOptions interface

Paquete:

@azure/search-documents

Opciones de cliente que se usan para configurar las solicitudes de Cognitive Search API.

Extends

ClientOptions

Propiedades

audience	Audiencia que se va a usar para la autenticación con Azure Active Directory (AAD). La audiencia no se considera cuando se usa una clave compartida. KnownSearchAudience se puede usar indistintamente con la audiencia.
serviceVersion	La versión del servicio que se va a usar al comunicarse con el servicio.

Propiedades heredadas

additionalPolicies	Directivas adicionales que se van a incluir en la canalización HTTP.
agent	Opciones para configurar la instancia del agente para las solicitudes salientes
allowInsecureConnection	Opción para permitir la llamada a puntos de conexión http (no seguros)
apiVersion	Opciones para establecer una apiVersion personalizada.
baseUrl	Dirección URL base para el cliente
credentials	Información de credenciales
endpoint	Punto de conexión para el cliente
httpClient	Especifique un HttpClient personalizado al realizar solicitudes.
loggingOptions	Opciones para configurar el registro de solicitudes y respuestas.
pipeline	Pipeline para usar con el cliente. Si no se proporciona, se creará una tubería predeterminada usando las opciones proporcionadas. Úsalo con precaución: al configurar esta opción, se ignorarán todas las opciones del cliente que se usan en la creación de la pipeline predeterminada.
proxyOptions	Opciones para configurar un proxy para las solicitudes salientes.
redirectOptions	Opciones para controlar las respuestas de redirección.
retryOptions	Opciones que controlan cómo reintentar las solicitudes con errores.
telemetryOptions	Opciones para establecer información de seguimiento y telemetría comunes en las solicitudes salientes.
tlsOptions	Opciones para configurar la autenticación TLS
userAgentOptions	Opciones para agregar detalles del agente de usuario a las solicitudes salientes.

Detalles de las propiedades

audience

Audiencia que se va a usar para la autenticación con Azure Active Directory (AAD). La audiencia no se considera cuando se usa una clave compartida. KnownSearchAudience se puede usar indistintamente con la audiencia.

audience?: string

Valor de propiedad

string

serviceVersion

La versión del servicio que se va a usar al comunicarse con el servicio.

serviceVersion?: string

Valor de propiedad

string

Detalles de las propiedades heredadas

additionalPolicies

Directivas adicionales que se van a incluir en la canalización HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Valor de propiedad

AdditionalPolicyConfig[]

Heredado de ClientOptions.additionalPolicies

agent

Opciones para configurar la instancia del agente para las solicitudes salientes

agent?: Agent

Valor de propiedad

Agent

heredado de ClientOptions.agent

allowInsecureConnection

Opción para permitir la llamada a puntos de conexión http (no seguros)

allowInsecureConnection?: boolean

Valor de propiedad

boolean

Se hereda de ClientOptions.allowInsecureConnection

apiVersion

Opciones para establecer una apiVersion personalizada.

apiVersion?: string

Valor de propiedad

string

se hereda de ClientOptions.apiVersion

baseUrl

Advertencia

Esta API ya está en desuso.

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

Dirección URL base para el cliente

baseUrl?: string

Valor de propiedad

string

Heredado de ClientOptions.baseUrl

credentials

Información de credenciales

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

Valor de propiedad

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

Heredado de ClientOptions.credentials

endpoint

Punto de conexión para el cliente

endpoint?: string

Valor de propiedad

string

Heredado de ClientOptions.endpoint

httpClient

Especifique un HttpClient personalizado al realizar solicitudes.

httpClient?: HttpClient

Valor de propiedad

HttpClient

Heredado de ClientOptions.httpClient

loggingOptions

Opciones para configurar el registro de solicitudes y respuestas.

loggingOptions?: LogPolicyOptions

Valor de propiedad

LogPolicyOptions

heredado de ClientOptions.loggingOptions

pipeline

Pipeline para usar con el cliente. Si no se proporciona, se creará una tubería predeterminada usando las opciones proporcionadas. Úsalo con precaución: al configurar esta opción, se ignorarán todas las opciones del cliente que se usan en la creación de la pipeline predeterminada.

pipeline?: Pipeline

Valor de propiedad

Pipeline

Heredado de ClientOptions.pipeline

proxyOptions

Opciones para configurar un proxy para las solicitudes salientes.

proxyOptions?: ProxySettings

Valor de propiedad

ProxySettings

Heredado de ClientOptions.proxyOptions

redirectOptions

Opciones para controlar las respuestas de redirección.

redirectOptions?: RedirectPolicyOptions

Valor de propiedad

RedirectPolicyOptions

Heredado de ClientOptions.redirectOptions

retryOptions

Opciones que controlan cómo reintentar las solicitudes con errores.

retryOptions?: PipelineRetryOptions

Valor de propiedad

PipelineRetryOptions

Heredado de ClientOptions.retryOptions

telemetryOptions

Opciones para establecer información de seguimiento y telemetría comunes en las solicitudes salientes.

telemetryOptions?: TelemetryOptions

Valor de propiedad

TelemetryOptions

heredado de ClientOptions.telemetryOptions

tlsOptions

Opciones para configurar la autenticación TLS

tlsOptions?: TlsSettings

Valor de propiedad

TlsSettings

heredado de ClientOptions.tlsOptions

userAgentOptions

Opciones para agregar detalles del agente de usuario a las solicitudes salientes.

userAgentOptions?: UserAgentPolicyOptions

Valor de propiedad

UserAgentPolicyOptions

Heredado de ClientOptions.userAgentOptions