你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
WebOperations 类
WebOperations 操作。
不应直接实例化此类，而应创建一个客户端实例，该实例将为你创建它并将其附加为属性。
- 继承
-
builtins.objectWebOperations
构造函数
WebOperations(client, config, serializer, deserializer)参数
- client
服务请求的客户端。
- config
服务客户端的配置。
- serializer
对象模型序列化程序。
- deserializer
对象模型反序列化程序。
变量
- x_bing_apis_sdk
激活 swagger 合规性。 常量值：“true”。
方法
| search |
Web 搜索 API 允许向必应发送搜索查询，并返回包含网页、图像等链接的搜索结果。 |
search
Web 搜索 API 允许向必应发送搜索查询，并返回包含网页、图像等链接的搜索结果。
search(query, accept_language=None, pragma=None, user_agent=None, client_id=None, client_ip=None, location=None, answer_count=None, country_code=None, count=None, freshness=None, market='en-us', offset=None, promote=None, response_filter=None, safe_search=None, set_lang=None, text_decorations=None, text_format=None, custom_headers=None, raw=False, **operation_config)参数
- accept_language
- str
用于用户界面字符串的一种或多种语言的逗号分隔列表。 此列表以降序方式显示首选项。 有关其他信息（包括预期格式），请参阅 RFC2616。 此标头和 setLang 查询参数互斥;不要同时指定这两者。 如果设置此标头，则还必须指定 cc 查询参数。 必应将使用它从列表中找到的第一种受支持的语言，并将该语言与 cc 参数值组合在一起，以确定返回结果的市场。 如果列表不包含支持的语言，必应将找到支持请求的最近语言和市场，并且可能会对结果使用聚合市场或默认市场，而不是指定的市场。 仅当指定多种语言时，才应使用此标头和 cc 查询参数;否则，应使用 mkt 和 setLang 查询参数。 用户界面字符串是用作用户界面中标签的字符串。 JSON 响应对象中的用户界面字符串很少。 响应对象中指向 Bing.com 属性的任何链接都将应用指定的语言。
- pragma
- str
默认情况下，必应返回缓存的内容（如果适用）。 若要防止必应返回缓存的内容，请将 Pragma 标头设置为 no-cache（例如，Pragma: no-cache）。
- user_agent
- str
发出请求的用户代理。 必应使用用户代理为移动用户提供优化体验。 尽管是可选的，但强烈建议始终指定此标头。 用户代理应与任何常用浏览器发送的字符串相同。 有关用户代理的信息，请参阅 RFC 2616。
- client_id
- str
必应使用此标头跨必应 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。
- client_ip
- str
客户端设备的 IPv4 或 IPv6 地址。 IP 地址用于发现用户的位置。 必应使用位置信息来确定安全搜索行为。 尽管是可选的，但还是建议始终指定此标头和 X-Search-Location 标头。 不要混淆地址（例如，通过将最后一个八位字节更改为 0 来混淆地址）。 混淆地址会导致位置未处于设备实际位置附近，这可能导致必应提供错误的结果。
- location
- str
以分号分隔的键/值对列表，描述客户端的地理位置。 必应使用位置信息来确定安全搜索行为并返回相关的本地内容。 以 : 形式指定键/值对。 下面是用于指定用户位置的键。 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-MSEdge-ClientIP 标头，但应至少包含此标头。
- answer_count
- int
希望响应包含的答案数。 必应返回的答案基于排名。 例如，如果必应返回请求的网页、图像、视频和 relatedSearches，并且将此参数设置为两个 (2) ，则响应包括网页和图像。如果在同一请求中包含 responseFilter 查询参数并将其设置为网页和新闻，则响应将仅包含网页。
- country_code
- str
结果来源的国家/地区的 2 个字符国家/地区代码。 此 API 仅支持美国市场。 如果指定此查询参数，则必须将其设置为我们。 如果设置此参数，则还必须指定 Accept-language 标头。 必应使用从语言列表中找到的第一种受支持语言，并将该语言与指定的国家/地区代码组合在一起，以确定返回结果的市场。 如果语言列表不包含支持的语言，必应会查找支持请求的最接近的语言和市场，或者它可能会对结果使用聚合市场或默认市场，而不是指定的市场。 仅当指定多种语言时，才应使用此查询参数和 Accept-Language 查询参数;否则，应使用 mkt 和 setLang 查询参数。 此参数和 mkt 查询参数相互排斥，不可同时指定两者。
- count
- int
要在响应中返回的搜索结果数。 默认值为 10，最大值为 50。 实际传递的数量可能小于请求的数量。将此参数与 offset 参数一起使用，对结果进行分页。例如，如果用户界面每页显示 10 个搜索结果，请将 count 设置为 10，偏移量设置为 0 以获取结果的第一页。 对于每个后续页面，将偏移量递增 10 (例如 0、10、20) 。 多个页面可能在结果中包含一些重叠。
按以下年龄值筛选搜索结果：Day - 返回必应在过去 24 小时内发现的网页。 周 - 返回必应在过去 7 天内发现的网页。 Month - 返回过去 30 天内发现的网页。 此筛选器仅适用于网页结果，不适用于其他结果，例如新闻和图像。 可能的值包括：“Day”、“Week”、“Month”
- market
- str
产生结果的市场。 通常，mkt 是用户发出请求的国家/地区。 但是，如果用户不位于必应提供结果的国家/地区，则可能是不同的国家/地区。 市场必须采用 - 的形式。 例如，en-US。 字符串不区分大小写。 如果已知，建议始终指定市场。 指定市场有助于必应路由请求，并返回适当的最佳响应。 如果指定市场代码中未列出的市场，必应会根据可能会更改的内部映射使用最适合的市场代码。 此参数和 cc 查询参数相互排斥，不可同时指定两者。
- offset
- int
从零开始的偏移量，指示在返回结果之前要跳过的搜索结果数。 默认值为 0。 偏移量应小于 (totalEstimatedMatches - count) 。 使用此参数和 count 参数对结果进行分页。 例如，如果用户界面每页显示 10 个搜索结果，请将 count 设置为 10，偏移量设置为 0 以获取结果的第一页。 对于每个后续页面，将偏移量递增 10 (例如 0、10、20) 。 多个页面在结果中可能会包含一些重叠。
- promote
- list[str 或 AnswerType]
你希望响应包含的以逗号分隔的答案列表，无论其排名如何。 例如，如果将 answerCount) 设置为两个 (2) 以便必应返回排名前两位的答案，但你还希望响应包含新闻，则你会将“提升”设置为“新闻”。 如果排名靠前的答案是网页、图像、视频和相关搜索，则响应包括网页和图像，因为新闻不是排名答案。 但是，如果将“提升”设置为“视频”，必应会将视频答案提升为响应并返回网页、图像和视频。 要提升的答案不计入 answerCount 限制。 例如，如果排名的答案是新闻、图像和视频，并且将 answerCount 设置为 1 并提升为新闻，则响应包含新闻和图像。 或者，如果经过排名的检索结果有视频、图像和新闻，则响应会包含视频和新闻。 可能的值为 Computation、Images、News、RelatedSearches、SpellSuggestions、TimeZone、Videos、网页。 仅当指定 answerCount 时使用。
- response_filter
- list[str 或 AnswerType]
要包含在响应中的答案的逗号分隔列表。 如果未指定此参数，则响应将包括具有相关数据的所有搜索答案。 可能的筛选器值包括 Computation、Images、News、RelatedSearches、SpellSuggestions、TimeZone、Videos、网页。 尽管可以使用此筛选器获取单个答案，但应改用特定于答案的终结点，以获得更丰富的结果。 例如，若要仅接收图像，请将请求发送到图像搜索 API 终结点之一。 RelatedSearches 和 SpellSuggestions 答案不支持单独的终结点，如图像搜索 API (只有 Web 搜索 API 返回它们) 。 若要包含因排名而排除的答案，请参阅 promote 查询参数。
- safe_search
- str 或 SafeSearch
用于筛选成人内容的筛选器。 关闭：返回包含成人文本、图像或视频的网页。 中等：返回包含成人文本的网页，但返回成人图像或视频。 严格：不要返回包含成人文本、图像或视频的网页。 默认级别为“中等”。 如果请求来自必应成人策略要求将 safeSearch 设置为 Strict 的市场，必应将忽略 safeSearch 值并使用 Strict。 如果使用 site： query 运算符，则无论 safeSearch 查询参数设置为什么，响应都可能包含成人内容。 使用网站：仅当你知道网站上的内容并且你的方案支持成人内容的可能性时。 可能的值包括：“Off”、“Moderate”、“Strict”
- set_lang
- str
可用于用户界面字符串的语言。 使用 ISO 639-1 2 字母语言代码指定语言。 例如，英语的语言代码是 EN。 默认为 EN（英语）。 尽管是可选项，但应始终指定语言。 通常，将 setLang 设置为 mkt 指定的相同语言，除非用户希望用户界面字符串以其他语言显示。 此参数和 Accept-Language 标头是互斥的;不要同时指定这两者。 用户界面字符串是用作用户界面中标签的字符串。 JSON 响应对象中有几个用户界面字符串。 此外，响应对象中 Bing.com 属性的任何链接均会应用指定的语言。
- text_decorations
- bool
一个布尔值，用于确定显示字符串是否应包含修饰标记，例如命中突出显示字符。 如果为 true，则字符串可能包含标记。 默认值为 false。 若要指定是使用 Unicode 字符还是 HTML 标记作为标记，请参阅 textFormat 查询参数。
- text_format
- str 或 TextFormat
用于文本修饰的标记的类型 (请参阅 textDecorations 查询参数) 。 可能的值为 Raw - 使用 Unicode 字符标记需要特殊格式的内容。 Unicode 字符的范围是 E000 到 E019。 例如，必应使用 E000 和 E001 标记查询词的开始和结束，以便突出显示命中。 HTML - 使用 HTML 标记标记需要特殊格式的内容。 例如，使用 标记突出显示显示字符串中的查询词。 默认值为 Raw。 对于包含 、、 和 &等><可转义 HTML 字符的显示字符串，如果 textFormat 设置为 HTML，则必应根据需要转义字符，例如 < (转义为 <) 。 可能的值包括：“Raw”、“Html”
- operation_config
操作配置替代。
返回
如果 raw=true，则 SearchResponse 或 ClientRawResponse
返回类型
例外
属性
models
models = <module 'azure.cognitiveservices.search.websearch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\cognitiveservices\\search\\websearch\\models\\__init__.py'>
反馈
即将发布：在整个 2024 年，我们将逐步淘汰作为内容反馈机制的“GitHub 问题”，并将其取代为新的反馈系统。 有关详细信息，请参阅：https://aka.ms/ContentUserFeedback。
提交和查看相关反馈