WebSearchOptionalParams interface

包:

@azure/cognitiveservices-websearch

可选参数。

扩展

RequestOptionsBase

属性

acceptLanguage	用于用户界面字符串的一个或多个语言的逗号分隔列表。 列表按优先顺序递减。 有关其他信息（包括预期格式）请参阅 RFC2616。 此标头和 setLang 查询参数互斥;不要同时指定这两者。 如果设置此标头，则还必须指定 cc 查询参数。 必应将使用它从列表中找到的第一种受支持的语言，并将该语言与 cc 参数值组合在一起，以确定要返回结果的市场。 如果列表不包含受支持的语言，必应将找到支持请求的最接近的语言和市场，并且可能会对结果使用聚合市场或默认市场，而不是指定的语言。 仅当指定多种语言时，才应使用此标头和 cc 查询参数;否则，应使用 mkt 和 setLang 查询参数。 用户界面字符串是用作用户界面中标签的字符串。 JSON 响应对象中很少有用户界面字符串。 响应对象中 Bing.com 属性的任何链接都将应用指定的语言。
answerCount	希望响应包含的答案数。 必应返回的答案基于排名。 例如，如果必应返回请求的网页、图像、视频和相关搜索，并将此参数设置为 2（2），则响应将包含网页和图像。如果在同一请求中包含 responseFilter 查询参数并将其设置为网页和新闻，则响应将仅包含网页。
clientId	必应使用此标头为用户提供必应 API 调用中的一致行为。 必应通常会提供新功能和改进，并将客户端 ID 用作在不同航班上分配流量的密钥。 如果不对多个请求的用户使用相同的客户端 ID，则必应可以将用户分配到多个冲突外部测试版。 分配到多个冲突外部测试版可能会导致用户体验不一致。 例如，如果第二个请求具有与第一个请求不同的外部测试版分配，则体验可能会意外。 此外，必应还可以使用客户端 ID 为该客户端 ID 的搜索历史记录定制 Web 结果，从而为用户提供更丰富的体验。 必应还使用此标头通过分析客户端 ID 生成的活动来帮助改善结果排名。 相关性改进有助于提高必应 API 提供的结果质量，进而为 API 使用者启用更高的点击率。 重要说明：虽然是可选的，但应考虑此标头是必需的。 将客户端 ID 保存在针对同一最终用户和设备组合的多个请求中，使 API 使用者能够接收一致的用户体验，并通过必应 API 的结果质量提高 2） 更高的点击率。 在设备上使用应用程序的每个用户必须具有唯一的必应生成的客户端 ID。 如果未在请求中包含此标头，必应将生成 ID 并在 X-MSEdge-ClientID 响应标头中返回该 ID。 在请求中不应包含此标头的唯一时间是用户首次在该设备上使用你的应用。 对应用在设备上为此用户发出的每个必应 API 请求使用客户端 ID。 保留客户端 ID。 若要在浏览器应用中保留 ID，请使用持久性 HTTP Cookie 来确保在所有会话中使用 ID。 请勿使用会话 Cookie。 对于其他应用（如移动应用），请使用设备的持久存储来保留 ID。 下次用户使用该设备上的应用时，获取保留的客户端 ID。 必应响应可以包含此标头，也可能不包含此标头。 如果响应包含此标头，请捕获客户端 ID，并将其用于该设备上的用户的所有后续必应请求。 如果包括 X-MSEdge-ClientID，则不得在请求中包含 Cookie。
clientIp	客户端设备的 IPv4 或 IPv6 地址。 IP 地址用于发现用户的位置。 必应使用位置信息来确定安全搜索行为。 尽管是可选的，但建议始终指定此标头和 X-Search-Location 标头。 不要模糊处理地址（例如，通过将最后一个八进制数更改为 0）。 模糊处理地址会导致该位置不在设备的实际位置附近，这可能会导致必应提供错误的结果。
count	响应中要返回的搜索结果数。 默认值为 10，最大值为 50。 传递的实际数字可能小于请求数。将此参数与偏移参数一起使用以页结果。例如，如果用户界面显示每页 10 个搜索结果，请将计数设置为 10，偏移量设置为 0 以获取结果的第一页。 对于每个后续页面，增量偏移量为 10（例如 0、10、20）。 多个页面可以在结果中包含一些重叠。
countryCode	结果来自的国家/地区的 2 个字符的国家/地区代码。 此 API 仅支持美国市场。 如果指定此查询参数，则必须将其设置为我们。 如果设置此参数，还必须指定 Accept-Language 标头。 必应使用从语言列表中查找的第一种受支持的语言，并将该语言与指定用于确定市场以返回结果的国家/地区代码相结合。 如果语言列表不包含受支持的语言，必应将查找支持请求的最接近的语言和市场，或者可能会对结果使用聚合或默认市场，而不是指定语言。 仅当指定多种语言时，才应使用此查询参数和 Accept-Language 查询参数;否则，应使用 mkt 和 setLang 查询参数。 此参数和 mkt 查询参数是互斥的-请勿同时指定这两个参数。
freshness	按以下年龄值筛选搜索结果：Day - 返回必应在过去 24 小时内发现的网页。 周 - 返回必应在过去 7 天内发现的网页。 月 - 返回在过去 30 天内发现的网页。 此筛选器仅适用于网页结果，不适用于其他结果，如新闻和图像。 可能的值包括：“Day”、“Week”、“Month”
location	用于描述客户端地理位置的键/值对的分号分隔列表。 必应使用位置信息来确定安全搜索行为并返回相关的本地内容。 将键/值对指定为 <key>：<value>。 以下是用于指定用户位置的密钥。 lat （必需）：客户端位置的纬度（以度为单位）。 纬度必须大于或等于 -90.0，并且小于或等于 +90.0。 负值表示南纬，正值表示北纬。 long （必需）：客户端位置的经度（以度为单位）。 经度必须大于或等于 -180.0，并且小于或等于 +180.0。 负值表示西经，正值表示东经。 re （必需）：半径（以米为单位），指定坐标的水平精度。 传递设备位置服务返回的值。 典型值为 22 米（对于 GPS/Wi-Fi），380 米用于单元格塔三角，对于反向 IP 查找，为 18,000m。 ts （可选）：客户端位于位置时的 UTC UNIX 时间戳。 （UNIX 时间戳是自 1970 年 1 月 1 日起的秒数。head （可选）：客户端的相对标题或旅行方向。 将行程方向指定为从 0 到 360 的度，相对于 true 北部进行顺时针计数。 仅当 sp 键为非零时指定此键。 sp （可选）：客户端设备正在行驶的水平速度（速度），以米/秒为单位。 alt （可选）：客户端设备的海拔高度（以米为单位）。 为 （可选）：半径（以米为单位），指定坐标的垂直精度。 仅当指定替换键时，才指定此键。 虽然许多键是可选的，但你提供的信息越多，位置结果就越准确。 尽管是可选的，但建议始终指定用户的地理位置。 如果客户端的 IP 地址无法准确反映用户的物理位置（例如，如果客户端使用 VPN），则提供位置尤其重要。 为了获得最佳结果，应包含此标头和 X-MSEdge-ClientIP 标头，但至少应包含此标头。
market	结果来自的市场。 通常，mkt 是用户发出请求的国家/地区。 但是，如果用户不在必应提供结果的国家/地区，则可能是不同的国家/地区。 市场必须采用语言代码>-<国家代码>的形式<。 例如，en-US。 字符串不区分大小写。 如果已知，建议始终指定市场。 指定市场有助于必应路由请求，并返回适当的最佳响应。 如果指定市场代码中未列出的市场，必应会根据可能会更改的内部映射使用最适合的市场代码。 此参数和 cc 查询参数是互斥的-请勿同时指定这两个参数。 默认值：“en-us”。
offset	从零开始的偏移量，指示在返回结果之前要跳过的搜索结果数。 默认值为 0。 偏移量应小于 （totalEstimatedMatches - count）。 将此参数与 count 参数一起使用以对结果进行分页。 例如，如果用户界面显示每页 10 个搜索结果，请将计数设置为 10，偏移量设置为 0 以获取结果的第一页。 对于每个后续页面，增量偏移量为 10（例如 0、10、20）。 多个页面可以在结果中包含一些重叠。
pragma	默认情况下，必应返回缓存的内容（如果可用）。 若要防止必应返回缓存的内容，请将 Pragma 标头设置为 no-cache（例如 Pragma：no-cache）。
promote	要包含响应的以逗号分隔的答案列表，无论其排名如何。 例如，如果将 answerCount 设置为 2（2），则必应返回排名前两的答案，但你还希望响应包括新闻，你会将提升为新闻。 如果排名靠前的答案是网页、图像、视频和相关搜索，则响应包括网页和图像，因为新闻不是排名答案。 但是，如果将提升为视频，必应会将视频答案提升到响应中，并返回网页、图像和视频。 要提升的答案不计入 answerCount 限制。 例如，如果排名靠前的答案是新闻、图像和视频，并且将 answerCount 设置为 1 并提升为新闻，则响应将包含新闻和图像。 或者，如果排名靠前的答案是视频、图像和新闻，则响应将包含视频和新闻。 可能的值包括计算、图像、新闻、RelatedSearches、SpellSuggestions、TimeZone、视频、网页。 仅当指定 answerCount 时使用。
responseFilter	要包含在响应中的答案的逗号分隔列表。 如果未指定此参数，响应将包含相关数据的所有搜索答案。 可能的筛选器值包括计算、图像、新闻、RelatedSearches、SpellSuggestions、TimeZone、Videos、网页。 尽管可以使用此筛选器获取单个答案，但应改用特定于答案的终结点来获取更丰富的结果。 例如，若要仅接收图像，请将请求发送到其中一个图像搜索 API 终结点。 RelatedSearches 和 SpellSuggestions 答案不支持单独的终结点，如图像搜索 API 所做的（仅 Web 搜索 API 返回它们）。 若要包含由于排名而排除的答案，请参阅提升查询参数。
safeSearch	用于筛选成人内容的筛选器。 关闭：返回包含成人文本、图像或视频的网页。 中等：返回包含成人文本的网页，但返回成人图像或视频。 严格：不要返回包含成人文本、图像或视频的网页。 默认值为“中等”。 如果请求来自必应成人策略要求 safeSearch 设置为 Strict 的市场，必应将忽略 safeSearch 值并使用 Strict。 如果使用网站：查询运算符，则无论 safeSearch 查询参数设置为什么，响应都可能包含成人内容。 使用网站：仅当你知道网站上的内容并且你的方案支持成人内容的可能性时。 可能的值包括：“Off”、“Moderate”、“Strict”
setLang	用于用户界面字符串的语言。 使用 ISO 639-1 2 字母语言代码指定语言。 例如，英语的语言代码为 EN。 默认值为 EN（英语）。 虽然是可选的，但应始终指定语言。 通常，将 SetLang 设置为 mkt 指定的同一语言，除非用户希望以其他语言显示用户界面字符串。 此参数和 Accept-Language 标头互斥;不要同时指定这两者。 用户界面字符串是用作用户界面中标签的字符串。 JSON 响应对象中很少有用户界面字符串。 此外，指向响应对象中 Bing.com 属性的任何链接都应用指定的语言。
textDecorations	一个布尔值，该值确定显示字符串是否应包含修饰标记，例如命中突出显示字符。 如果为 true，则字符串可能包含标记。 默认值为 false。 若要指定是使用 Unicode 字符还是 HTML 标记作为标记，请参阅 textFormat 查询参数。
textFormat	要用于文本修饰的标记的类型（请参阅 textDecorations 查询参数）。 可能的值是 Raw — 使用 Unicode 字符标记需要特殊格式的内容。 Unicode 字符位于 E000 到 E019 的范围内。 例如，必应使用 E000 和 E001 标记查询词的开头和结尾，以突出显示命中。 HTML - 使用 HTML 标记标记需要特殊格式的内容。 例如，使用 标记突出显示显示字符串中的查询词。 默认值为 Raw。 对于包含可转义 HTML 字符（如 <、>和 &）的显示字符串，如果 textFormat 设置为 HTML，必应会适当地转义字符（例如，< 转义为 <）。 可能的值包括：“Raw”、“Html”
userAgent	发起请求的用户代理。 必应使用用户代理为移动用户提供优化的体验。 尽管是可选的，但强烈建议始终指定此标头。 用户代理应与任何常用浏览器发送的字符串相同。 有关用户代理的信息，请参阅 RFC 2616。

继承属性

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

属性详细信息

acceptLanguage

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

acceptLanguage?: string

属性值

string

answerCount

希望响应包含的答案数。 必应返回的答案基于排名。 例如，如果必应返回请求的网页、图像、视频和相关搜索，并将此参数设置为 2（2），则响应将包含网页和图像。如果在同一请求中包含 responseFilter 查询参数并将其设置为网页和新闻，则响应将仅包含网页。

answerCount?: number

属性值

number

clientId

必应使用此标头为用户提供必应 API 调用中的一致行为。 必应通常会提供新功能和改进，并将客户端 ID 用作在不同航班上分配流量的密钥。 如果不对多个请求的用户使用相同的客户端 ID，则必应可以将用户分配到多个冲突外部测试版。 分配到多个冲突外部测试版可能会导致用户体验不一致。 例如，如果第二个请求具有与第一个请求不同的外部测试版分配，则体验可能会意外。 此外，必应还可以使用客户端 ID 为该客户端 ID 的搜索历史记录定制 Web 结果，从而为用户提供更丰富的体验。 必应还使用此标头通过分析客户端 ID 生成的活动来帮助改善结果排名。 相关性改进有助于提高必应 API 提供的结果质量，进而为 API 使用者启用更高的点击率。 重要说明：虽然是可选的，但应考虑此标头是必需的。 将客户端 ID 保存在针对同一最终用户和设备组合的多个请求中，使 API 使用者能够接收一致的用户体验，并通过必应 API 的结果质量提高 2） 更高的点击率。 在设备上使用应用程序的每个用户必须具有唯一的必应生成的客户端 ID。 如果未在请求中包含此标头，必应将生成 ID 并在 X-MSEdge-ClientID 响应标头中返回该 ID。 在请求中不应包含此标头的唯一时间是用户首次在该设备上使用你的应用。 对应用在设备上为此用户发出的每个必应 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

count

响应中要返回的搜索结果数。 默认值为 10，最大值为 50。 传递的实际数字可能小于请求数。将此参数与偏移参数一起使用以页结果。例如，如果用户界面显示每页 10 个搜索结果，请将计数设置为 10，偏移量设置为 0 以获取结果的第一页。 对于每个后续页面，增量偏移量为 10（例如 0、10、20）。 多个页面可以在结果中包含一些重叠。

count?: number

属性值

number

countryCode

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

countryCode?: string

属性值

string

freshness

按以下年龄值筛选搜索结果：Day - 返回必应在过去 24 小时内发现的网页。 周 - 返回必应在过去 7 天内发现的网页。 月 - 返回在过去 30 天内发现的网页。 此筛选器仅适用于网页结果，不适用于其他结果，如新闻和图像。 可能的值包括：“Day”、“Week”、“Month”

freshness?: Freshness

属性值

Freshness

location

用于描述客户端地理位置的键/值对的分号分隔列表。 必应使用位置信息来确定安全搜索行为并返回相关的本地内容。 将键/值对指定为 <key>：<value>。 以下是用于指定用户位置的密钥。 lat （必需）：客户端位置的纬度（以度为单位）。 纬度必须大于或等于 -90.0，并且小于或等于 +90.0。 负值表示南纬，正值表示北纬。 long （必需）：客户端位置的经度（以度为单位）。 经度必须大于或等于 -180.0，并且小于或等于 +180.0。 负值表示西经，正值表示东经。 re （必需）：半径（以米为单位），指定坐标的水平精度。 传递设备位置服务返回的值。 典型值为 22 米（对于 GPS/Wi-Fi），380 米用于单元格塔三角，对于反向 IP 查找，为 18,000m。 ts （可选）：客户端位于位置时的 UTC UNIX 时间戳。 （UNIX 时间戳是自 1970 年 1 月 1 日起的秒数。head （可选）：客户端的相对标题或旅行方向。 将行程方向指定为从 0 到 360 的度，相对于 true 北部进行顺时针计数。 仅当 sp 键为非零时指定此键。 sp （可选）：客户端设备正在行驶的水平速度（速度），以米/秒为单位。 alt （可选）：客户端设备的海拔高度（以米为单位）。 为 （可选）：半径（以米为单位），指定坐标的垂直精度。 仅当指定替换键时，才指定此键。 虽然许多键是可选的，但你提供的信息越多，位置结果就越准确。 尽管是可选的，但建议始终指定用户的地理位置。 如果客户端的 IP 地址无法准确反映用户的物理位置（例如，如果客户端使用 VPN），则提供位置尤其重要。 为了获得最佳结果，应包含此标头和 X-MSEdge-ClientIP 标头，但至少应包含此标头。

location?: string

属性值

string

market

结果来自的市场。 通常，mkt 是用户发出请求的国家/地区。 但是，如果用户不在必应提供结果的国家/地区，则可能是不同的国家/地区。 市场必须采用语言代码>-<国家代码>的形式<。 例如，en-US。 字符串不区分大小写。 如果已知，建议始终指定市场。 指定市场有助于必应路由请求，并返回适当的最佳响应。 如果指定市场代码中未列出的市场，必应会根据可能会更改的内部映射使用最适合的市场代码。 此参数和 cc 查询参数是互斥的-请勿同时指定这两个参数。 默认值：“en-us”。

market?: string

属性值

string

offset

从零开始的偏移量，指示在返回结果之前要跳过的搜索结果数。 默认值为 0。 偏移量应小于 （totalEstimatedMatches - count）。 将此参数与 count 参数一起使用以对结果进行分页。 例如，如果用户界面显示每页 10 个搜索结果，请将计数设置为 10，偏移量设置为 0 以获取结果的第一页。 对于每个后续页面，增量偏移量为 10（例如 0、10、20）。 多个页面可以在结果中包含一些重叠。

offset?: number

属性值

number

pragma

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

pragma?: string

属性值

string

promote

要包含响应的以逗号分隔的答案列表，无论其排名如何。 例如，如果将 answerCount 设置为 2（2），则必应返回排名前两的答案，但你还希望响应包括新闻，你会将提升为新闻。 如果排名靠前的答案是网页、图像、视频和相关搜索，则响应包括网页和图像，因为新闻不是排名答案。 但是，如果将提升为视频，必应会将视频答案提升到响应中，并返回网页、图像和视频。 要提升的答案不计入 answerCount 限制。 例如，如果排名靠前的答案是新闻、图像和视频，并且将 answerCount 设置为 1 并提升为新闻，则响应将包含新闻和图像。 或者，如果排名靠前的答案是视频、图像和新闻，则响应将包含视频和新闻。 可能的值包括计算、图像、新闻、RelatedSearches、SpellSuggestions、TimeZone、视频、网页。 仅当指定 answerCount 时使用。

promote?: AnswerType[]

属性值

AnswerType[]

responseFilter

要包含在响应中的答案的逗号分隔列表。 如果未指定此参数，响应将包含相关数据的所有搜索答案。 可能的筛选器值包括计算、图像、新闻、RelatedSearches、SpellSuggestions、TimeZone、Videos、网页。 尽管可以使用此筛选器获取单个答案，但应改用特定于答案的终结点来获取更丰富的结果。 例如，若要仅接收图像，请将请求发送到其中一个图像搜索 API 终结点。 RelatedSearches 和 SpellSuggestions 答案不支持单独的终结点，如图像搜索 API 所做的（仅 Web 搜索 API 返回它们）。 若要包含由于排名而排除的答案，请参阅提升查询参数。

responseFilter?: AnswerType[]

属性值

AnswerType[]

safeSearch

用于筛选成人内容的筛选器。 关闭：返回包含成人文本、图像或视频的网页。 中等：返回包含成人文本的网页，但返回成人图像或视频。 严格：不要返回包含成人文本、图像或视频的网页。 默认值为“中等”。 如果请求来自必应成人策略要求 safeSearch 设置为 Strict 的市场，必应将忽略 safeSearch 值并使用 Strict。 如果使用网站：查询运算符，则无论 safeSearch 查询参数设置为什么，响应都可能包含成人内容。 使用网站：仅当你知道网站上的内容并且你的方案支持成人内容的可能性时。 可能的值包括：“Off”、“Moderate”、“Strict”

safeSearch?: SafeSearch

属性值

SafeSearch

setLang

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

setLang?: string

属性值

string

textDecorations

一个布尔值，该值确定显示字符串是否应包含修饰标记，例如命中突出显示字符。 如果为 true，则字符串可能包含标记。 默认值为 false。 若要指定是使用 Unicode 字符还是 HTML 标记作为标记，请参阅 textFormat 查询参数。

textDecorations?: boolean

属性值

boolean

textFormat

要用于文本修饰的标记的类型（请参阅 textDecorations 查询参数）。 可能的值是 Raw — 使用 Unicode 字符标记需要特殊格式的内容。 Unicode 字符位于 E000 到 E019 的范围内。 例如，必应使用 E000 和 E001 标记查询词的开头和结尾，以突出显示命中。 HTML - 使用 HTML 标记标记需要特殊格式的内容。 例如，使用 标记突出显示显示字符串中的查询词。 默认值为 Raw。 对于包含可转义 HTML 字符（如 <、>和 &）的显示字符串，如果 textFormat 设置为 HTML，必应会适当地转义字符（例如，< 转义为 <）。 可能的值包括：“Raw”、“Html”

textFormat?: TextFormat

属性值

TextFormat

userAgent

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

userAgent?: 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