Skip to main content

V2Recommendation

One (date, room_type) recommendation produced by the RL policy.

datedaterequired
room_typeRoom Typerequired
recommended_rateRecommended Raterequired

Possible values: Value must match regular expression ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

delta_pctDelta Pctrequired

Percent diff vs the room's current rate at compute time.

Possible values: Value must match regular expression ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

data_completenessData Completenessrequired

How much of this date's input data was present, in [0, 1]. Not a measure of how sure the model is about the rate — a fully-fed date the engine has little to say about still reports 1.0.

statusRecommendationStatus

Whether this row is a recommendation at all. PRICED is the only value carrying a rate change to act on. HELD_LOW_CONFIDENCE and INSUFFICIENT_DATA both return your current rate with delta_pct 0 — the row exists to say what happened to the date, not to be published. Check this before acting on recommended_rate: a hold is not an instruction to keep the rate, it is the absence of an instruction.

Possible values: [PRICED, INSUFFICIENT_DATA, HELD_LOW_CONFIDENCE]

Default value: PRICED
phasePhaserequired

Demand reading for the date: DISTRESSED | BUILD | YIELD | SPIKE, or NOT_MEASURED where too little is on the books for ahead or behind to mean anything — most of the far horizon. Treat it as an open string: NOT_MEASURED is the absence of a reading rather than a fifth kind of demand, and further values may be added.

drivers object[]
  • Array [
    • featureFeaturerequired

    Feature name (e.g. pace_index).

    labelLabelrequired

    Humanised feature name for display.

    impactImpactrequired

    Contribution magnitude.

    directionDirectionrequired

    up | down.

  • ]
    • guardrails object[]
  • Array [
    • codeCoderequired

    Machine-readable guardrail code.

    labelLabelrequired

    Humanised label for display.

  • ]
    • hitl_requiredHitl Required
    Default value: false
    explanation object
    anyOf
    string
    V2Recommendation
    {
      "date": "2024-07-29",
      "room_type": "string",
      "recommended_rate": "string",
      "delta_pct": "string",
      "data_completeness": 0,
      "status": "PRICED",
      "phase": "string",
      "drivers": [
        {
          "feature": "string",
          "label": "string",
          "impact": 0,
          "direction": "string"
        }
      ],
      "guardrails": [
        {
          "code": "string",
          "label": "string"
        }
      ],
      "hitl_required": false,
      "explanation": "string"
    }