ImageObject Класс
Определяет изображение.
Переменные заполняются только сервером и игнорируются при отправке запроса.
Все необходимые параметры должны быть заполнены для отправки в Azure.
- Наследование
-
azure.cognitiveservices.search.websearch.models._models_py3.MediaObjectImageObject
Конструктор
ImageObject(**kwargs)
Параметры
Имя | Описание |
---|---|
_type
Обязательно
|
Обязательный. Константой, заполненной сервером. |
Переменные
Имя | Описание |
---|---|
id
|
Строковый идентификатор. |
web_search_url
|
Результат поиска по URL-адресу Bing для этого элемента. |
name
|
Имя объекта, представленного этим объектом. |
url
|
URL-адрес для получения дополнительных сведений о объекте, представленном этим объектом. |
image
|
|
description
|
Краткое описание элемента. |
bing_id
|
Идентификатор, который однозначно идентифицирует этот элемент. |
thumbnail_url
|
URL-адрес эскиза элемента. |
provider
|
Источник творческой работы. |
text
|
|
content_url
|
Исходный URL-адрес для получения источника (файла) для объекта мультимедиа (например, исходный URL-адрес для изображения). |
host_page_url
|
URL-адрес страницы, на котором размещается объект мультимедиа. |
width
|
Ширина исходного объекта мультимедиа в пикселях. |
height
|
Высота исходного объекта мультимедиа в пикселях. |
thumbnail
|
URL-адрес эскиза изображения |
Методы
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
|
значение по умолчанию: True
|
Возвращаемое значение
Тип | Описание |
---|---|
Объект, совместимый с JSON для диктовки |
deserialize
Выполните синтаксический анализ str с помощью синтаксиса RestAPI и верните модель.
deserialize(data, content_type=None)
Параметры
Имя | Описание |
---|---|
data
Обязательно
|
Str, использующий структуру RestAPI. JSON по умолчанию. |
content_type
|
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
|
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()
Возвращаемое значение
Тип | Описание |
---|---|
Список ошибок проверки |
Azure SDK for Python
Обратная связь
https://aka.ms/ContentUserFeedback.
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделеОтправить и просмотреть отзыв по