Events - Reward

Serviço:

Cognitive Services - Personalizer

Versão da API:

v1.0

Reporte a recompensa para alocar à ação mais bem classificada para o evento especificado.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
Endpoint	path	True	string	Ponto final dos Serviços Cognitivos suportado.
eventId	path	True	string	O ID do evento a que esta recompensa se aplica.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Corpo do Pedido

Name	Necessário	Tipo	Description
value	True	number	Recompensa a ser atribuída a uma ação. O valor deve estar entre -1 e 1 inclusive.

Respostas

Name	Tipo	Description
204 No Content		Com êxito
Other Status Codes	ErrorResponse	Pedido de recompensa inválido.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

Exemplos

Successful Events_Reward request

Pedido de amostra

HTTP

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


{
  "value": 1
}

Resposta da amostra

Código de estado:

204

Definições

Name	Description
ErrorCode	Código de erro de alto nível.
ErrorResponse	Utilizado para devolver um erro ao cliente
InternalError	Um objeto que contém informações mais específicas do que o objeto principal sobre o erro.
PersonalizerError	O objeto de erro.
RewardRequest	Recompensa dada a uma resposta de classificação.

ErrorCode

Código de erro de alto nível.

Name	Tipo	Description
BadRequest	string	Não foi possível compreender o pedido pelo servidor.
InternalServerError	string	Ocorreu um erro genérico no servidor.
ResourceNotFound	string	O recurso pedido não existe no servidor.

ErrorResponse

Utilizado para devolver um erro ao cliente

Name	Tipo	Description
error	PersonalizerError	O objeto de erro.

InternalError

Um objeto que contém informações mais específicas do que o objeto principal sobre o erro.

Name	Tipo	Description
code	string	Código de erro detalhado.
innererror	InternalError	O objeto de erro.

PersonalizerError

O objeto de erro.

Name	Tipo	Description
code	ErrorCode	Código de erro de alto nível.
details	PersonalizerError[]	Uma matriz de detalhes sobre erros específicos que levaram a este erro reportado.
innerError	InternalError	Detalhes de erros mais detalhados.
message	string	Uma mensagem a explicar o erro comunicado pelo serviço.
target	string	Elemento de origem do erro.

RewardRequest

Recompensa dada a uma resposta de classificação.

Name	Tipo	Description
value	number	Recompensa a ser atribuída a uma ação. O valor deve estar entre -1 e 1 inclusive.