Поделиться через


Images Класс

Определяет ответ на изображение.

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

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

Наследование
azure.cognitiveservices.search.websearch.models._models_py3.SearchResultsAnswer
Images

Конструктор

Images(*, value, **kwargs)

Параметры

Имя Описание
_type
Обязательно
str

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

value
Обязательно

Обязательный. Список объектов изображений, относящихся к запросу. Если результатов нет, список пуст.

Параметры Keyword-Only

Имя Описание
value
Обязательно

Переменные

Имя Описание
id
str

Строковый идентификатор.

web_search_url
str

Результат поиска по URL-адресу Bing для этого элемента.

follow_up_queries
query_context
total_estimated_matches
<xref:long>

Предполагаемое количество веб-страниц, относящихся к запросу. Используйте это число вместе с параметрами запроса count и offset для страницы результатов.

is_family_friendly
next_offset
int
query_expansions
similar_terms
related_searches

Методы

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

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

Тип Описание

Объект, совместимый с JSON для диктовки

deserialize

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

deserialize(data, content_type=None)

Параметры

Имя Описание
data
Обязательно
str

Str, использующий структуру RestAPI. JSON по умолчанию.

content_type
str

JSON по умолчанию задайте значение application/xml, если 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
Обязательно

Диктовка, использующий структуру RestAPI

content_type
str

JSON по умолчанию задайте значение application/xml, если 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

Если вы хотите сериализовать атрибуты только для чтения

значение по умолчанию: False

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

Тип Описание

Объект, совместимый с JSON для диктовки

validate

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

validate()

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

Тип Описание

Список ошибок проверки