Events - Reward

Servicio:

Cognitive Services - Personalizer

Versión de la API:

v1.0

Informe de la recompensa que se asignará a la principal acción para el evento especificado.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
Endpoint	path	True	string	Punto de conexión de Cognitive Services compatible.
eventId	path	True	string	El identificador de evento al que se aplica esta recompensa.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
value	True	number	Recompensa que se va a asignar a una acción. El valor debe estar comprendido entre -1 y 1 inclusive.

Respuestas

Nombre	Tipo	Description
204 No Content		Correcto
Other Status Codes	ErrorResponse	Solicitud de recompensa no válida.

Seguridad

Ocp-Apim-Subscription-Key

Tipo: apiKey
En: header

Ejemplos

Successful Events_Reward request

Solicitud de ejemplo

HTTP

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


{
  "value": 1
}

Respuesta de muestra

status code:

204

Definiciones

Nombre	Description
ErrorCode	Código de error de alto nivel.
ErrorResponse	Se usa para devolver un error al cliente
InternalError	Objeto que contiene información más específica que el objeto primario sobre el error.
PersonalizerError	Objeto de error.
RewardRequest	Recompensa dada a una respuesta de clasificación.

ErrorCode

Código de error de alto nivel.

Nombre	Tipo	Description
BadRequest	string	El servidor no pudo entender la solicitud.
InternalServerError	string	Se ha producido un error genérico en el servidor.
ResourceNotFound	string	El recurso solicitado no existe en el servidor.

ErrorResponse

Se usa para devolver un error al cliente

Nombre	Tipo	Description
error	PersonalizerError	Objeto de error.

InternalError

Objeto que contiene información más específica que el objeto primario sobre el error.

Nombre	Tipo	Description
code	string	Código de error detallado.
innererror	InternalError	Objeto de error.

PersonalizerError

Objeto de error.

Nombre	Tipo	Description
code	ErrorCode	Código de error de alto nivel.
details	PersonalizerError[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innerError	InternalError	Detalles del error más fino.
message	string	Mensaje que explica el error notificado por el servicio.
target	string	Elemento de origen de error.

RewardRequest

Recompensa dada a una respuesta de clasificación.

Nombre	Tipo	Description
value	number	Recompensa que se va a asignar a una acción. El valor debe estar comprendido entre -1 y 1 inclusive.