Поделиться через

Events - Reward

  • Ссылка
Служба:
Azure AI Services
Версия API:
v1.0

Создание отчета о вознаграждении, которое будет выделено для действий с наивысшим рейтингом для указанного события.

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

Параметры URI

Имя В Обязательно Тип Описание
Endpoint
 path True

string

Поддерживаемая конечная точка Cognitive Services.
eventId
 path True

string

maxLength: 256

Идентификатор события, к этому вознаграждению применяется.

Заголовок запроса

Имя Обязательно Тип Описание
Ocp-Apim-Subscription-Key True

string

Текст запроса

Имя Обязательно Тип Описание
value True

number (float)

Вознаграждение, назначаемое действу. Значение должно быть от -1 до 1 включительно.

Ответы

Имя Тип Описание
204 No Content

Успех
Other Status Codes

ErrorResponse

Недопустимый запрос вознаграждения.

Безопасность

Ocp-Apim-Subscription-Key

Тип: apiKey
В: header

Примеры

Successful Events_Reward request

Образец запроса

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


{
  "value": 1
}

Пример ответа

Код состояния:
204

Определения

Имя Описание
ErrorCode

Код ошибки высокого уровня.
ErrorResponse

Используется для возврата ошибки клиенту
InternalError

Объект, содержащий более конкретные сведения, чем родительский объект об ошибке.
PersonalizerError

Объект ошибки.
RewardRequest

Вознаграждение, предоставленное ответу ранжирования.

ErrorCode

Перечисление

Код ошибки высокого уровня.

Значение Описание
BadRequest

Запрос не может быть понят сервером.
InternalServerError

На сервере произошла универсальная ошибка.
ResourceNotFound

Запрошенный ресурс не существует на сервере.

ErrorResponse

Object

Используется для возврата ошибки клиенту

Имя Тип Описание
error

PersonalizerError

Объект ошибки.

InternalError

Object

Объект, содержащий более конкретные сведения, чем родительский объект об ошибке.

Имя Тип Описание
code

string

Подробный код ошибки.
innererror

InternalError

Объект ошибки.

PersonalizerError

Object

Объект ошибки.

Имя Тип Описание
code

ErrorCode

Код ошибки высокого уровня.
details

PersonalizerError[]

Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.
innerError

InternalError

Подробные сведения об ошибке.
message

string

Сообщение, объясняющее ошибку, сообщаемую службой.
target

string

Элемент источника ошибки.

RewardRequest

Object

Вознаграждение, предоставленное ответу ранжирования.

Имя Тип Описание
value

number (float)

Вознаграждение, назначаемое действу. Значение должно быть от -1 до 1 включительно.