Rank - Rank

Ссылка

Service:: Cognitive Services - Personalizer

API Version:: v1.0

Запрос ранжирования Персонализатора.

POST {Endpoint}/personalizer/v1.0/rank

Параметры URI

Имя	В	Обязательно	Тип	Описание
Endpoint	path	True	string	Поддерживаемая конечная точка Cognitive Services.

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

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

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

Имя	Обязательно	Тип	Описание
actions	True	RankableAction[]	Набор действий, из которых может выбрать служба Персонализатора. Набор не должен содержать более 50 действий. Порядок действий не влияет на результат ранжирования, но он должен соответствовать последовательности, которую приложение использовало бы для их отображения.
contextFeatures		object[]	Признаки контекста, используемого для Персонализатора в качестве словаря словарей. Это зависит от приложения и обычно включает функции о текущем пользователе, его устройстве, сведения о профиле, данные о времени и дате и т. д.
deferActivation		boolean	Отправьте значение false, если пользователь увидит результаты ранжирования, поэтому Персонализатор будет ожидать вызова Вознаграждения, в противном случае он назначит вознаграждение по умолчанию событию. Отправьте значение true, если это возможно, пользователь не увидит результаты ранжирования, так как страница отрисовывается позже или результаты ранжирования могут быть переопределены кодом ниже.
eventId		string	При необходимости передайте eventId, который однозначно идентифицирует это событие ранжирования. Если значение равно NULL, служба создает уникальный eventId. EventId будет использоваться для связи этого запроса с его вознаграждением, а также для заполнения псевдослучайного генератора при вызове Персонализатора.
excludedActions		string[]	Набор идентификаторов действий, исключаемых из ранжирования.

Ответы

Имя	Тип	Описание
201 Created	RankResponse	Успешное завершение
Other Status Codes	ErrorResponse	Недопустимый запрос ранжирования.

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

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Примеры

Successful Rank request

Sample Request

HTTP

POST {Endpoint}/personalizer/v1.0/rank


{
  "contextFeatures": [
    {
      "timeOfDay": "Morning"
    }
  ],
  "actions": [
    {
      "id": "NewsArticle",
      "features": [
        {
          "type": "News"
        }
      ]
    },
    {
      "id": "SportsArticle",
      "features": [
        {
          "type": "Sports"
        }
      ]
    },
    {
      "id": "EntertainmentArticle",
      "features": [
        {
          "type": "Entertainment"
        }
      ]
    }
  ],
  "excludedActions": [
    "SportsArticle"
  ],
  "eventId": "75269AD0-BFEE-4598-8196-C57383D38E10",
  "deferActivation": false
}

Sample Response

Status code:: 201

{
  "ranking": [
    {
      "id": "EntertainmentArticle",
      "probability": 0.8
    },
    {
      "id": "SportsArticle",
      "probability": 0
    },
    {
      "id": "NewsArticle",
      "probability": 0.2
    }
  ],
  "eventId": "75269AD0-BFEE-4598-8196-C57383D38E10",
  "rewardActionId": "EntertainmentArticle"
}

Определения

Имя	Описание
ErrorCode	Код ошибки высокого уровня.
ErrorResponse	Используется для возврата ошибки клиенту
InternalError	Объект, содержащий более конкретные сведения об ошибке, чем родительский объект.
PersonalizerError	Объект error.
RankableAction	Действие со связанными функциями, используемыми для ранжирования.
RankedAction	Ранжированное действие с результирующей вероятностью.
RankRequest	Запрос набора действий, которые будут ранжированы службой Персонализатора.
RankResponse	Результирующий упорядоченный список действий, полученных в результате запроса ранжирования.

ErrorCode

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

Имя	Тип	Описание
BadRequest	string	Серверу не удалось понять запрос.
InternalServerError	string	На сервере произошла ошибка, не связанная с этим запросом.
ResourceNotFound	string	Запрошенный ресурс не существует на сервере.

ErrorResponse

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

Имя	Тип	Описание
error	PersonalizerError	Объект error.

InternalError

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

Имя	Тип	Описание
code	string	Подробный код ошибки.
innererror	InternalError	Объект error.

PersonalizerError

Объект error.

Имя	Тип	Описание
code	ErrorCode	Код ошибки высокого уровня.
details	PersonalizerError[]	Массив сведений о конкретных ошибках, которые привели к этой сообщаемой ошибке.
innerError	InternalError	Более подробные сведения об ошибке.
message	string	Сообщение с объяснением ошибки, о которую сообщила служба.
target	string	Элемент источника error.

RankableAction

Действие со связанными функциями, используемыми для ранжирования.

Имя	Тип	Описание
features	object[]	Список словарей, содержащих компоненты.
id	string	Идентификатор действия.

RankedAction

Ранжированное действие с результирующей вероятностью.

Имя	Тип	Описание
id	string	Идентификатор действия
probability	number	Вероятность действия

RankRequest

Запрос набора действий, которые будут ранжированы службой Персонализатора.

Имя	Тип	Значение по умолчанию	Описание
actions	RankableAction[]		Набор действий, из которых может выбрать служба Персонализатора. Набор не должен содержать более 50 действий. Порядок действий не влияет на результат ранжирования, но он должен соответствовать последовательности, которую приложение использовало бы для их отображения.
contextFeatures	object[]		Признаки контекста, используемого для Персонализатора в качестве словаря словарей. Это зависит от приложения и обычно включает функции о текущем пользователе, его устройстве, сведения о профиле, данные о времени и дате и т. д.
deferActivation	boolean	False	Отправьте значение false, если пользователь увидит результаты ранжирования, поэтому Персонализатор будет ожидать вызова Вознаграждения, в противном случае он назначит вознаграждение по умолчанию событию. Отправьте значение true, если это возможно, пользователь не увидит результаты ранжирования, так как страница отрисовывается позже или результаты ранжирования могут быть переопределены кодом ниже.
eventId	string		При необходимости передайте eventId, который однозначно идентифицирует это событие ранжирования. Если значение равно NULL, служба создает уникальный eventId. EventId будет использоваться для связи этого запроса с его вознаграждением, а также для заполнения псевдослучайного генератора при вызове Персонализатора.
excludedActions	string[]		Набор идентификаторов действий, исключаемых из ранжирования.

RankResponse

Результирующий упорядоченный список действий, полученных в результате запроса ранжирования.

Имя	Тип	Описание
eventId	string	EventId для кругового пути от запроса к ответу.
ranking	RankedAction[]	Вычисляемое ранжирование для текущего запроса.
rewardActionId	string	Действие, выбранное службой Персонализатора. Это действие, для которого необходимо сообщить о вознаграждении. Это может быть не первым, обнаруженным в "ранжировании", если действие в запросе в первой позиции было частью исключенных идентификаторов.

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