NewsArticle Classe
Définit un article d’actualité.
Les variables sont uniquement remplies par le serveur et sont ignorées lors de l’envoi d’une demande.
Tous les paramètres requis doivent être renseignés pour pouvoir être envoyés à Azure.
- Héritage
-
azure.cognitiveservices.search.websearch.models._models_py3.ArticleNewsArticle
Constructeur
NewsArticle(**kwargs)
Paramètres
Nom | Description |
---|---|
_type
Obligatoire
|
Obligatoire. Constante remplie par le serveur. |
Variables
Nom | Description |
---|---|
id
|
Identificateur de chaîne. |
web_search_url
|
URL vers le résultat de recherche bing pour cet élément. |
name
|
Nom de la chose représentée par cet objet. |
url
|
URL permettant d’obtenir plus d’informations sur la chose représentée par cet objet. |
image
|
|
description
|
Brève description de l’élément. |
bing_id
|
ID qui identifie de façon unique cet élément. |
thumbnail_url
|
URL d’une miniature de l’élément. |
provider
|
Source du travail créatif. |
text
|
|
word_count
|
Nombre de mots dans le texte de l’article. |
Méthodes
as_dict |
Retourne un dictée 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 un 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 dans cet objet. La chaîne retournée sera utilisée pour sérialiser la clé. Si le type de retour est une liste, cela est considéré comme un dicté de résultat hiérarchique. Consultez les trois exemples de ce fichier :
Si vous souhaitez une sérialisation XML, vous pouvez passer les kwargs is_xml=True. |
deserialize |
Analysez un str à l’aide de la syntaxe RestAPI et retournez un modèle. |
enable_additional_properties_sending | |
from_dict |
L’analyse d’un 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 une 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ée 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 un 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 dans cet objet.
La chaîne retournée sera utilisée pour sérialiser la clé. Si le type de retour est une liste, cela 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 une 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 |
---|---|
Objet compatible JSON de dict |
deserialize
Analysez un str à l’aide de la syntaxe RestAPI et retournez un modèle.
deserialize(data, content_type=None)
Paramètres
Nom | Description |
---|---|
data
Obligatoire
|
Str utilisant la structure RestAPI. JSON par défaut. |
content_type
|
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
L’analyse d’un 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 utilisant la structure RestAPI |
content_type
|
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 une sérialisation XML, vous pouvez passer les kwargs is_xml=True.
serialize(keep_readonly=False, **kwargs)
Paramètres
Nom | Description |
---|---|
keep_readonly
|
Si vous souhaitez sérialiser les attributs readonly valeur par défaut: False
|
Retours
Type | Description |
---|---|
Objet compatible JSON de dict |
validate
Validez ce modèle de manière récursive et retournez une liste de ValidationError.
validate()
Retours
Type | Description |
---|---|
Liste des erreurs de validation |
Azure SDK for Python