RankRequest Classe
Demandez un ensemble d’actions à classer par le service Personalizer.
Tous les paramètres requis doivent être renseignés pour pouvoir être envoyés à Azure.
- Héritage
-
RankRequest
Constructeur
RankRequest(*, actions, context_features=None, excluded_actions=None, event_id: str = None, defer_activation: bool = False, **kwargs)Paramètres
Fonctionnalités du contexte utilisé pour Personalizer en tant que dictionnaire de dictionnaires. Cela dépend de l’application et inclut généralement des fonctionnalités sur l’utilisateur actuel, son appareil, des informations de profil, des données sur l’heure et la date, etc.
- actions
- list[RankableAction]
Obligatoire. Ensemble d’actions que le service Personalizer peut choisir. L’ensemble ne doit pas contenir plus de 50 actions. L’ordre des actions n’affecte pas le résultat du classement, mais l’ordre doit correspondre à la séquence que votre application aurait utilisée pour les afficher.
- event_id
- str
Si vous le souhaitez, transmettez un eventId qui identifie de manière unique cet événement Rank. Si la valeur est null, le service génère un id d’événement unique. L’eventId sera utilisé pour associer cette requête à sa récompense, ainsi que pour amorcer le générateur pseudo-aléatoire lors d’un appel Personalizer.
- defer_activation
- bool
Envoyez false si l’utilisateur voit les résultats du classement. Par conséquent, Personalizer attend un appel de récompense, sinon il affectera la récompense par défaut à l’événement. Envoyez true s’il est possible que l’utilisateur ne voit pas les résultats du classement, car la page est rendue plus tard, ou les résultats du classement peuvent être remplacés par du code plus en aval. Valeur par défaut : False.
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
- key_transformer
- <xref:function>
Fonction de transformateur de clé.
- keep_readonly
Retours
Objet compatible JSON de dict
Type de retour
deserialize
Analysez un 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
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
- 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 une sérialisation XML, vous pouvez passer les kwargs is_xml=True.
serialize(keep_readonly=False, **kwargs)Paramètres
Retours
Objet compatible JSON de 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