ImageObject Classe

Définit une image.

Les variables sont uniquement renseignées par le serveur et sont ignorées lors de l’envoi d’une requête.

Tous les paramètres requis doivent être renseignés pour pouvoir être envoyés à Azure.

Héritage

azure.cognitiveservices.search.websearch.models._models_py3.MediaObject

ImageObject

Constructeur

ImageObject(**kwargs)

Paramètres

Nom	Description
_type Obligatoire	str Obligatoire. Constante remplie par le serveur.

Variables

Nom	Description
id	str Identificateur de chaîne.
web_search_url	str URL vers le résultat de recherche de Bing pour cet élément.
name	str Nom de la chose représentée par cet objet.
url	str URL permettant d’obtenir plus d’informations sur la chose représentée par cet objet.
image	ImageObject
description	str Brève description de l’élément.
bing_id	str ID qui identifie de manière unique cet élément.
thumbnail_url	str URL d’une miniature de l’élément.
provider	list[Thing] Source du travail créatif.
text	str
content_url	str URL d’origine pour récupérer la source (fichier) de l’objet multimédia (par exemple, l’URL source de l’image).
host_page_url	str URL de la page qui héberge l’objet multimédia.
width	int Largeur de l’objet multimédia source, en pixels.
height	int Hauteur de l’objet multimédia source, en pixels.
thumbnail	ImageObject URL d’une miniature de l’image

Méthodes

as_dict	Retourne un dict qui peut être JSONify à l’aide de json.dump. L’utilisation avancée peut éventuellement utiliser un rappel comme paramètre : La clé est le nom d’attribut utilisé dans Python. Attr_desc est une dictée de métadonnées. Contient actuellement « type » avec le type msrest et « key » avec la clé encodée RestAPI. Value est la valeur actuelle de cet objet. La chaîne retournée sera utilisée pour sérialiser la clé. Si le type de retour est une liste, il est considéré comme un dict de résultat hiérarchique. Consultez les trois exemples de ce fichier : attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Si vous souhaitez la sérialisation XML, vous pouvez passer les kwargs is_xml=True.
deserialize	Analysez une str à l’aide de la syntaxe RestAPI et retournez un modèle.
enable_additional_properties_sending
from_dict	Analyser une dict à l’aide de l’extracteur de clé donné retourne un modèle. Par défaut, considérez les extracteurs de clés (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor et last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Retourne le json qui serait envoyé à Azure à partir de ce modèle. Il s’agit d’un alias pour as_dict(full_restapi_key_transformer, keep_readonly=False). Si vous souhaitez la sérialisation XML, vous pouvez passer les kwargs is_xml=True.
validate	Validez ce modèle de manière récursive et retournez une liste de ValidationError.

as_dict

Retourne un dict qui peut être JSONify à l’aide de json.dump.

L’utilisation avancée peut éventuellement utiliser un rappel comme paramètre :

La clé est le nom d’attribut utilisé dans Python. Attr_desc est une dictée de métadonnées. Contient actuellement « type » avec le type msrest et « key » avec la clé encodée RestAPI. Value est la valeur actuelle de cet objet.

La chaîne retournée sera utilisée pour sérialiser la clé. Si le type de retour est une liste, il est considéré comme un dict de résultat hiérarchique.

Consultez les trois exemples de ce fichier :

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Si vous souhaitez la sérialisation XML, vous pouvez passer les kwargs is_xml=True.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Paramètres

Nom	Description
key_transformer	<xref:function> Fonction de transformateur de clé.
keep_readonly	valeur par défaut: True

Retours

Type	Description
dict	Objet compatible JSON dict

deserialize

Analysez une str à l’aide de la syntaxe RestAPI et retournez un modèle.

deserialize(data, content_type=None)

Paramètres

Nom	Description
data Obligatoire	str Str utilisant la structure RestAPI. JSON par défaut.
content_type	str JSON par défaut, définissez application/xml si XML. valeur par défaut: None

Retours

Type	Description
	Une instance de ce modèle

Exceptions

Type	Description
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

Analyser une dict à l’aide de l’extracteur de clé donné retourne un modèle.

Par défaut, considérez les extracteurs de clés (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor et last_rest_key_case_insensitive_extractor)

from_dict(data, key_extractors=None, content_type=None)

Paramètres

Nom	Description
data Obligatoire	dict dict utilisant la structure RestAPI
content_type	str JSON par défaut, définissez application/xml si XML. valeur par défaut: None
key_extractors	valeur par défaut: None

Retours

Type	Description
	Une instance de ce modèle

Exceptions

Type	Description
DeserializationError if something went wrong

is_xml_model

is_xml_model()

serialize

Retourne le json qui serait envoyé à Azure à partir de ce modèle.

Il s’agit d’un alias pour as_dict(full_restapi_key_transformer, keep_readonly=False).

Si vous souhaitez la sérialisation XML, vous pouvez passer les kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Paramètres

Nom	Description
keep_readonly	bool Si vous souhaitez sérialiser les attributs readonly valeur par défaut: False

Retours

Type	Description
dict	Objet compatible JSON dict

validate

Validez ce modèle de manière récursive et retournez une liste de ValidationError.

validate()

Retours

Type	Description
list	Liste des erreurs de validation