Skip to content

Latest commit

 

History

History
187 lines (127 loc) · 7.57 KB

ranking-details.schema.md

File metadata and controls

187 lines (127 loc) · 7.57 KB
Raw

Ranking Details Schema

https://ns.adobe.com/experience/decisioning/ranking-details

A ranking produces the order in which one option is selected over another. A fixed absolute priority can be used in case there is no other function known that maps a decsion option to an ordinal value.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Stable No Forbidden Permitted adobe/experience/decisioning/ranking-details.schema.json

Ranking Details Example

{
  "https://ns.adobe.com/experience/decisioning/priority": 3,
  "https://ns.adobe.com/experience/decisioning/order": {
    "https://ns.adobe.com/experience/decisioning/function": "xcore:ranking-function:b437a2403cf10e9"
  }
}

Ranking Details Properties

Property Type Required Default Defined by
xdm:order complex Optional Ranking Details (this schema)
xdm:priority integer Optional 0 Ranking Details (this schema)
* any Additional this schema allows additional properties

xdm:order

Order Evaluation

Evaluation of a relative order of one or more decision options. Options with higher ordinal values are selected over any options with lower ordinal values. The values determined by this method can be ordered but distances between them cannot be measured and neither can sums nor products be calculated. The median and the mode are the only measures of central tendency that can be used for ordinal data.

xdm:order

  • is optional
  • type: complex
  • defined in this schema

xdm:order Type

Unknown type ``.

{
  "properties": {
    "xdm:orderEvaluationType": {
      "type": "string",
      "title": "Order Evaluation Type",
      "enum": [
        "static",
        "scoringFunction",
        "rankingStrategy"
      ],
      "description": "Specifies which order evaluation mechanism is used, static priority of the decision options, a scoring function that calculates a  numeric value for every option or a ranking strategy that receives a list to order it.",
      "meta:titleId": "ranking-details##xdm:orderEvaluationType##title##8401",
      "meta:descriptionId": "ranking-details##xdm:orderEvaluationType##description##94251",
      "meta:enum": {
        "static": "Static",
        "scoringFunction": "Scoring Function",
        "rankingStrategy": "Ranking Strategy"
      }
    },
    "xdm:function": {
      "type": "string",
      "format": "uri-reference",
      "title": "Scoring Function",
      "description": "A reference to a function that computes a numerical score for this decision option. Decision options will then be ordered (ranked) by that score. The value of this property is the URI (@id) of the function to be invoked with on option at a time. See schema https://ns.adobe.com/experience/decisioning/function",
      "meta:titleId": "ranking-details##xdm:function##title##82741",
      "meta:descriptionId": "ranking-details##xdm:function##description##19361"
    },
    "xdm:rankingStrategy": {
      "type": "string",
      "format": "uri-reference",
      "title": "Ranking Strategy",
      "description": "A reference to a strategy that ranks a list of decision option. Decision options will be returned in an ordered list. The value of this property is the URI (@id) of the function to be invoked with on option at a time. See schema https://ns.adobe.com/experience/decisioning/rankingStrategy",
      "meta:titleId": "ranking-details##xdm:rankingStrategy##title##64321",
      "meta:descriptionId": "ranking-details##xdm:rankingStrategy##description##89241"
    }
  },
  "title": "Order Evaluation",
  "description": "Evaluation of a relative order of one or more decision options. Options with higher ordinal values are selected over any options with lower ordinal values. The values determined by this method can be ordered but distances between them cannot be measured and neither can sums nor products be calculated. The median and the mode are the only measures of central tendency that can be used for ordinal data.",
  "meta:titleId": "ranking-details##xdm:order##title##41541",
  "meta:descriptionId": "ranking-details##xdm:order##description##41601",
  "simpletype": "complex"
}

xdm:priority

Priority

The priority of a single decision option relative to all other options. Options for which no order function is given are prioritized using this propery. Options with higher priority values are selected before any lower priority options. If two or more qualifying options share the highest priority value, one is chosen at uniform random and used for the decision proposition.

xdm:priority

  • is optional
  • type: integer
  • default: 0
  • defined in this schema

xdm:priority Type

integer

  • minimum value: 0

Ranking Details Definitions

Property Type Group
xdm:function string https://ns.adobe.com/experience/decisioning/ranking-details#/definitions/order-evaluation
xdm:orderEvaluationType enum https://ns.adobe.com/experience/decisioning/ranking-details#/definitions/order-evaluation
xdm:rankingStrategy string https://ns.adobe.com/experience/decisioning/ranking-details#/definitions/order-evaluation

xdm:function

Scoring Function

A reference to a function that computes a numerical score for this decision option. Decision options will then be ordered (ranked) by that score. The value of this property is the URI (@id) of the function to be invoked with on option at a time. See schema https://ns.adobe.com/experience/decisioning/function

xdm:function

  • is optional
  • type: string
  • defined in this schema

xdm:function Type

string

  • format: uri-reference – URI Reference (according to RFC3986)

xdm:orderEvaluationType

Order Evaluation Type

Specifies which order evaluation mechanism is used, static priority of the decision options, a scoring function that calculates a numeric value for every option or a ranking strategy that receives a list to order it.

xdm:orderEvaluationType

  • is optional
  • type: enum
  • defined in this schema

The value of this property must be equal to one of the known values below.

xdm:orderEvaluationType Known Values

Value Description
static Static
scoringFunction Scoring Function
rankingStrategy Ranking Strategy

xdm:rankingStrategy

Ranking Strategy

A reference to a strategy that ranks a list of decision option. Decision options will be returned in an ordered list. The value of this property is the URI (@id) of the function to be invoked with on option at a time. See schema https://ns.adobe.com/experience/decisioning/rankingStrategy

xdm:rankingStrategy

  • is optional
  • type: string
  • defined in this schema

xdm:rankingStrategy Type

string

  • format: uri-reference – URI Reference (according to RFC3986)