QueryContext Класс
Определяет содержимое запроса, который Bing использует для запроса.
Переменные заполняются только сервером и игнорируются при отправке запроса.
Все необходимые параметры должны быть заполнены для отправки в Azure.
- Наследование
-
QueryContext
Конструктор
QueryContext(*, original_query: str, **kwargs)
Параметры
Переменные
- altered_query
- str
Строка запроса, используемая для выполнения запроса Bing. Bing использует измененную строку запроса, если исходная строка запроса содержит орфографические ошибки. Например, если строка запроса имеет значение "saling downwind", измененная строка запроса будет иметь значение "sailing downwind". Это поле включается, только если исходная строка запроса содержит орфографическую ошибку.
- alteration_override_query
- str
Строка запроса для принудительного использования исходной строки в Bing. Например, если строка запроса — saling downwind, строка запроса переопределения будет иметь значение +saling downwind. Не забудьте закодировать строку запроса, которая приводит к "%2Bsaling+downwind". Это поле включается, только если исходная строка запроса содержит орфографическую ошибку.
- adult_intent
- bool
Логическое значение, указывающее, есть ли в указанном запросе содержимое для взрослых. Значение равно true, если запрос имеет запрос на содержимое для взрослых, в противном случае — false.
- ask_user_for_location
- bool
Логическое значение, указывающее, требуется ли Bing расположение пользователя для получения точных результатов. При указании расположения пользователя с помощью заголовков X-MSEdge-ClientIP и X-Search-Location это поле можно игнорировать. Для запросов с учетом расположения, таких как "сегодняшняя погода" или "рестораны рядом со мной", которым требуется расположение пользователя для получения точных результатов, это поле имеет значение true. Для запросов с учетом расположения, которые включают расположение (например, "погода в Сиэтле"), это поле имеет значение false. Для этого поля также установлено значение false для запросов, которые не относятся к расположению, например "бестселлеры".
- is_transactional
- bool
Методы
as_dict |
Возвращает диктовку, которая может иметь значение JSONify с помощью json.dump. При дополнительном использовании можно использовать обратный вызов в качестве параметра: Ключ — это имя атрибута, используемого в Python. Attr_desc — это диктовка метаданных. В настоящее время содержит тип с типом msrest и key с ключом в кодировке RestAPI. Значение — это текущее значение в этом объекте. Возвращаемая строка будет использоваться для сериализации ключа. Если тип возвращаемого значения является списком, это считается иерархическим результирующим диктом. См. три примера в этом файле:
Если требуется сериализация XML, можно передать kwargs is_xml=True. |
deserialize |
Выполните синтаксический анализ str с помощью синтаксиса RestAPI и верните модель. |
enable_additional_properties_sending | |
from_dict |
Синтаксический анализ диктовки с помощью заданного средства извлечения ключей возвращает модель. По умолчанию рекомендуется использовать средства извлечения ключей (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor и last_rest_key_case_insensitive_extractor). |
is_xml_model | |
serialize |
Возвращает json, который будет отправлен в Azure из этой модели. Это псевдоним для as_dict(full_restapi_key_transformer, keep_readonly=False). Если требуется сериализация XML, можно передать kwargs is_xml=True. |
validate |
Рекурсивная проверка модели и возврат списка ValidationError. |
as_dict
Возвращает диктовку, которая может иметь значение JSONify с помощью json.dump.
При дополнительном использовании можно использовать обратный вызов в качестве параметра:
Ключ — это имя атрибута, используемого в Python. Attr_desc — это диктовка метаданных. В настоящее время содержит тип с типом msrest и key с ключом в кодировке RestAPI. Значение — это текущее значение в этом объекте.
Возвращаемая строка будет использоваться для сериализации ключа. Если тип возвращаемого значения является списком, это считается иерархическим результирующим диктом.
См. три примера в этом файле:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
Если требуется сериализация XML, можно передать kwargs is_xml=True.
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)
Параметры
- key_transformer
- <xref:function>
Функция преобразователя ключей.
- keep_readonly
Возвращаемое значение
Объект, совместимый с JSON для диктовки
Возвращаемый тип
deserialize
Выполните синтаксический анализ str с помощью синтаксиса RestAPI и верните модель.
deserialize(data, content_type=None)
Параметры
- content_type
- str
JSON по умолчанию задайте значение application/xml, если XML.
Возвращаемое значение
Экземпляр этой модели
Исключения
enable_additional_properties_sending
enable_additional_properties_sending()
from_dict
Синтаксический анализ диктовки с помощью заданного средства извлечения ключей возвращает модель.
По умолчанию рекомендуется использовать средства извлечения ключей (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor и last_rest_key_case_insensitive_extractor).
from_dict(data, key_extractors=None, content_type=None)
Параметры
- content_type
- str
JSON по умолчанию задайте значение application/xml, если XML.
- key_extractors
Возвращаемое значение
Экземпляр этой модели
Исключения
is_xml_model
is_xml_model()
serialize
Возвращает json, который будет отправлен в Azure из этой модели.
Это псевдоним для as_dict(full_restapi_key_transformer, keep_readonly=False).
Если требуется сериализация XML, можно передать kwargs is_xml=True.
serialize(keep_readonly=False, **kwargs)
Параметры
- keep_readonly
- bool
Если вы хотите сериализовать атрибуты только для чтения
Возвращаемое значение
Объект, совместимый с JSON для диктовки
Возвращаемый тип
validate
Рекурсивная проверка модели и возврат списка ValidationError.
validate()
Возвращаемое значение
Список ошибок проверки
Возвращаемый тип
Azure SDK for Python
Обратная связь
https://aka.ms/ContentUserFeedback.
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделеОтправить и просмотреть отзыв по