SearchResponse Класс

Определяет объект верхнего уровня, который включает ответ при удачном запросе.

Переменные заполняются только сервером и игнорируются при отправке запроса.

Для отправки в Azure необходимо заполнить все необходимые параметры.

Наследование

azure.cognitiveservices.search.websearch.models._models_py3.Response

SearchResponse

Конструктор

SearchResponse(**kwargs)

Параметры

Имя	Описание
_type Обязательно	str Обязательный. Константы, заполненные сервером.

Переменные

Имя	Описание
id	str Строковый идентификатор.
web_search_url	str Url-адрес результата поиска Bing для этого элемента.
query_context	QueryContext Объект, содержащий строку запроса, которую использует Bing. Этот объект содержит строку запроса, введенную пользователем. Он также может содержать измененную строку запроса, которую использует Bing в том случае, если строка запроса содержит орфографические ошибки.
web_pages	WebWebAnswer Список веб-страниц, относящихся к поисковому запросу.
images	Images Список изображений, относящихся к поисковому запросу.
news	News Список новостных статей, относящихся к поисковому запросу.
related_searches	RelatedSearchesRelatedSearchAnswer Список связанных запросов, выполненных другими пользователями.
spell_suggestions	SpellSuggestions Строка запроса, которая, скорее всего, представляет намерение пользователя.
time_zone	TimeZone Дата и время одного или нескольких географических расположений.
videos	Videos Список видео, относящихся к поисковому запросу.
computation	Computation Ответ на математическое выражение или выражение преобразования единиц.
ranking_response	RankingRankingResponse Порядок, в котором Bing предлагает отображать результаты поиска.

Методы

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.
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	значение по умолчанию: True

Возвращаемое значение

Тип	Описание
dict	Объект, совместимый с JSON для дикта

deserialize

Синтаксический анализ str с помощью синтаксиса RestAPI и возврат модели.

deserialize(data, content_type=None)

Параметры

Имя	Описание
data Обязательно	str Строка, использующий структуру RestAPI. JSON по умолчанию.
content_type	str JSON по умолчанию задайте значение application/xml if XML. значение по умолчанию: None

Возвращаемое значение

Тип	Описание
	Экземпляр этой модели

Исключения

Тип	Описание
DeserializationError if something went wrong

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)

Параметры

Имя	Описание
data Обязательно	dict Словарь, использующий структуру RestAPI
content_type	str JSON по умолчанию задайте значение application/xml if XML. значение по умолчанию: None
key_extractors	значение по умолчанию: None

Возвращаемое значение

Тип	Описание
	Экземпляр этой модели

Исключения

Тип	Описание
DeserializationError if something went wrong

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 Если вы хотите сериализовать атрибуты только для чтения значение по умолчанию: False

Возвращаемое значение

Тип	Описание
dict	Объект, совместимый с JSON для дикта

validate

Рекурсивная проверка этой модели и возврат списка ValidationError.

validate()

Возвращаемое значение

Тип	Описание
list	Список ошибок проверки