WebSearchClientOptions interface

包:

@azure/cognitiveservices-websearch

表示 WebSearchClientOptions 的接口。

扩展

ServiceClientOptions

属性

endpoint

支持的认知服务终结点（协议和主机名，例如：“https://westus.api.cognitive.microsoft.com"，”https://api.cognitive.microsoft.com")。 默认值：“https://api.cognitive.microsoft.com”。

继承属性

agentSettings	HTTP 和 HTTPS 代理，将用于每个 HTTP 请求（仅Node.js）。
baseUri	如果指定： 此 baseUri 将成为针对此 ServiceClient 发出请求的基本 URI。 如果 baseUri 与已知的资源管理器终结点匹配，并且 TokenCredential 是通过构造函数传递的，则此 baseUri 定义要 ${options.baseUri}/.default的 getToken 范围。 否则，范围将默认为“https://management.azure.com/.default"。 如果未指定： 所有 OperationSpecs 都必须包含 baseUrl 属性。 如果通过构造函数传递 TokenCredential，则 getToken 范围设置为“https://management.azure.com/.default"。
clientRequestIdHeaderName	如果指定，则 GenerateRequestIdPolicy 将添加到 HTTP 管道，该管道会将标头添加到具有此标头名称的所有传出请求，并将随机 UUID 作为请求 ID。
deserializationContentTypes	将与 JSON 或 XML 序列化关联的内容类型。
generateClientRequestIdHeader	是否为每个 HTTP 请求生成客户端请求 ID 标头。
httpClient	将用于发送 HTTP 请求的 HttpClient。
httpPipelineLogger	可用于调试 HTTP 管道中的 RequestPolicies 的 HttpPipelineLogger。
noRetryPolicy	如果设置为 true，请关闭默认重试策略。
proxySettings	将用于每个 HTTP 请求的代理设置（仅Node.js）。
redirectOptions	有关如何处理重定向响应的选项。
requestPolicyFactories	调用的工厂数组，用于创建用于在网络上发送 HTTP 请求的 RequestPolicy 管道，或采用 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

支持的认知服务终结点（协议和主机名，例如：“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 将成为针对此 ServiceClient 发出请求的基本 URI。
• 如果 baseUri 与已知的资源管理器终结点匹配，并且 TokenCredential 是通过构造函数传递的，则此 baseUri 定义要 ${options.baseUri}/.default的 getToken 范围。 否则，范围将默认为“https://management.azure.com/.default"。

如果未指定：

• 所有 OperationSpecs 都必须包含 baseUrl 属性。
• 如果通过构造函数传递 TokenCredential，则 getToken 范围设置为“https://management.azure.com/.default"。

baseUri?: string

属性值

string

继承自 ServiceClientOptions.baseUri

clientRequestIdHeaderName

如果指定，则 GenerateRequestIdPolicy 将添加到 HTTP 管道，该管道会将标头添加到具有此标头名称的所有传出请求，并将随机 UUID 作为请求 ID。

clientRequestIdHeaderName?: string

属性值

string

继承自 ServiceClientOptions.clientRequestIdHeaderName

deserializationContentTypes

将与 JSON 或 XML 序列化关联的内容类型。

deserializationContentTypes?: DeserializationContentTypes

属性值

DeserializationContentTypes

继承自 ServiceClientOptions.deserializationContentTypes

generateClientRequestIdHeader

是否为每个 HTTP 请求生成客户端请求 ID 标头。

generateClientRequestIdHeader?: boolean

属性值

boolean

继承自 ServiceClientOptions.generateClientRequestIdHeader

httpClient

将用于发送 HTTP 请求的 HttpClient。

httpClient?: HttpClient

属性值

HttpClient

继承自 ServiceClientOptions.httpClient

httpPipelineLogger

可用于调试 HTTP 管道中的 RequestPolicies 的 HttpPipelineLogger。

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

调用的工厂数组，用于创建用于在网络上发送 HTTP 请求的 RequestPolicy 管道，或采用 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