Events - Reward

Servizio:

Azure AI Services

Versione API:

v1.0

Segnalare la ricompensa da allocare all'azione classificata più in alto per l'evento specificato.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
Endpoint	path	True	string	Endpoint di Servizi cognitivi supportato.
eventId	path	True	string maxLength: 256	ID evento a cui si applica questa ricompensa.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
Ocp-Apim-Subscription-Key	True	string

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
value	True	number (float)	Ricompensa da assegnare a un'azione. Il valore deve essere compreso tra -1 e 1 inclusi.

Risposte

Nome	Tipo	Descrizione
204 No Content		Successo
Other Status Codes	ErrorResponse	Richiesta di ricompensa non valida.

Sicurezza

Ocp-Apim-Subscription-Key

Tipo: apiKey
In: header

Esempio

Successful Events_Reward request

Esempio di richiesta

HTTP

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


{
  "value": 1
}

Risposta di esempio

Codice di stato:

204

Definizioni

Nome	Descrizione
ErrorCode	Codice di errore di alto livello.
ErrorResponse	Usato per restituire un errore al client
InternalError	Oggetto contenente informazioni più specifiche dell'oggetto padre sull'errore.
PersonalizerError	Oggetto error.
RewardRequest	Ricompensa assegnata a una risposta di classificazione.

ErrorCode

Enumerazione

Codice di errore di alto livello.

Valore	Descrizione
BadRequest	Impossibile comprendere la richiesta dal server.
InternalServerError	Si è verificato un errore generico nel server.
ResourceNotFound	La risorsa richiesta non esiste nel server.

ErrorResponse

Object

Usato per restituire un errore al client

Nome	Tipo	Descrizione
error	PersonalizerError	Oggetto error.

InternalError

Object

Oggetto contenente informazioni più specifiche dell'oggetto padre sull'errore.

Nome	Tipo	Descrizione
code	string	Codice di errore dettagliato.
innererror	InternalError	Oggetto error.

PersonalizerError

Object

Oggetto error.

Nome	Tipo	Descrizione
code	ErrorCode	Codice di errore di alto livello.
details	PersonalizerError[]	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innerError	InternalError	Dettagli dell'errore più corretto.
message	string	Messaggio che spiega l'errore segnalato dal servizio.
target	string	Elemento di origine dell'errore.

RewardRequest

Object

Ricompensa assegnata a una risposta di classificazione.

Nome	Tipo	Descrizione
value	number (float)	Ricompensa da assegnare a un'azione. Il valore deve essere compreso tra -1 e 1 inclusi.