Поделиться через

WebSearchClientOptions interface

  • Ссылка
Пакет:
@azure/cognitiveservices-websearch

Интерфейс, представляющий WebSearchClientOptions.

Extends
ServiceClientOptions

Свойства

endpoint

Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например"https://westus.api.cognitive.microsoft.com" ;, "https://api.cognitive.microsoft.com"). Значение по умолчанию: "https://api.cognitive.microsoft.com".

Унаследованные свойства

agentSettings

Агенты HTTP и HTTPS, которые будут использоваться для каждого HTTP-запроса (только Node.js).
baseUri

Если указано:

  • Он baseUri становится базовым универсальным кодом ресурса (URI), к которому будут выполняться запросы для этого объекта ServiceClient.
  • baseUri Если соответствует известной конечной точке Resource Manager и если TokenCredential объект был передан через конструктор, определяет baseUrigetToken область как ${options.baseUri}/.default. В противном случае область по умолчанию будет "https://management.azure.com/.default".

Если он не указан, выполните указанные действия.

  • Все operationSpecs должны содержать свойство baseUrl.
  • TokenCredential Если объект был передан через конструктор, getToken для области устанавливается значение "https://management.azure.com/.default".
clientRequestIdHeaderName

Если этот параметр указан, в конвейер HTTP будет добавлен параметр GenerateRequestIdPolicy, который добавит заголовок ко всем исходящим запросам с этим именем заголовка и случайным UUID в качестве идентификатора запроса.
deserializationContentTypes

Типы содержимого, которые будут связаны с сериализацией JSON или XML.
generateClientRequestIdHeader

Следует ли создавать заголовок идентификатора клиентского запроса для каждого HTTP-запроса.
httpClient

HttpClient, который будет использоваться для отправки HTTP-запросов.
httpPipelineLogger

HttpPipelineLogger, который можно использовать для отладки RequestPolicies в конвейере HTTP.
noRetryPolicy

Если задано значение true, отключите политику повторных попыток по умолчанию.
proxySettings

Параметры прокси-сервера, которые будут использоваться для каждого HTTP-запроса (только Node.js).
redirectOptions

Параметры обработки ответов перенаправления.
requestPolicyFactories

Массив фабрик, которые вызываются для создания конвейера RequestPolicy, используемого для отправки HTTP-запроса по сети, или функция, которая принимает defaultRequestPolicyFactories и возвращает используемые объекты requestPolicyFactories.
rpRegistrationRetryTimeout

Возвращает или задает время ожидания повтора в секундах для AutomaticRPRegistration. Значение по умолчанию — 30.
userAgent

Строка, которая должна быть задана в заголовке телеметрии при отправке запроса, или функция, которая принимает строку агента пользователя по умолчанию и возвращает используемую строку агента пользователя.
userAgentHeaderName

Имя заголовка, используемого для заголовка телеметрии при отправке запроса. Если этот параметр не указан, при выполнении в Node.js будет использоваться user-agent, а при запуске в браузере — x-ms-command-name.
withCredentials

Следует ли включать учетные данные в запросы CORS в браузере. Подробнее см. в разделе https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials.

Сведения о свойстве

endpoint

Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например"https://westus.api.cognitive.microsoft.com" ;, "https://api.cognitive.microsoft.com"). Значение по умолчанию: "https://api.cognitive.microsoft.com".

endpoint?: string

Значение свойства

string

Сведения об унаследованном свойстве

agentSettings

Агенты HTTP и HTTPS, которые будут использоваться для каждого HTTP-запроса (только Node.js).

agentSettings?: AgentSettings

Значение свойства

AgentSettings

Наследуется от ServiceClientOptions.agentSettings

baseUri

Если указано:

  • Он baseUri становится базовым универсальным кодом ресурса (URI), к которому будут выполняться запросы для этого объекта ServiceClient.
  • baseUri Если соответствует известной конечной точке Resource Manager и если TokenCredential объект был передан через конструктор, определяет baseUrigetToken область как ${options.baseUri}/.default. В противном случае область по умолчанию будет "https://management.azure.com/.default".

Если он не указан, выполните указанные действия.

  • Все operationSpecs должны содержать свойство baseUrl.
  • TokenCredential Если объект был передан через конструктор, getToken для области устанавливается значение "https://management.azure.com/.default".
baseUri?: string

Значение свойства

string

Наследуется от ServiceClientOptions.baseUri

clientRequestIdHeaderName

Если этот параметр указан, в конвейер HTTP будет добавлен параметр GenerateRequestIdPolicy, который добавит заголовок ко всем исходящим запросам с этим именем заголовка и случайным UUID в качестве идентификатора запроса.

clientRequestIdHeaderName?: string

Значение свойства

string

Наследуется от ServiceClientOptions.clientRequestIdHeaderName

deserializationContentTypes

Типы содержимого, которые будут связаны с сериализацией JSON или XML.

deserializationContentTypes?: DeserializationContentTypes

Значение свойства

DeserializationContentTypes

Наследуется от ServiceClientOptions.deserializationContentTypes

generateClientRequestIdHeader

Следует ли создавать заголовок идентификатора клиентского запроса для каждого HTTP-запроса.

generateClientRequestIdHeader?: boolean

Значение свойства

boolean

Наследуется от ServiceClientOptions.generateClientRequestIdHeader

httpClient

HttpClient, который будет использоваться для отправки HTTP-запросов.

httpClient?: HttpClient

Значение свойства

HttpClient

Наследуется от ServiceClientOptions.httpClient

httpPipelineLogger

HttpPipelineLogger, который можно использовать для отладки RequestPolicies в конвейере HTTP.

httpPipelineLogger?: HttpPipelineLogger

Значение свойства

HttpPipelineLogger

Наследуется от ServiceClientOptions.httpPipelineLogger

noRetryPolicy

Если задано значение true, отключите политику повторных попыток по умолчанию.

noRetryPolicy?: boolean

Значение свойства

boolean

Наследуется от ServiceClientOptions.noRetryPolicy

proxySettings

Параметры прокси-сервера, которые будут использоваться для каждого HTTP-запроса (только Node.js).

proxySettings?: ProxySettings

Значение свойства

ProxySettings

Наследуется от ServiceClientOptions.proxySettings

redirectOptions

Параметры обработки ответов перенаправления.

redirectOptions?: RedirectOptions

Значение свойства

RedirectOptions

Наследуется от ServiceClientOptions.redirectOptions

requestPolicyFactories

Массив фабрик, которые вызываются для создания конвейера RequestPolicy, используемого для отправки HTTP-запроса по сети, или функция, которая принимает defaultRequestPolicyFactories и возвращает используемые объекты requestPolicyFactories.

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

Значение свойства

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

Наследуется от ServiceClientOptions.requestPolicyFactories

rpRegistrationRetryTimeout

Возвращает или задает время ожидания повтора в секундах для AutomaticRPRegistration. Значение по умолчанию — 30.

rpRegistrationRetryTimeout?: number

Значение свойства

number

Наследуется от ServiceClientOptions.rpRegistrationRetryTimeout

userAgent

Строка, которая должна быть задана в заголовке телеметрии при отправке запроса, или функция, которая принимает строку агента пользователя по умолчанию и возвращает используемую строку агента пользователя.

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

Значение свойства

string | (defaultUserAgent: string) => string

Наследуется от ServiceClientOptions.userAgent

userAgentHeaderName

Имя заголовка, используемого для заголовка телеметрии при отправке запроса. Если этот параметр не указан, при выполнении в Node.js будет использоваться user-agent, а при запуске в браузере — x-ms-command-name.

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

Значение свойства

string | (defaultUserAgentHeaderName: string) => string

Наследуется от ServiceClientOptions.userAgentHeaderName

withCredentials

Следует ли включать учетные данные в запросы CORS в браузере. Подробнее см. в разделе https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials.

withCredentials?: boolean

Значение свойства

boolean

Наследуется от ServiceClientOptions.withCredentials