你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

SpellCheckClientSpellCheckerOptionalParams interface

包:

@azure/cognitiveservices-spellcheck

可选参数。

Extends

RequestOptionsBase

属性

acceptLanguage	用于用户界面字符串的一种或多种语言的逗号分隔列表。 此列表以降序方式显示首选项。 有关其他信息（包括预期格式），请参阅 RFC2616。 此标头和 setLang 查询参数互斥;不要同时指定这两者。 如果设置此标头，则还必须指定 cc 查询参数。 必应将使用它从列表中找到的第一种受支持的语言，并将该语言与 cc 参数值组合在一起，以确定返回结果的市场。 如果列表不包含支持的语言，必应将找到支持请求的最近语言和市场，并且可能会对结果使用聚合市场或默认市场，而不是指定的市场。 仅当指定多种语言时，才应使用此标头和 cc 查询参数;否则，应使用 mkt 和 setLang 查询参数。 用户界面字符串是用作用户界面中标签的字符串。 JSON 响应对象中的用户界面字符串很少。 响应对象中指向 Bing.com 属性的任何链接都将应用指定的语言。
actionType	日志记录使用的字符串，用于确定请求来自交互式会话还是页面加载。 下面是可能的值。 1) 编辑 — 请求来自交互式会话 2) 加载 — 请求来自页面加载。 可能的值包括：“Edit”、“Load”
appName	应用的唯一名称。 必应必须知道该名称。 除非之前联系过必应以获取唯一的应用名称，否则不要包含此参数。 若要获取唯一名称，请联系必应业务开发经理。
clientId	必应使用此标头跨必应 API 调用为用户提供一致的行为。 必应通常会发布新功能和改进，并将客户端 ID 用作密钥以在不同航班上分配客流量。 如果未跨多个请求将相同的客户端 ID 用于用户，则必应可能将用户分配给多个冲突的航班。 分配给多个冲突航班可能导致用户体验不一致。 例如，如果第二个请求与第一个请求的航班分配不同，体验可能会出现意外。 此外，必应可以使用客户端 ID 根据客户端 ID 搜索历史记录来定制 Web 结果，为用户提供更丰富的体验。 通过分析由客户端 ID 生成的活动，必应还会使用此标头来提高结果排名。 相关改进有助于提高必应 API 交付的结果质量，从而提高 API 客户的点击率。 重要提示：尽管是可选的，但应将此标头视为必选。 对于同一最终用户和设备组合，如果跨多个请求保留客户端 ID，则 1) API 客户可以获取一致的用户体验；2) 可通过必应 API 提高结果质量，从而提高点击率。 在设备上使用你的应用程序的每个用户必须具有必应生成的唯一客户端 ID。 如果未在请求中包含此标头，必应会生成 ID，然后在 X-MSEdge-ClientID 响应标头中将其返回。 仅当用户首次在设备上使用应用时，才不可以在请求中包含此标头。 针对应用为设备上的此用户生成的每个必应 API 请求，使用客户端 ID。 保留客户端 ID。 若要在浏览器应用中保留 ID，请使用持久性 HTTP Cookie 来确保所有会话均使用此 ID。 请勿使用会话 Cookie。 对于移动应用等其他应用，请使用设备的持久存储来保留 ID。 下次用户在该设备上使用你的应用时，会获取保留的客户端 ID。 必应响应不一定包含此标头。 如果响应包含此标头，请针对该设备上的用户捕获客户端 ID 并将其用于所有后续必应请求。 如果包含 X-MSEdge-ClientID，不可在请求中包含 Cookie。
clientIp	客户端设备的 IPv4 或 IPv6 地址。 IP 地址用于发现用户的位置。 必应使用位置信息来确定安全搜索行为。 尽管是可选的，但还是建议始终指定此标头和 X-Search-Location 标头。 不要混淆地址（例如，通过将最后一个八位字节更改为 0 来混淆地址）。 混淆地址会导致位置未处于设备实际位置附近，这可能导致必应提供错误的结果。
clientMachineName	发出请求的设备的唯一名称。 为每个设备生成唯一值， (该值) 不重要。 该服务使用 ID 来帮助调试问题并提高更正质量。
countryCode	结果来源的国家/地区的 2 个字符国家/地区代码。 此 API 仅支持美国市场。 如果指定此查询参数，则必须将其设置为我们。 如果设置此参数，则还必须指定 Accept-language 标头。 必应使用从语言列表中找到的第一种受支持的语言，并将该语言与指定的国家/地区代码组合在一起，以确定要为其返回结果的市场。 如果语言列表不包括受支持的语言，必应会查找支持该请求的最接近的语言和市场，或者它可能会对结果使用聚合市场或默认市场，而不是使用指定的市场。 仅当指定多种语言时，才应使用此查询参数和Accept-Language查询参数;否则，应使用 mkt 和 setLang 查询参数。 此参数和 mkt 查询参数相互排斥，不可同时指定两者。
docId	标识文本所属文档的唯一 ID。 为每个文档生成唯一值， (该值) 不重要。 该服务使用 ID 来帮助调试问题并提高更正质量。
location	以分号分隔的键/值对列表，描述客户端的地理位置。 必应使用位置信息来确定安全搜索行为并返回相关的本地内容。 以 : 形式指定键/值对。 下面是用于指定用户位置的键。 lat (所需的) ：客户端位置的纬度（以度为单位）。 纬度必须大于或等于 -90.0 且小于或等于 +90.0。 负值表示南纬，正值表示北纬。 long (必需) ：客户端位置的经度（以度为单位）。 经度必须大于或等于 -180.0 且小于或等于 +180.0。 负值表示西经，正值表示东经。 re (所需的) ：半径（以米为单位），指定坐标的水平精度。 传递设备定位服务返回的值。 典型的值可能是：22m - GPS/Wi-Fi、380m - 蜂窝基站三角网定位、18,000m - 反向 IP 查询。 ts (可选) ：客户端位于该位置时的 UTC UNIX 时间戳。 (UNIX 时间戳是自 1970 年 1 月 1 日以来的秒数。) 头 (可选) ：客户端的相对航向或行驶方向。 以度数指定旅行方向（从 0 到 360），相对于正北方向顺时针计数。 仅当 sp 键为非零时，才指定此键。 sp (可选) ：客户端设备正在行驶的水平速度 (速度) （以米/秒为单位）。 alt (可选) ：客户端设备的高度（以米为单位）。 (可选) ：半径（以米为单位），指定坐标的垂直精度。 仅当指定 alt 键时，才指定此键。 尽管许多键是可选的，但提供的信息越多，位置结果越精确。 尽管是可选的，但还是建议始终指定用户的地理位置。 如果客户端的 IP 地址未准确反映用户的物理位置（例如，如果客户端使用 VPN），则提供位置尤其重要。 为了获得最佳结果，应包含此标头和 X-Search-ClientIP 标头，但至少应包含此标头。
market	产生结果的市场。 强烈建议您始终指定市场（如果已知）。 指定市场有助于必应路由请求，并返回适当的最佳响应。 此参数和 cc 查询参数相互排斥，不可同时指定两者。
mode	要执行的拼写和语法检查的类型。 以下是 (值不区分大小写) 的可能值。 默认值为 Proof。 1) 证明 - 查找大多数拼写和语法错误。 2) 拼写 - 查找大多数拼写错误，但找不到 Proof 捕获的一些语法错误 (例如，大写和重复单词) 。 可能的值包括：“proof”、“spell”
postContextText	为文本字符串提供上下文的字符串。 例如，读取的文本字符串有效。 但是，如果将 postContextText 设置为 carpet，则上下文将更改，并且文本字符串将变为无效。 在这种情况下，API 建议将读取更改为红色 (，如红地毯) 所示。 不会检查此文本是否存在语法或拼写错误。 文本字符串、preContextText 字符串和 postContextText 字符串的组合长度不能超过 10，000 个字符。 可以在 GET 请求的查询字符串或 POST 请求的正文中指定此参数。
pragma	默认情况下，必应返回缓存的内容（如果适用）。 若要防止必应返回缓存的内容，请将 Pragma 标头设置为 no-cache（例如，Pragma: no-cache）。
preContextText	为文本字符串提供上下文的字符串。 例如，文本字符串花瓣有效。 但是，如果将 preContextText 设置为 bike，上下文将更改，文本字符串将变为无效。 在这种情况下，API 建议将花瓣更改为踏板 (，就像在自行车踏板) 中一样。 不会检查此文本是否存在语法或拼写错误。 文本字符串、preContextText 字符串和 postContextText 字符串的组合长度不能超过 10，000 个字符。 可以在 GET 请求的查询字符串或 POST 请求的正文中指定此参数。
sessionId	标识此用户会话的唯一 ID。 为每个用户会话生成唯一值， (该值不重要) 。 该服务使用该 ID 来帮助调试问题并提高更正质量
setLang	可用于用户界面字符串的语言。 使用 ISO 639-1 2 字母语言代码指定语言。 例如，英语的语言代码是 EN。 默认为 EN（英语）。 尽管是可选项，但应始终指定语言。 通常，将 setLang 设置为 mkt 指定的相同语言，除非用户希望用户界面字符串以其他语言显示。 此参数和 Accept-Language 标头相互排斥，不可同时指定两者。 用户界面字符串是用作用户界面中标签的字符串。 JSON 响应对象中有几个用户界面字符串。 此外，响应对象中 Bing.com 属性的任何链接均会应用指定的语言。
userAgent	发出请求的用户代理。 必应使用用户代理为移动用户提供优化体验。 尽管是可选的，但强烈建议始终指定此标头。 用户代理应与任何常用浏览器发送的字符串相同。 有关用户代理的信息，请参阅 RFC 2616。
userId	标识用户的唯一 ID。 为每个用户生成唯一值， (该值不重要) 。 该服务使用 ID 来帮助调试问题并提高更正质量。

继承属性

abortSignal	可用于中止请求的信号。
customHeaders	用户定义的自定义请求标头，将在发送请求之前应用这些标头。
onDownloadProgress	下载进度时触发的回调。
onUploadProgress	上传进度时触发的回调。
timeout	请求在自动终止之前可以花费的毫秒数。

属性详细信息

acceptLanguage

用于用户界面字符串的一种或多种语言的逗号分隔列表。 此列表以降序方式显示首选项。 有关其他信息（包括预期格式），请参阅 RFC2616。 此标头和 setLang 查询参数互斥;不要同时指定这两者。 如果设置此标头，则还必须指定 cc 查询参数。 必应将使用它从列表中找到的第一种受支持的语言，并将该语言与 cc 参数值组合在一起，以确定返回结果的市场。 如果列表不包含支持的语言，必应将找到支持请求的最近语言和市场，并且可能会对结果使用聚合市场或默认市场，而不是指定的市场。 仅当指定多种语言时，才应使用此标头和 cc 查询参数;否则，应使用 mkt 和 setLang 查询参数。 用户界面字符串是用作用户界面中标签的字符串。 JSON 响应对象中的用户界面字符串很少。 响应对象中指向 Bing.com 属性的任何链接都将应用指定的语言。

acceptLanguage?: string

属性值

string

actionType

日志记录使用的字符串，用于确定请求来自交互式会话还是页面加载。 下面是可能的值。 1) 编辑 — 请求来自交互式会话 2) 加载 — 请求来自页面加载。 可能的值包括：“Edit”、“Load”

actionType?: ActionType

属性值

ActionType

appName

应用的唯一名称。 必应必须知道该名称。 除非之前联系过必应以获取唯一的应用名称，否则不要包含此参数。 若要获取唯一名称，请联系必应业务开发经理。

appName?: string

属性值

string

clientId

必应使用此标头跨必应 API 调用为用户提供一致的行为。 必应通常会发布新功能和改进，并将客户端 ID 用作密钥以在不同航班上分配客流量。 如果未跨多个请求将相同的客户端 ID 用于用户，则必应可能将用户分配给多个冲突的航班。 分配给多个冲突航班可能导致用户体验不一致。 例如，如果第二个请求与第一个请求的航班分配不同，体验可能会出现意外。 此外，必应可以使用客户端 ID 根据客户端 ID 搜索历史记录来定制 Web 结果，为用户提供更丰富的体验。 通过分析由客户端 ID 生成的活动，必应还会使用此标头来提高结果排名。 相关改进有助于提高必应 API 交付的结果质量，从而提高 API 客户的点击率。 重要提示：尽管是可选的，但应将此标头视为必选。 对于同一最终用户和设备组合，如果跨多个请求保留客户端 ID，则 1) API 客户可以获取一致的用户体验；2) 可通过必应 API 提高结果质量，从而提高点击率。 在设备上使用你的应用程序的每个用户必须具有必应生成的唯一客户端 ID。 如果未在请求中包含此标头，必应会生成 ID，然后在 X-MSEdge-ClientID 响应标头中将其返回。 仅当用户首次在设备上使用应用时，才不可以在请求中包含此标头。 针对应用为设备上的此用户生成的每个必应 API 请求，使用客户端 ID。 保留客户端 ID。 若要在浏览器应用中保留 ID，请使用持久性 HTTP Cookie 来确保所有会话均使用此 ID。 请勿使用会话 Cookie。 对于移动应用等其他应用，请使用设备的持久存储来保留 ID。 下次用户在该设备上使用你的应用时，会获取保留的客户端 ID。 必应响应不一定包含此标头。 如果响应包含此标头，请针对该设备上的用户捕获客户端 ID 并将其用于所有后续必应请求。 如果包含 X-MSEdge-ClientID，不可在请求中包含 Cookie。

clientId?: string

属性值

string

clientIp

客户端设备的 IPv4 或 IPv6 地址。 IP 地址用于发现用户的位置。 必应使用位置信息来确定安全搜索行为。 尽管是可选的，但还是建议始终指定此标头和 X-Search-Location 标头。 不要混淆地址（例如，通过将最后一个八位字节更改为 0 来混淆地址）。 混淆地址会导致位置未处于设备实际位置附近，这可能导致必应提供错误的结果。

clientIp?: string

属性值

string

clientMachineName

发出请求的设备的唯一名称。 为每个设备生成唯一值， (该值) 不重要。 该服务使用 ID 来帮助调试问题并提高更正质量。

clientMachineName?: string

属性值

string

countryCode

结果来源的国家/地区的 2 个字符国家/地区代码。 此 API 仅支持美国市场。 如果指定此查询参数，则必须将其设置为我们。 如果设置此参数，则还必须指定 Accept-language 标头。 必应使用从语言列表中找到的第一种受支持的语言，并将该语言与指定的国家/地区代码组合在一起，以确定要为其返回结果的市场。 如果语言列表不包括受支持的语言，必应会查找支持该请求的最接近的语言和市场，或者它可能会对结果使用聚合市场或默认市场，而不是使用指定的市场。 仅当指定多种语言时，才应使用此查询参数和Accept-Language查询参数;否则，应使用 mkt 和 setLang 查询参数。 此参数和 mkt 查询参数相互排斥，不可同时指定两者。

countryCode?: string

属性值

string

docId

标识文本所属文档的唯一 ID。 为每个文档生成唯一值， (该值) 不重要。 该服务使用 ID 来帮助调试问题并提高更正质量。

docId?: string

属性值

string

location

以分号分隔的键/值对列表，描述客户端的地理位置。 必应使用位置信息来确定安全搜索行为并返回相关的本地内容。 以 : 形式指定键/值对。 下面是用于指定用户位置的键。 lat (所需的) ：客户端位置的纬度（以度为单位）。 纬度必须大于或等于 -90.0 且小于或等于 +90.0。 负值表示南纬，正值表示北纬。 long (必需) ：客户端位置的经度（以度为单位）。 经度必须大于或等于 -180.0 且小于或等于 +180.0。 负值表示西经，正值表示东经。 re (所需的) ：半径（以米为单位），指定坐标的水平精度。 传递设备定位服务返回的值。 典型的值可能是：22m - GPS/Wi-Fi、380m - 蜂窝基站三角网定位、18,000m - 反向 IP 查询。 ts (可选) ：客户端位于该位置时的 UTC UNIX 时间戳。 (UNIX 时间戳是自 1970 年 1 月 1 日以来的秒数。) 头 (可选) ：客户端的相对航向或行驶方向。 以度数指定旅行方向（从 0 到 360），相对于正北方向顺时针计数。 仅当 sp 键为非零时，才指定此键。 sp (可选) ：客户端设备正在行驶的水平速度 (速度) （以米/秒为单位）。 alt (可选) ：客户端设备的高度（以米为单位）。 (可选) ：半径（以米为单位），指定坐标的垂直精度。 仅当指定 alt 键时，才指定此键。 尽管许多键是可选的，但提供的信息越多，位置结果越精确。 尽管是可选的，但还是建议始终指定用户的地理位置。 如果客户端的 IP 地址未准确反映用户的物理位置（例如，如果客户端使用 VPN），则提供位置尤其重要。 为了获得最佳结果，应包含此标头和 X-Search-ClientIP 标头，但至少应包含此标头。

location?: string

属性值

string

market

产生结果的市场。 强烈建议您始终指定市场（如果已知）。 指定市场有助于必应路由请求，并返回适当的最佳响应。 此参数和 cc 查询参数相互排斥，不可同时指定两者。

market?: string

属性值

string

mode

要执行的拼写和语法检查的类型。 以下是 (值不区分大小写) 的可能值。 默认值为 Proof。 1) 证明 - 查找大多数拼写和语法错误。 2) 拼写 - 查找大多数拼写错误，但找不到 Proof 捕获的一些语法错误 (例如，大写和重复单词) 。 可能的值包括：“proof”、“spell”

mode?: Mode

属性值

Mode

postContextText

为文本字符串提供上下文的字符串。 例如，读取的文本字符串有效。 但是，如果将 postContextText 设置为 carpet，则上下文将更改，并且文本字符串将变为无效。 在这种情况下，API 建议将读取更改为红色 (，如红地毯) 所示。 不会检查此文本是否存在语法或拼写错误。 文本字符串、preContextText 字符串和 postContextText 字符串的组合长度不能超过 10，000 个字符。 可以在 GET 请求的查询字符串或 POST 请求的正文中指定此参数。

postContextText?: string

属性值

string

pragma

默认情况下，必应返回缓存的内容（如果适用）。 若要防止必应返回缓存的内容，请将 Pragma 标头设置为 no-cache（例如，Pragma: no-cache）。

pragma?: string

属性值

string

preContextText

为文本字符串提供上下文的字符串。 例如，文本字符串花瓣有效。 但是，如果将 preContextText 设置为 bike，上下文将更改，文本字符串将变为无效。 在这种情况下，API 建议将花瓣更改为踏板 (，就像在自行车踏板) 中一样。 不会检查此文本是否存在语法或拼写错误。 文本字符串、preContextText 字符串和 postContextText 字符串的组合长度不能超过 10，000 个字符。 可以在 GET 请求的查询字符串或 POST 请求的正文中指定此参数。

preContextText?: string

属性值

string

sessionId

标识此用户会话的唯一 ID。 为每个用户会话生成唯一值， (该值不重要) 。 该服务使用该 ID 来帮助调试问题并提高更正质量

sessionId?: string

属性值

string

setLang

可用于用户界面字符串的语言。 使用 ISO 639-1 2 字母语言代码指定语言。 例如，英语的语言代码是 EN。 默认为 EN（英语）。 尽管是可选项，但应始终指定语言。 通常，将 setLang 设置为 mkt 指定的相同语言，除非用户希望用户界面字符串以其他语言显示。 此参数和 Accept-Language 标头相互排斥，不可同时指定两者。 用户界面字符串是用作用户界面中标签的字符串。 JSON 响应对象中有几个用户界面字符串。 此外，响应对象中 Bing.com 属性的任何链接均会应用指定的语言。

setLang?: string

属性值

string

userAgent

发出请求的用户代理。 必应使用用户代理为移动用户提供优化体验。 尽管是可选的，但强烈建议始终指定此标头。 用户代理应与任何常用浏览器发送的字符串相同。 有关用户代理的信息，请参阅 RFC 2616。

userAgent?: string

属性值

string

userId

标识用户的唯一 ID。 为每个用户生成唯一值， (该值不重要) 。 该服务使用 ID 来帮助调试问题并提高更正质量。

userId?: string

属性值

string

继承属性详细信息

abortSignal

可用于中止请求的信号。

abortSignal?: AbortSignalLike

属性值

AbortSignalLike

继承自 msRest.RequestOptionsBase.abortSignal

customHeaders

用户定义的自定义请求标头，将在发送请求之前应用这些标头。

customHeaders?: {[key: string]: string}

属性值

{[key: string]: string}

继承自 msRest.RequestOptionsBase.customHeaders

onDownloadProgress

下载进度时触发的回调。

onDownloadProgress?: (progress: TransferProgressEvent) => void

属性值

(progress: TransferProgressEvent) => void

继承自 msRest.RequestOptionsBase.onDownloadProgress

onUploadProgress

上传进度时触发的回调。

onUploadProgress?: (progress: TransferProgressEvent) => void

属性值

(progress: TransferProgressEvent) => void

继承自 msRest.RequestOptionsBase.onUploadProgress

timeout

请求在自动终止之前可以花费的毫秒数。

timeout?: number

属性值

number

继承自 msRest.RequestOptionsBase.timeout