Share via

RankResponse interface

Package:
@azure/cognitiveservices-personalizer

A resulting ordered list of actions that result from a rank request.

Properties

eventId

The eventId for the round trip from request to response. NOTE: This property will not be serialized. It can only be populated by the server.
ranking

The calculated ranking for the current request. NOTE: This property will not be serialized. It can only be populated by the server.
rewardActionId

The action chosen by the Personalizer service. This is the action for which to report the reward. This might not be the first found in 'ranking' if an action in the request in first position was part of the excluded ids. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

eventId

The eventId for the round trip from request to response. NOTE: This property will not be serialized. It can only be populated by the server.

eventId?: string

Property Value

string

ranking

The calculated ranking for the current request. NOTE: This property will not be serialized. It can only be populated by the server.

ranking?: RankedAction[]

Property Value

RankedAction[]

rewardActionId

The action chosen by the Personalizer service. This is the action for which to report the reward. This might not be the first found in 'ranking' if an action in the request in first position was part of the excluded ids. NOTE: This property will not be serialized. It can only be populated by the server.

rewardActionId?: string

Property Value

string