QueryContext Classe
Définit le contexte de requête utilisé par Bing pour la demande.
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
-
QueryContext
Constructeur
QueryContext(*, original_query: str, **kwargs)Paramètres
Variables
- altered_query
- str
Chaîne de requête utilisée par Bing pour exécuter la requête. Bing utilise la chaîne de requête modifiée si la chaîne de requête d’origine contenait des fautes d’orthographe. Par exemple, si la chaîne de requête est « saling downwind », la chaîne de requête modifiée sera « sailing downwind ». Ce champ n’est précisé que si la chaîne de requête d’origine contient une faute d’orthographe.
- alteration_override_query
- str
Chaîne de requête à utiliser pour forcer Bing à utiliser la chaîne d’origine. Par exemple, si la chaîne de requête est « saling downwind », la chaîne de requête de remplacement sera « +saling downwind ». N’oubliez pas d’encoder la chaîne de requête qui aboutit à « %2Bsaling+downwind ». Ce champ n’est précisé que si la chaîne de requête d’origine contient une faute d’orthographe.
- adult_intent
- bool
Valeur booléenne qui indique si la requête spécifiée est destinée à des adultes. La valeur est true si c’est le cas, false sinon.
- ask_user_for_location
- bool
Valeur booléenne qui indique si Bing exige que l’emplacement de l’utilisateur donne des résultats précis. Si vous avez spécifié l’emplacement de l’utilisateur à l’aide des en-têtes X-MSEdge-ClientIP et X-Search-Location, vous pouvez ignorer ce champ. Dans le cas des requêtes pour lesquelles l’emplacement de l’utilisateur doit fournir des résultats précis, comme « météo du jour » ou « restaurants proches », ce champ est défini sur true. Dans le cas des requêtes qui précisent l’emplacement (par exemple, « météo Seattle »), ce champ est défini sur false. Ce champ est également défini sur false pour les requêtes qui ne dépendent pas de la localisation, comme « meilleurs ventes ».
- is_transactional
- bool
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
Commentaires
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultez https://aka.ms/ContentUserFeedback.
Envoyer et afficher des commentaires pour