你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Rank - Rank

参考

Service:: Cognitive Services - Personalizer

API Version:: v1.0

个性化体验创建服务排名请求。

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

URI 参数

名称	在	必需	类型	说明
Endpoint	path	True	string	支持的认知服务终结点。

请求头

名称	必需	类型	说明
Ocp-Apim-Subscription-Key	True	string

请求正文

名称	必需	类型	说明
actions	True	RankableAction[]	个性化体验创建服务可从中选择的操作集。该集包含的操作不应超过 50 个。操作的顺序不会影响排名结果，但顺序应与应用程序用于显示它们的顺序匹配。
contextFeatures		object[]	个性化体验创建服务用作字典的上下文功能。这取决于应用程序，通常包括有关当前用户、其设备、配置文件信息、有关时间和日期的数据等的功能。
deferActivation		boolean	如果用户将看到排名结果，则发送 false，因此个性化体验创建服务需要奖励调用，否则它将为事件分配默认奖励。如果用户可能看不到排名结果，则发送 true，因为页面稍后呈现，或者排名结果可能被代码在下游进一步重写。
eventId		string	（可选）传递唯一标识此 Rank 事件的 eventId。如果为 null，则服务将生成唯一的 eventId。 eventId 将用于将此请求与其奖励相关联，以及在进行个性化体验创建服务调用时为伪随机生成器设定种子。
excludedActions		string[]	要从排名中排除的操作 ID 集。

响应

名称	类型	说明
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	错误对象。
RankableAction	一个操作，其中包含用于排名的关联功能。
RankedAction	具有其生成的概率的排名操作。
RankRequest	请求一组按个性化体验创建服务进行排名的操作。
RankResponse	由排名请求生成的操作的有序列表。

ErrorCode

高级错误代码。

名称	类型	说明
BadRequest	string	服务器无法理解请求。
InternalServerError	string	服务器上发生了一般错误。
ResourceNotFound	string	服务器上不存在请求的资源。

ErrorResponse

用于向客户端返回错误

名称	类型	说明
error	PersonalizerError	错误对象。

InternalError

一个对象，该对象包含比父对象有关错误的更具体信息。

名称	类型	说明
code	string	详细的错误代码。
innererror	InternalError	错误对象。

PersonalizerError

错误对象。

名称	类型	说明
code	ErrorCode	高级错误代码。
details	PersonalizerError[]	有关导致此项报告错误的特定错误的详细信息数组。
innerError	InternalError	更精细的错误详细信息。
message	string	解释服务报告的错误的消息。
target	string	错误源元素。

RankableAction

一个操作，其中包含用于排名的关联功能。

名称	类型	说明
features	object[]	包含功能的字典列表。
id	string	操作的 ID。

RankedAction

具有其生成的概率的排名操作。

名称	类型	说明
id	string	操作的 ID
probability	number	操作的概率

RankRequest

请求一组按个性化体验创建服务进行排名的操作。

名称	类型	默认值	说明
actions	RankableAction[]		个性化体验创建服务可从中选择的操作集。该集包含的操作不应超过 50 个。操作的顺序不会影响排名结果，但顺序应与应用程序用于显示它们的顺序匹配。
contextFeatures	object[]		个性化体验创建服务用作字典的上下文功能。这取决于应用程序，通常包括有关当前用户、其设备、配置文件信息、有关时间和日期的数据等的功能。
deferActivation	boolean	False	如果用户将看到排名结果，则发送 false，因此个性化体验创建服务需要奖励调用，否则它将为事件分配默认奖励。如果用户可能看不到排名结果，则发送 true，因为页面稍后呈现，或者排名结果可能被代码在下游进一步重写。
eventId	string		（可选）传递唯一标识此 Rank 事件的 eventId。如果为 null，则服务将生成唯一的 eventId。 eventId 将用于将此请求与其奖励相关联，以及在进行个性化体验创建服务调用时为伪随机生成器设定种子。
excludedActions	string[]		要从排名中排除的操作 ID 集。

RankResponse

由排名请求生成的操作的有序列表。

名称	类型	说明
eventId	string	从请求到响应的往返的 eventId。
ranking	RankedAction[]	当前请求的计算排名。
rewardActionId	string	个性化体验创建服务选择的操作。这是要报告奖励的操作。如果请求中位于第一位置的操作是排除的 ID 的一部分，则这可能不是在“排名”中找到的第一个。