Audiala Rerank Candidates API

openapi: 3.2.0
info:
  title: MarcoPolo Rerank Candidates API
  description: API for the MarcoPolo application
  version: 0.1.0
tags:
- name: Rerank Candidates
paths:
  /rerank-candidates:
    post:
      summary: Rerank Candidates
      description: 'Voyage rerank-2.5 over a caller-supplied candidate set.


        Stage B of the Today recommender plan: iOS assembles a hybrid candidate

        pool (rating + category-mapped + Voyage k-NN) client-side and asks this

        endpoint to score them with a cross-encoder. Two-stage retrieval —

        rerank ordering is the final relevance signal callers should sort by.'
      operationId: rerank_candidates_rerank_candidates_post
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: x-internal-token
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Internal-Token
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RerankCandidatesRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RerankCandidatesResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Rerank Candidates
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    RerankCandidatesRequest:
      properties:
        city_id:
          type: string
          title: City Id
          description: Wikidata city ID, e.g. Q90
        query:
          type: string
          title: Query
          description: 'Natural-language taste query as iOS sends it: ''interest1; interest2; traveling_with=family friendly, easy with children'''
        candidate_ids:
          items:
            type: integer
          type: array
          maxItems: 64
          minItems: 1
          title: Candidate Ids
          description: Monument row_ids to rerank
        top_k:
          type: integer
          maximum: 64.0
          minimum: 1.0
          title: Top K
          description: How many top-ranked candidates to return
          default: 8
        context:
          anyOf:
          - $ref: '#/components/schemas/RerankContext'
          - type: 'null'
          description: Optional part-of-day / weather context
      type: object
      required:
      - city_id
      - query
      - candidate_ids
      title: RerankCandidatesRequest
    RerankContext:
      properties:
        part_of_day:
          anyOf:
          - type: string
          - type: 'null'
          title: Part Of Day
          description: morning | afternoon | evening | night
        weather:
          anyOf:
          - type: string
          - type: 'null'
          title: Weather
          description: Short weather summary, e.g. 'light rain, 14°C'
        local_time:
          anyOf:
          - type: string
          - type: 'null'
          title: Local Time
          description: ISO local time at the traveler, e.g. 2026-09-17T15:20
      type: object
      title: RerankContext
      description: 'Optional situational context (PRD S2.1). iOS does not send it yet; when

        absent `part_of_day` is derived from the request time in the city''s zone.'
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    RerankedCandidate:
      properties:
        row_id:
          type: integer
          title: Row Id
        relevance_score:
          type: number
          title: Relevance Score
        match_reason:
          type: string
          title: Match Reason
      type: object
      required:
      - row_id
      - relevance_score
      - match_reason
      title: RerankedCandidate
    RerankCandidatesResponse:
      properties:
        candidates:
          items:
            $ref: '#/components/schemas/RerankedCandidate'
          type: array
          title: Candidates
        timing_ms:
          additionalProperties:
            type: number
          type: object
          title: Timing Ms
        reranked:
          type: boolean
          title: Reranked
          default: false
        missing_ids:
          items:
            type: integer
          type: array
          title: Missing Ids
          default: []
        error:
          anyOf:
          - type: string
          - type: 'null'
          title: Error
        engine:
          type: string
          title: Engine
          default: voyage
        part_of_day:
          anyOf:
          - type: string
          - type: 'null'
          title: Part Of Day
      type: object
      required:
      - candidates
      - timing_ms
      title: RerankCandidatesResponse