WebOperations Класс
Операции WebOperations.
Не следует создавать экземпляр этого класса напрямую, а создавать экземпляр клиента, который создаст его автоматически и вложит в качестве атрибута.
- Наследование
-
builtins.objectWebOperations
Конструктор
WebOperations(client, config, serializer, deserializer)Параметры
- client
Клиент для запросов на обслуживание.
- config
Настройка клиента службы.
- serializer
Сериализатор объектной модели.
- deserializer
Десериализатор объектной модели.
Переменные
- x_bing_apis_sdk
Активация соответствия swagger. Постоянное значение: "true".
Методы
| search |
API поиска в Интернете позволяет отправлять поисковый запрос в Bing и получать результаты поиска, включающие ссылки на веб-страницы, изображения и многое другое. |
search
API поиска в Интернете позволяет отправлять поисковый запрос в Bing и получать результаты поиска, включающие ссылки на веб-страницы, изображения и многое другое.
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)Параметры
- query
- str
Условие поискового запроса пользователя. Термин не может быть пустым. Термин может содержать расширенные операторы Bing. Например, чтобы ограничить результаты определенным доменом, используйте оператор site: .
- accept_language
- str
Разделенный запятыми список одного или нескольких языков, используемых для строк пользовательского интерфейса. В этом списке языки указаны в порядке убывания по приоритету. Дополнительные сведения, включая ожидаемый формат, см . в разделе RFC2616. Этот заголовок и параметр запроса setLang являются взаимоисключающими; не указывать оба параметра. Если задать этот заголовок, также необходимо указать параметр запроса cc. Bing будет использовать первый поддерживаемый язык, который будет найден в списке, и объединить этот язык со значением параметра cc, чтобы определить рынок для возврата результатов. Если список не содержит поддерживаемый язык, Bing найдет ближайший язык и рынок, поддерживающий запрос, и может использовать агрегированный или стандартный рынок для результатов вместо указанного. Этот заголовок и параметр запроса cc следует использовать только в том случае, если указано несколько языков; В противном случае следует использовать параметры запроса mkt и setLang. Строка пользовательского интерфейса — это строка, которая используется как метка в пользовательском интерфейсе. В объектах ответа JSON очень мало строк пользовательского интерфейса. Все ссылки в объектах ответа на свойства Bing.com будут применять указанный язык.
- pragma
- str
По умолчанию Bing возвращает кэшированное содержимое, если оно доступно. Чтобы Bing не возвращал кэшированное содержимое, установите для заголовка Pragma значение no-cache (например, Pragma:no-cache).
- user_agent
- str
Агент пользователя, отправивший запрос. Bing использует агент пользователя, чтобы обеспечить оптимизированное взаимодействие для мобильных пользователей. Хотя этот заголовок является необязательным, настоятельно рекомендуется всегда указывать этот заголовок. Агент пользователя должен быть той же строкой, которую будет отправлять любой распространенный браузер. Дополнительные сведения об агентах пользователя см. в этой статье.
- client_id
- str
Bing использует этот заголовок для обеспечения согласованного поведения при выполнении разных вызовов Bing API. Bing часто проверяет новые функции и улучшения и использует идентификатор клиента в качестве ключа для назначения тестируемых возможностей. Если вы не используете один и тот же идентификатор клиента для нескольких запросов, Bing может назначить одному пользователю несколько конфликтующих функций. Назначение таких проверяемых возможностей может привести к несогласованному взаимодействию с пользователем. Например, если для второго запроса будет назначена другая проверяемая возможность, результат будет неожиданным для пользователя. Кроме того, Bing может использовать идентификатор клиента для адаптации веб-результатов к журналу поиска этого идентификатора клиента, обеспечивая более широкие возможности для пользователя. Bing также использует этот заголовок, чтобы повысить рейтинг результатов путем анализа активности, создаваемой идентификатором клиента. Повышение релевантности помогает улучшить качество результатов, предоставляемых API Bing, что, в свою очередь, обеспечивает более быстрые переходы по ссылкам для потребителей API. ВАЖНО! Считайте этот заголовок обязательным, хоть это и не так. Сохранение идентификатора клиента по нескольким запросам для одной и той же комбинации пользователя и устройства позволяет 1) потребителю API получать согласованный пользовательский интерфейс и 2) больше переходов по ссылкам благодаря лучшему качеству результатов от Bing API. Каждый пользователь, использующий приложение на устройстве, должен иметь уникальный идентификатор клиента Bing. Если этот заголовок не включается в запрос, Bing создает идентификатор и возвращает его в заголовке ответа X-MSEdge-ClientID. Этот заголовок не следует включать в запрос, только когда пользователь в первый раз использует приложение на этом устройстве. Используйте идентификатор клиента при каждом запросе к API Bing от приложения для определенного пользователя на определенном устройстве. Сохраните идентификатор клиента. Чтобы сохранить идентификатор в приложении браузера, нужен постоянный файл cookie HTTP, что гарантирует использование идентификатора во всех сеансах. Не используйте файл cookie сеанса. В других приложениях, таких как мобильные приложения, для хранения идентификатора можно использовать постоянное хранилище устройства. В следующий раз, когда пользователь будет использовать приложение на этом устройстве, извлеките сохраненный идентификатор клиента. Ответы Bing могут как включать, так и не включать этот заголовок. Если ответ включает этот заголовок, сохраните идентификатор клиента и используйте его для всех последующих запросов Bing для пользователя на этом устройстве. Если в запрос включен заголовок X-MSEdge-ClientID, этот запрос не должен содержать файлы cookie.
- client_ip
- str
IPv4-адрес или IPv6-адрес клиентского устройства. IP-адрес используется для обнаружения расположения пользователя. Bing использует сведения о расположении для выбора безопасного поведения поиска. Приведенный ниже заголовок является необязательным, однако всегда рекомендуется указывать его и заголовок X-Search-Location. Не маскируйте адрес (например, изменив последний октет на 0). Маскировка адреса приводит к тому, что определяется расположение, отдаленное от фактического расположения устройства. В результате Bing может выводить ошибочные результаты.
- location
- str
Список пар "ключ — значение", разделенных точкой с запятой, которые описывают географическое расположение клиента. Bing использует сведения о расположении для определения поведения при безопасном поиске и возвращения релевантного локального содержимого. Укажите пару "ключ — значение" в формате :. Ниже приведены ключи, которые можно использовать для определения расположения пользователя. lat (обязательный): широта расположения клиента в градусах. Широта должна быть не меньше −90,0 и не больше +90,0. Отрицательные значения указывают южную широту, а положительные значения — северную. long (обязательный): долгота расположения клиента в градусах. Долгота должна быть не меньше –180.0 и не больше +180.0. Отрицательные значения указывают на западную долготу, а положительные — на восточную. re (обязательный): радиус в метрах, определяющий горизонтальную точность координат. Передайте значение, возвращенное службой расположения устройства. Типичные значения: 22 м для GPS или Wi-Fi, 380 м для триангуляции базовой станции и 18 000 м для обратного просмотра IP-адресов. ts (необязательно): метка времени UTC UNIX, когда клиент находился в расположении. (Метка времени UNIX — это количество секунд с 1 января 1970 года.) head (необязательно): относительный заголовок или направление перемещения клиента. Укажите направление движения в градусах от 0 до 360, отсчитывая по часовой стрелке относительно севера. Укажите этот ключ, только если ключ sp не является нулевым. sp (необязательно): горизонтальная скорость (скорость в метрах в секунду), которую перемещает клиентское устройство. alt (необязательно): высота клиентского устройства в метрах. are (необязательно): радиус в метрах, определяющий вертикальную точность координат. Укажите этот ключ только в том случае, если указана клавиша ALT. Хотя многие из этих ключей не являются обязательными, чем больше информации вы предоставите, тем точнее будут результаты поиска. Хотя это необязательно, рекомендуется всегда указывать географическое расположение пользователя. Это особенно важно, если IP-адрес клиента не точно отражает физическое расположение пользователя (например, если клиент использует VPN). Для получения оптимальных результатов следует включать этот заголовок и заголовок X-MSEdge-ClientIP. Как минимум, следует включать этот заголовок.
- answer_count
- int
Количество ответов, которые требуется включить в ответ. Ответы, возвращаемые Bing, основаны на ранжировании. Например, если Bing возвращает веб-страницы, изображения, видео и связанные поиски для запроса, а для этого параметра задано два (2), ответ включает веб-страницы и изображения. Если включить параметр запроса responseFilter в тот же запрос и задать для него веб-страницы и новости, ответ будет включать только веб-страницы.
- country_code
- str
Двухзначный код страны, откуда получены результаты. Этот API поддерживает только США рынке. Если вы указываете этот параметр запроса, он должен быть задан для нас. Если задать этот параметр, также необходимо указать заголовок Accept-Language. Bing использует первый поддерживаемый язык, который он находит из списка языков, и объединяет этот язык с указанным кодом страны, чтобы определить рынок для возврата результатов. Если список языков не содержит поддерживаемый язык, Bing находит ближайший язык и рынок, поддерживающий запрос, или может использовать агрегированный или стандартный рынок для результатов вместо указанного. Этот параметр запроса и параметр запроса Accept-Language следует использовать только при указании нескольких языков; В противном случае следует использовать параметры запроса mkt и setLang. Этот параметр и параметр запроса mkt являются взаимоисключающими. Не указывайте оба.
- count
- int
Количество возвращаемых в ответе результатов поиска. Значение по умолчанию — 10, а максимальное значение — 50. Фактическое доставленное число может быть меньше запрошенного. Используйте этот параметр вместе с параметром offset для результатов страницы. Например, если в пользовательском интерфейсе отображается 10 результатов поиска на странице, задайте для параметра Count значение 10, а для смещения — 0, чтобы получить первую страницу результатов. Для каждой последующей страницы смещение увеличивается на 10 (например, 0, 10, 20). Результаты могут перекрываться на нескольких страницах.
Отфильтруйте результаты поиска по следующим возрастным значениям: День — возврат веб-страниц, обнаруженных Bing за последние 24 часа. Неделя — возвращает веб-страницы, обнаруженные Bing за последние 7 дней. Month — возвращает веб-страницы, обнаруженные за последние 30 дней. Этот фильтр применяется только к результатам веб-страницы, но не к другим результатам, таким как новости и изображения. Возможные значения: "Day", "Week", "Month"
- market
- str
Рынок, по которому возвращаются результаты. Как правило, mkt — это страна, из которой пользователь выполняет запрос. Однако это может быть другая страна, если пользователь не находится в стране, где Bing предоставляет результаты. Рынок должен иметь вид -. Например, en-US. Строка не учитывает регистр. Если это известно, рекомендуется всегда указывать рынок. Таким образом Bing может направить запрос и вернуть соответствующий и оптимальный ответ. Если указать рынок, который не указан в коде рынка, Bing использует код рынка, наиболее подходящий на основе внутреннего сопоставления, которое может быть изменено. Этот параметр и параметр запроса cc являются взаимоисключающими. Не указывайте оба.
- offset
- int
Отсчитывающее от нуля смещение, указывающее количество результатов поиска, которые необходимо пропустить перед возвратом результатов. Значение по умолчанию равно 0. Смещение должно быть меньше (totalEstimatedMatches — count). Используйте этот параметр вместе с параметром count для страницы результатов. Например, если в пользовательском интерфейсе отображается 10 результатов поиска на странице, задайте для параметра count значение 10, а для смещения — 0, чтобы получить первую страницу результатов. Для каждой последующей страницы смещение увеличивается на 10 (например, 0, 10, 20). Несколько страниц могут включать некоторые перекрывающиеся результаты.
- promote
- list[str или AnswerType]
Разделенный запятыми список ответов, который вы хотите включить в ответ независимо от их ранжирования. Например, если для параметра answerCount задано значение два (2), чтобы Bing возвращал два первых ранжированных ответа, но вы также хотите, чтобы ответ включал новости, вы бы задали для повышения уровня новости. Если лучшими ответами являются веб-страницы, изображения, видео и связанные поиски, ответ включает веб-страницы и изображения, так как новости не являются ранжированные ответы. Но если вы установите для повышения уровень видео, Bing будет продвигать ответ видео в ответ и возвращать веб-страницы, изображения и видео. Ответы, которые вы хотите повысить, не учитываются в лимите answerCount. Например, если ранжированные ответы — новости, изображения и видео, а для параметра answerCount задано значение 1 и повысить уровень до новостей, ответ будет содержать новости и изображения. Если же к ранжированным результатам относятся видео, изображения и новости, то ответ содержит видео и новости. Возможные значения: Вычисления, Изображения, Новости, Связанные поиски, SpellSuggestions, TimeZone, Видео, Веб-страницы. Используйте только в том случае, если указан параметр answerCount.
- response_filter
- list[str или AnswerType]
Разделенный запятыми список ответов для включения в ответ. Если этот параметр не указан, в ответ будут включены все поисковые ответы, для которых имеются соответствующие данные. Возможные значения фильтра: Вычисления, Изображения, Новости, Связанные поиски, SpellSuggestions, TimeZone, Видео, Веб-страницы. Хотя этот фильтр можно использовать для получения одного ответа, вместо этого следует использовать конечную точку для конкретного ответа, чтобы получить более подробные результаты. Например, чтобы получить только изображения, отправьте запрос в одну из конечных точек API поиска изображений. Ответы RelatedSearches и SpellSuggestions не поддерживают отдельную конечную точку, как API поиска изображений (их возвращает только API поиска в Интернете). Чтобы включить ответы, которые в противном случае были бы исключены из-за ранжирования, см. параметр запроса promote.
- safe_search
- str или SafeSearch
Фильтр, используемый для фильтрации содержимого для взрослых. Выкл. Возвращает веб-страницы с текстом, изображениями или видео для взрослых. Модерация. Возвращает веб-страницы с текстом для взрослых, но не изображениями или видео для взрослых. Строгий: не возвращайте веб-страницы с текстом, изображениями или видео для взрослых. По умолчанию используется значение Moderate. Если запрос поступает с рынка, в котором политика Bing для взрослых требует, чтобы параметр safeSearch был установлен в значение Strict, Bing игнорирует значение safeSearch и использует Strict. Если вы используете оператор запроса site:, существует вероятность того, что ответ может содержать содержимое для взрослых независимо от того, какой параметр запроса safeSearch имеет значение. Использовать сайт: только в том случае, если вы знаете о содержимом сайта и ваш сценарий поддерживает возможность контента для взрослых. Возможные значения: "Off", "Moderate", "Strict"
- set_lang
- str
Язык, используемый для строк пользовательского интерфейса. Укажите язык, используя двухбуквенный код ISO 639-1. Например, код для английского языка — EN. Он также является кодом по умолчанию. Хотя это необязательно, всегда следует указывать язык. Как правило, для параметра setLang задается тот же язык, который указан в mkt, если пользователь не хочет, чтобы строки пользовательского интерфейса отображались на другом языке. Этот параметр и заголовок Accept-Language являются взаимоисключающими; не указывают оба. Строка пользовательского интерфейса — это строка, которая используется как метка в пользовательском интерфейсе. Есть несколько строк пользовательского интерфейса в объектах ответа JSON. Кроме того, все ссылки на свойства Bing.com в объектах ответа применяют указанный язык.
- text_decorations
- bool
Логическое значение, определяющее, должны ли отображаемые строки содержать маркеры оформления, такие как знаки выделения нажатия. Если значение равно true, строки могут содержать маркеры. Значение по умолчанию — false. Чтобы указать, следует ли использовать в качестве маркеров символы Юникода или теги HTML, см. параметр запроса textFormat.
- text_format
- str или TextFormat
Тип маркеров, используемых для оформления текста (см. параметр запроса textDecorations). Возможные значения — необработанные — используйте символы Юникода для пометки содержимого, которое требует специального форматирования. Символы Юникода находятся в диапазоне от E000 до E019. Например, Bing использует E000 и E001, чтобы пометить начало и конец терминов запроса для выделения совпадений. HTML — используйте теги HTML для пометки содержимого, требующего специального форматирования. Например, используйте теги для выделения терминов запросов в отображаемых строках. Значение по умолчанию — Raw. Для отображаемых строк, содержащих экранируемые html-символы, такие как <, >и &, если для textFormat задано значение HTML, Bing экранирует символы соответствующим образом (например, < экранируется в <). Возможные значения: Raw, Html
- operation_config
Переопределения конфигурации операций.
Возвращаемое значение
SearchResponse или ClientRawResponse, если raw=true
Возвращаемый тип
Исключения
Атрибуты
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'>
Azure SDK for Python
Обратная связь
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделе https://aka.ms/ContentUserFeedback.
Отправить и просмотреть отзыв по