Partilhar via

Events - Reward

  • Referência
Serviço:
Azure AI Services
Versão da API:
v1.0

Recompensa de relatório 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 de extremidade dos Serviços Cognitivos suportados.
eventId
 path True

string

maxLength: 256

O ID do evento ao qual 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 (float)

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

Sucesso
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

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

Usado para retornar um erro ao cliente
InternalError

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

O objeto de erro.
RewardRequest

Recompensa dada a uma resposta de classificação.

ErrorCode

Enumeração

Código de erro de alto nível.

Valor Description
BadRequest

A solicitação não pôde ser entendida pelo servidor.
InternalServerError

Ocorreu um erro genérico no servidor.
ResourceNotFound

O recurso solicitado não existe no servidor.

ErrorResponse

Object

Usado para retornar um erro ao cliente

Name Tipo Description
error

PersonalizerError

O objeto de erro.

InternalError

Object

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

Name Tipo Description
code

string

Código de erro detalhado.
innererror

InternalError

O objeto de erro.

PersonalizerError

Object

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 esse erro relatado.
innerError

InternalError

Detalhes de erro mais finos.
message

string

Uma mensagem explicando o erro relatado pelo serviço.
target

string

Elemento de origem do erro.

RewardRequest

Object

Recompensa dada a uma resposta de classificação.

Name Tipo Description
value

number (float)

Recompensa a ser atribuída a uma ação. O valor deve estar entre -1 e 1, inclusive.