Events - Reward

Service:

Cognitive Services - Personalizer

Version d'API:

v1.0

Indiquer la récompense à allouer à l’action classée en premier en fonction pour l’événement spécifié.

POST {Endpoint}/personalizer/v1.0/events/{eventId}/reward

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
Endpoint	path	True	string	Point de terminaison Cognitive Services pris en charge.
eventId	path	True	string	ID d’événement à laquelle cette récompense s’applique.

En-tête de la demande

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

Corps de la demande

Nom	Obligatoire	Type	Description
value	True	number	Récompense à affecter à une action. La valeur doit être comprise entre -1 et 1 inclus.

Réponses

Nom	Type	Description
204 No Content		Succès
Other Status Codes	ErrorResponse	Demande de récompense non valide.

Sécurité

Ocp-Apim-Subscription-Key

Type: apiKey
Dans: header

Exemples

Successful Events_Reward request

Exemple de requête

HTTP

POST {Endpoint}/personalizer/v1.0/events/id/reward


{
  "value": 1
}

Exemple de réponse

Code d’état:

204

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.
RewardRequest	Récompense donnée à une réponse 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.

RewardRequest

Récompense donnée à une réponse de classement.

Nom	Type	Description
value	number	Récompense à affecter à une action. La valeur doit être comprise entre -1 et 1 inclus.