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
-
ImageObject
Constructeur
ImageObject(**kwargs)
Paramètres
Variables
- id
- str
Identificateur de chaîne.
- read_link
- str
URL qui retourne cette ressource. Pour utiliser l’URL, ajoutez les paramètres de requête appropriés et incluez l’en-tête Ocp-Apim-Subscription-Key.
- web_search_url
- str
URL du 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
Image de l’élément.
- description
- str
Brève description de l’élément.
- alternate_name
- str
Alias pour 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.
- date_published
- str
Date de publication du CreativeWork.
- text
- str
Contenu textuel de ce travail créatif.
- 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.
- content_size
- str
Taille du contenu de l’objet multimédia. Utilisez le format « unité de valeur » (par exemple, « 1024 B »).
- encoding_format
- str
Format d’encodage (par exemple, png, gif, jpeg, etc.).
- host_page_display_url
- str
Afficher l’URL de la page qui héberge l’objet multimédia.
- width
- int
Largeur de l’objet multimédia, en pixels.
- height
- int
Hauteur de l’objet multimédia, en pixels.
- thumbnail
- ImageObject
URL d’une miniature de l’image.
- image_insights_token
- str
Jeton que vous utilisez dans un appel suivant à l’API Recherche visuelle pour obtenir des informations supplémentaires sur l’image. Pour plus d’informations sur l’utilisation de ce jeton, consultez le champ imageInsightsToken à l’intérieur du paramètre de requête knowledgeRequest.
- insights_metadata
- ImagesImageMetadata
Nombre de sites web sur lesquels vous pouvez effectuer des achats ou effectuer d’autres actions liées à l’image. Par exemple, si l’image est d’une tarte aux pommes, cet objet inclut le nombre de sites web où vous pouvez acheter une tarte aux pommes. Pour indiquer le nombre d’offres dans votre expérience utilisateur, incluez des badgings tels qu’une icône de panier d’achat qui contient le nombre. Lorsque l’utilisateur clique sur l’icône, utilisez imageInsightsToken dans un appel d’API Recherche visuelle suivant pour obtenir la liste des sites web d’achat.
- image_id
- str
ID unique de l’image.
- accent_color
- str
Nombre hexadécimal de trois octets qui représente la couleur qui domine l’image. Utilisez la couleur comme arrière-plan temporaire dans votre client jusqu’à ce que l’image soit chargée.
- visual_words
- str
Uniquement réservé à un usage interne.
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 :
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
- key_transformer
- <xref:function>
Fonction de transformateur de clé.
- keep_readonly
Retours
Objet compatible JSON dict
Type de retour
deserialize
Analysez une str à l’aide de la syntaxe RestAPI et retournez un modèle.
deserialize(data, content_type=None)
Paramètres
Retours
Une instance de ce modèle
Exceptions
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
- key_extractors
Retours
Une instance de ce modèle
Exceptions
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
Retours
Objet compatible JSON dict
Type de retour
validate
Validez ce modèle de manière récursive et retournez une liste de ValidationError.
validate()
Retours
Liste des erreurs de validation
Type de retour
Azure SDK for Python