Rank - Rank

Référence

Service:: Cognitive Services - Personalizer

API Version:: v1.0

Demande de classement Personalizer.

POST {Endpoint}/personalizer/v1.0/rank

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
Endpoint	path	True	string	Point de terminaison Cognitive Services pris en charge.

En-tête de la demande

Nom	Obligatoire	Type	Description
Ocp-Apim-Subscription-Key	True	string

Corps de la demande

Nom	Obligatoire	Type	Description
actions	True	RankableAction[]	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.
contextFeatures		object[]	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 relatives à l’utilisateur actuel, à son appareil, aux informations de profil, aux données relatives à l’heure et à la date, etc.
deferActivation		boolean	Envoyez false si l’utilisateur voit les résultats du classement. Par conséquent, Personalizer s’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 ultérieurement, ou les résultats du classement peuvent être remplacés par du code plus en aval.
eventId		string	Transmettez éventuellement un eventId qui identifie de manière unique cet événement Rank. Si la valeur est null, le service génère un eventId unique. L’eventId sera utilisé pour associer cette demande à sa récompense, ainsi que pour amorçage du générateur pseudo-aléatoire lors d’un appel Personalizer.
excludedActions		string[]	Ensemble d’ID d’action à exclure du classement.

Réponses

Nom	Type	Description
201 Created	RankResponse	Succès
Other Status Codes	ErrorResponse	Demande de classement non valide.

Sécurité

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Exemples

Successful Rank request

Sample Request

HTTP

POST {Endpoint}/personalizer/v1.0/rank


{
  "contextFeatures": [
    {
      "timeOfDay": "Morning"
    }
  ],
  "actions": [
    {
      "id": "NewsArticle",
      "features": [
        {
          "type": "News"
        }
      ]
    },
    {
      "id": "SportsArticle",
      "features": [
        {
          "type": "Sports"
        }
      ]
    },
    {
      "id": "EntertainmentArticle",
      "features": [
        {
          "type": "Entertainment"
        }
      ]
    }
  ],
  "excludedActions": [
    "SportsArticle"
  ],
  "eventId": "75269AD0-BFEE-4598-8196-C57383D38E10",
  "deferActivation": false
}

Sample Response

Status code:: 201

{
  "ranking": [
    {
      "id": "EntertainmentArticle",
      "probability": 0.8
    },
    {
      "id": "SportsArticle",
      "probability": 0
    },
    {
      "id": "NewsArticle",
      "probability": 0.2
    }
  ],
  "eventId": "75269AD0-BFEE-4598-8196-C57383D38E10",
  "rewardActionId": "EntertainmentArticle"
}

Définitions

Nom	Description
ErrorCode	Code d’erreur de haut niveau.
ErrorResponse	Utilisé pour renvoyer une erreur au client
InternalError	Objet contenant des informations plus spécifiques que l’objet parent sur l’erreur.
PersonalizerError	Objet d’erreur.
RankableAction	Action avec ses fonctionnalités associées utilisées pour le classement.
RankedAction	Action classée avec sa probabilité résultante.
RankRequest	Demandez un ensemble d’actions à classer par le service Personalizer.
RankResponse	Liste ordonnée d’actions résultante d’une demande de classement.

ErrorCode

Code d’erreur de haut niveau.

Nom	Type	Description
BadRequest	string	La demande n’a pas pu être comprise par le serveur.
InternalServerError	string	Une erreur générique s’est produite sur le serveur.
ResourceNotFound	string	La ressource demandée n’existe pas sur le serveur.

ErrorResponse

Utilisé pour renvoyer une erreur au client

Nom	Type	Description
error	PersonalizerError	Objet d’erreur.

InternalError

Objet contenant des informations plus spécifiques que l’objet parent sur l’erreur.

Nom	Type	Description
code	string	Code d’erreur détaillé.
innererror	InternalError	Objet d’erreur.

PersonalizerError

Objet d’erreur.

Nom	Type	Description
code	ErrorCode	Code d’erreur de haut niveau.
details	PersonalizerError[]	Tableau de détails sur les erreurs spécifiques qui ont conduit à cette erreur signalée.
innerError	InternalError	Détails d’erreur plus fins.
message	string	Message expliquant l’erreur signalée par le service.
target	string	Élément source d’erreur.

RankableAction

Action avec ses fonctionnalités associées utilisées pour le classement.

Nom	Type	Description
features	object[]	Liste des dictionnaires contenant des fonctionnalités.
id	string	ID de l’action.

RankedAction

Action classée avec sa probabilité résultante.

Nom	Type	Description
id	string	ID de l’action
probability	number	Probabilité de l’action

RankRequest

Demandez un ensemble d’actions à classer par le service Personalizer.

Nom	Type	Valeur par défaut	Description
actions	RankableAction[]		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.
contextFeatures	object[]		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 relatives à l’utilisateur actuel, à son appareil, aux informations de profil, aux données relatives à l’heure et à la date, etc.
deferActivation	boolean	False	Envoyez false si l’utilisateur voit les résultats du classement. Par conséquent, Personalizer s’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 ultérieurement, ou les résultats du classement peuvent être remplacés par du code plus en aval.
eventId	string		Transmettez éventuellement un eventId qui identifie de manière unique cet événement Rank. Si la valeur est null, le service génère un eventId unique. L’eventId sera utilisé pour associer cette demande à sa récompense, ainsi que pour amorçage du générateur pseudo-aléatoire lors d’un appel Personalizer.
excludedActions	string[]		Ensemble d’ID d’action à exclure du classement.

RankResponse

Liste ordonnée d’actions résultante d’une demande de classement.

Nom	Type	Description
eventId	string	EventId pour l’aller-retour de la demande à la réponse.
ranking	RankedAction[]	Classement calculé pour la requête actuelle.
rewardActionId	string	Action choisie par le service Personalizer. Il s’agit de l’action pour laquelle signaler la récompense. Il se peut qu’il ne s’agisse pas de la première action trouvée dans « classement » si une action dans la requête en première position faisait partie des ID exclus.