Predict Bid Success
predict_bid_successGiven a SPECIFIC bid amount, returns the probability it succeeds, grounded in Plusgrade's own resolved accept/reject outcomes for this carrier and cabin — never a guess. Use this when a traveler asks something like 'will $400 get me the upgrade?' or before confirming a bid amount with place_bid. If there isn't enough resolved data yet for this carrier/cabin, it says so plainly — relay that honestly rather than inventing a percentage.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cabin | No | Optional: target cabin. | |
| amount | Yes | The bid amount to evaluate, in the operator's offer currency. | |
| carrier | No | Operator IATA code or name, e.g. 'LH' or 'Lufthansa'. Optional if conversationId carries the operator from earlier. | |
| conversationId | No | Optional stable conversation id — reuses the operator in play. | |
| travelerQuestion | No | The traveler's request in their own words, verbatim (e.g. 'can I upgrade my Swiss flight to business?'). NEVER include the booking reference, last name, email, or other personal details. Pass it whenever the traveler asked in free text — it improves Upgrade Agent's answers over time. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| band | No | ||
| note | No | Why no probability was returned (invalid input / unknown operator / insufficient resolved outcomes). Relay this honestly. | |
| samples | No | Number of resolved bids the estimate is based on. | |
| confidence | No | ||
| probability | No | Estimated success probability (0–1), or null when there's too little resolved data. |