class Azure::CognitiveServices::Personalizer::V1_0::Models::RankResponse

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

Attributes

event_id[RW]

@return [String] The eventId for the round trip from request to response.

ranking[RW]

@return [Array<RankedAction>] The calculated ranking for the current request.

reward_action_id[RW]

@return [String] 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.

Public Class Methods

mapper() click to toggle source

Mapper for RankResponse class as Ruby Hash. This will be used for serialization/deserialization.

# File lib/v1.0/generated/azure_cognitiveservices_personalizer/models/rank_response.rb, line 34
def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'RankResponse',
    type: {
      name: 'Composite',
      class_name: 'RankResponse',
      model_properties: {
        ranking: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'ranking',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'RankedActionElementType',
                type: {
                  name: 'Composite',
                  class_name: 'RankedAction'
                }
            }
          }
        },
        event_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'eventId',
          constraints: {
            MaxLength: 256
          },
          type: {
            name: 'String'
          }
        },
        reward_action_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'rewardActionId',
          constraints: {
            MaxLength: 256
          },
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end