Partilhar via

WebSearchClientOptions interface

  • Referência
Pacote:
@azure/cognitiveservices-websearch

Uma interface que representa WebSearchClientOptions.

Extends
ServiceClientOptions

Propriedades

endpoint

Pontos finais dos Serviços Cognitivos suportados (protocolo e nome do anfitrião, por exemplo: "https://westus.api.cognitive.microsoft.com", "https://api.cognitive.microsoft.com"). Valor predefinido: "https://api.cognitive.microsoft.com".

Propriedades Herdadas

agentSettings

Agentes HTTP e HTTPS que serão utilizados para cada pedido HTTP (apenas Node.js).
baseUri

Se especificado:

  • Isto baseUri torna-se o URI base em que os pedidos serão feitos relativamente a este ServiceClient.
  • Se o corresponder a baseUri um ponto final conhecido do gestor de recursos e se um TokenCredential tiver sido transmitido através do construtor, isto baseUri define o getToken âmbito como ${options.baseUri}/.default. Caso contrário, o âmbito seria predefinido para "https://management.azure.com/.default".

Se não for especificado:

  • Todas as OperationSpecs têm de conter uma propriedade baseUrl.
  • Se um TokenCredential foi transmitido através do construtor, o getToken âmbito está definido como "https://management.azure.com/.default".
clientRequestIdHeaderName

Se especificado, será adicionado um GenerateRequestIdPolicy ao pipeline HTTP que irá adicionar um cabeçalho a todos os pedidos de saída com este nome de cabeçalho e um UUID aleatório como o ID do pedido.
deserializationContentTypes

Os tipos de conteúdo que serão associados à serialização JSON ou XML.
generateClientRequestIdHeader

Quer gere ou não um cabeçalho de ID de pedido de cliente para cada pedido HTTP.
httpClient

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

O HttpPipelineLogger que pode ser utilizado para depurar RequestPolicies no pipeline HTTP.
noRetryPolicy

Se estiver definido como verdadeiro, desative a política de repetição predefinida.
proxySettings

Definições de proxy que serão utilizadas para cada pedido HTTP (apenas Node.js).
redirectOptions

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

Uma matriz de fábricas que são chamadas para criar o pipeline RequestPolicy utilizado para enviar um pedido HTTP no fio ou uma função que recebe a predefiniçãoRequestPolicyFactories e devolve o pedidoPolicyFactories que será utilizado.
rpRegistrationRetryTimeout

Obtém ou define o tempo limite de repetição em segundos para AutomaticRPRegistration. O valor predefinido é 30.
userAgent

A cadeia a ser definida para o cabeçalho de telemetria ao enviar o pedido ou uma função que utiliza a cadeia de agente de utilizador predefinida e devolve a cadeia de agente de utilizador que será utilizada.
userAgentHeaderName

O nome do cabeçalho a utilizar para o cabeçalho de telemetria ao enviar o pedido. Se isto não for especificado, será utilizado "User-Agent" quando estiver em execução no Node.js e será utilizado "x-ms-command-name" quando estiver em execução num browser.
withCredentials

Se pretende incluir credenciais em pedidos CORS no browser. Consulte https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials para obter mais informações.

Detalhes de Propriedade

endpoint

Pontos finais dos Serviços Cognitivos suportados (protocolo e nome do anfitrião, por exemplo: "https://westus.api.cognitive.microsoft.com", "https://api.cognitive.microsoft.com"). Valor predefinido: "https://api.cognitive.microsoft.com".

endpoint?: string

Valor de Propriedade

string

Detalhes da Propriedade Herdada

agentSettings

Agentes HTTP e HTTPS que serão utilizados para cada pedido HTTP (apenas Node.js).

agentSettings?: AgentSettings

Valor de Propriedade

AgentSettings

Herdado de ServiceClientOptions.agentSettings

baseUri

Se especificado:

  • Isto baseUri torna-se o URI base em que os pedidos serão feitos relativamente a este ServiceClient.
  • Se o corresponder a baseUri um ponto final conhecido do gestor de recursos e se um TokenCredential tiver sido transmitido através do construtor, isto baseUri define o getToken âmbito como ${options.baseUri}/.default. Caso contrário, o âmbito seria predefinido para "https://management.azure.com/.default".

Se não for especificado:

  • Todas as OperationSpecs têm de conter uma propriedade baseUrl.
  • Se um TokenCredential foi transmitido através do construtor, o getToken âmbito está definido como "https://management.azure.com/.default".
baseUri?: string

Valor de Propriedade

string

Herdado de ServiceClientOptions.baseUri

clientRequestIdHeaderName

Se especificado, será adicionado um GenerateRequestIdPolicy ao pipeline HTTP que irá adicionar um cabeçalho a todos os pedidos de saída com este nome de cabeçalho e um UUID aleatório como o ID do pedido.

clientRequestIdHeaderName?: string

Valor de Propriedade

string

Herdado de ServiceClientOptions.clientRequestIdHeaderName

deserializationContentTypes

Os tipos de conteúdo que serão associados à serialização JSON ou XML.

deserializationContentTypes?: DeserializationContentTypes

Valor de Propriedade

DeserializationContentTypes

Herdado de ServiceClientOptions.deserializationContentTypes

generateClientRequestIdHeader

Quer gere ou não um cabeçalho de ID de pedido de cliente para cada pedido HTTP.

generateClientRequestIdHeader?: boolean

Valor de Propriedade

boolean

Herdado de ServiceClientOptions.generateClientRequestIdHeader

httpClient

O HttpClient que será utilizado para enviar pedidos HTTP.

httpClient?: HttpClient

Valor de Propriedade

HttpClient

Herdado de ServiceClientOptions.httpClient

httpPipelineLogger

O HttpPipelineLogger que pode ser utilizado para depurar RequestPolicies no pipeline HTTP.

httpPipelineLogger?: HttpPipelineLogger

Valor de Propriedade

HttpPipelineLogger

Herdado de ServiceClientOptions.httpPipelineLogger

noRetryPolicy

Se estiver definido como verdadeiro, desative a política de repetição predefinida.

noRetryPolicy?: boolean

Valor de Propriedade

boolean

Herdado de ServiceClientOptions.noRetryPolicy

proxySettings

Definições de proxy que serão utilizadas para cada pedido HTTP (apenas Node.js).

proxySettings?: ProxySettings

Valor de Propriedade

ProxySettings

Herdado de ServiceClientOptions.proxySettings

redirectOptions

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

redirectOptions?: RedirectOptions

Valor de Propriedade

RedirectOptions

Herdado de ServiceClientOptions.redirectOptions

requestPolicyFactories

Uma matriz de fábricas que são chamadas para criar o pipeline RequestPolicy utilizado para enviar um pedido HTTP no fio ou uma função que recebe a predefiniçãoRequestPolicyFactories e devolve o pedidoPolicyFactories que será utilizado.

requestPolicyFactories?: RequestPolicyFactory[] | (defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | RequestPolicyFactory[]

Valor de Propriedade

RequestPolicyFactory[] | (defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | RequestPolicyFactory[]

Herdado de ServiceClientOptions.requestPolicyFactories

rpRegistrationRetryTimeout

Obtém ou define o tempo limite de repetição em segundos para AutomaticRPRegistration. O valor predefinido é 30.

rpRegistrationRetryTimeout?: number

Valor de Propriedade

number

Herdado de ServiceClientOptions.rpRegistrationRetryTimeout

userAgent

A cadeia a ser definida para o cabeçalho de telemetria ao enviar o pedido ou uma função que utiliza a cadeia de agente de utilizador predefinida e devolve a cadeia de agente de utilizador que será utilizada.

userAgent?: string | (defaultUserAgent: string) => string

Valor de Propriedade

string | (defaultUserAgent: string) => string

Herdado de ServiceClientOptions.userAgent

userAgentHeaderName

O nome do cabeçalho a utilizar para o cabeçalho de telemetria ao enviar o pedido. Se isto não for especificado, será utilizado "User-Agent" quando estiver em execução no Node.js e será utilizado "x-ms-command-name" quando estiver em execução num browser.

userAgentHeaderName?: string | (defaultUserAgentHeaderName: string) => string

Valor de Propriedade

string | (defaultUserAgentHeaderName: string) => string

Herdado de ServiceClientOptions.userAgentHeaderName

withCredentials

Se pretende incluir credenciais em pedidos CORS no browser. Consulte https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials para obter mais informações.

withCredentials?: boolean

Valor de Propriedade

boolean

Herdado de ServiceClientOptions.withCredentials