Events - Reward

Usługa:

Cognitive Services - Personalizer

Wersja interfejsu API:

v1.0

Zgłoś nagrodę, aby przydzielić do najwyżej sklasyfikowanych akcji dla określonego zdarzenia.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
Endpoint	path	True	string	Obsługiwany punkt końcowy usług Cognitive Services.
eventId	path	True	string	Identyfikator wydarzenia, do których ma zastosowanie ta nagroda.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Ocp-Apim-Subscription-Key	True	string

Treść żądania

Nazwa	Wymagane	Typ	Opis
value	True	number	Nagroda do przypisania do akcji. Wartość powinna należeć do przedziału od -1 do 1 włącznie.

Odpowiedzi

Nazwa	Typ	Opis
204 No Content		Powodzenie
Other Status Codes	ErrorResponse	Nieprawidłowe żądanie nagrody.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Typ: apiKey
W: header

Przykłady

Successful Events_Reward request

Przykładowe żądanie

HTTP

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


{
  "value": 1
}

Przykładowa odpowiedź

Kod stanu:

204

Definicje

Nazwa	Opis
ErrorCode	Kod błędu wysokiego poziomu.
ErrorResponse	Służy do zwracania błędu do klienta
InternalError	Obiekt zawierający bardziej szczegółowe informacje niż obiekt nadrzędny o błędzie.
PersonalizerError	Obiekt error.
RewardRequest	Nagroda udzielona odpowiedzi na rangę.

ErrorCode

Kod błędu wysokiego poziomu.

Nazwa	Typ	Opis
BadRequest	string	Serwer nie może zrozumieć żądania.
InternalServerError	string	Wystąpił błąd ogólny na serwerze.
ResourceNotFound	string	Żądany zasób nie istnieje na serwerze.

ErrorResponse

Służy do zwracania błędu do klienta

Nazwa	Typ	Opis
error	PersonalizerError	Obiekt error.

InternalError

Obiekt zawierający bardziej szczegółowe informacje niż obiekt nadrzędny o błędzie.

Nazwa	Typ	Opis
code	string	Szczegółowy kod błędu.
innererror	InternalError	Obiekt error.

PersonalizerError

Obiekt error.

Nazwa	Typ	Opis
code	ErrorCode	Kod błędu wysokiego poziomu.
details	PersonalizerError[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innerError	InternalError	Bardziej szczegółowe informacje o błędzie.
message	string	Komunikat wyjaśniający błąd zgłoszony przez usługę.
target	string	Element źródłowy błędu.

RewardRequest

Nagroda udzielona odpowiedzi na rangę.

Nazwa	Typ	Opis
value	number	Nagroda do przypisania do akcji. Wartość powinna należeć do przedziału od -1 do 1 włącznie.