通过

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

Rank - Rank

  • 参考
服务:
Azure AI Services
API 版本:
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

maxLength: 256

（可选）传递唯一标识此 Rank 事件的 eventId。 如果为 null，服务将生成唯一的 eventId。 eventId 将用于将此请求与其奖励相关联，以及在进行个性化体验创建服务调用时种子设定伪随机生成器。
excludedActions

string[]

要从排名中排除的作 ID 集。

响应

名称 类型 说明
201 Created

RankResponse

成功
Other Status Codes

ErrorResponse

排名请求无效。

安全性

Ocp-Apim-Subscription-Key

类型: apiKey
在: header

示例

Successful Rank request

示例请求

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
}

示例响应

状态代码:
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

服务器无法理解请求。
InternalServerError

服务器上发生了一般错误。
ResourceNotFound

服务器上不存在请求的资源。

ErrorResponse

Object

用于向客户端返回错误

名称 类型 说明
error

PersonalizerError

错误对象。

InternalError

Object

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

名称 类型 说明
code

string

详细的错误代码。
innererror

InternalError

错误对象。

PersonalizerError

Object

错误对象。

名称 类型 说明
code

ErrorCode

高级错误代码。
details

PersonalizerError[]

导致此报告错误的特定错误的详细信息数组。
innerError

InternalError

更精细的错误详细信息。
message

string

说明服务报告的错误的消息。
target

string

错误源元素。

RankableAction

Object

具有其关联功能的作用于排名。

名称 类型 说明
features

object[]

包含功能的字典列表。
id

string

maxLength: 256

作的 ID。

RankedAction

Object

一个排名作，其生成的概率。

名称 类型 说明
id

string

maxLength: 256

作的 ID
probability

number (float)

minimum: 0
maximum: 1

作的概率

RankRequest

Object

请求一组由个性化体验创建服务排名的作。

名称 类型 默认值 说明
actions

RankableAction[]

个性化体验创建服务可从中选择的一组作。 该集不应包含超过 50 个作。 作的顺序不会影响排名结果，但顺序应与应用程序用来显示它们的序列匹配。
contextFeatures

object[]

用作个性化体验创建服务字典的上下文功能。 这取决于应用程序，通常包括有关当前用户的功能、其设备、配置文件信息、有关时间和日期的数据等。
deferActivation

boolean

False

如果用户将看到排名结果，则发送 false，因此个性化体验创建服务需要奖励调用，否则它将将默认奖励分配给事件。 如果用户可能看不到排名结果，则发送 true，因为页面稍后正在呈现，或者排名结果可能被代码进一步下游重写。
eventId

string

maxLength: 256

（可选）传递唯一标识此 Rank 事件的 eventId。 如果为 null，服务将生成唯一的 eventId。 eventId 将用于将此请求与其奖励相关联，以及在进行个性化体验创建服务调用时种子设定伪随机生成器。
excludedActions

string[]

要从排名中排除的作 ID 集。

RankResponse

Object

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

名称 类型 说明
eventId

string

maxLength: 256

往返请求到响应的 eventId。
ranking

RankedAction[]

当前请求的计算排名。
rewardActionId

string

maxLength: 256

个性化体验创建服务选择的作。 这是报告奖励的作。 如果第一个位置的请求中的作是排除 ID 的一部分，则可能不是在“排名”中找到的第一个。