> ## Documentation Index
> Fetch the complete documentation index at: https://docs.heybee.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Rlhf Preferences

> Per-axis pairwise human preferences as (preferred, rejected) tuples joinable to media.



## OpenAPI

````yaml /openapi.json get /v1/rlhf/experiments/{experiment_id}/preferences
openapi: 3.1.0
info:
  description: Customer-owned evaluation lifecycle API.
  title: HeyBee Public API
  version: 1.0.0
servers:
  - description: Production
    url: https://api.heybee.app
security: []
paths:
  /v1/rlhf/experiments/{experiment_id}/preferences:
    get:
      tags:
        - RLHF
      summary: Get Rlhf Preferences
      description: >-
        Per-axis pairwise human preferences as (preferred, rejected) tuples
        joinable to media.
      operationId: get_rlhf_preferences_v1_rlhf_experiments__experiment_id__preferences_get
      parameters:
        - in: path
          name: experiment_id
          required: true
          schema:
            format: uuid
            title: Experiment Id
            type: string
        - description: Restrict to a single axis.
          in: query
          name: axis_key
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Restrict to a single axis.
            title: Axis Key
        - description: Include invalidated votes.
          in: query
          name: include_invalidated
          required: false
          schema:
            default: false
            description: Include invalidated votes.
            title: Include Invalidated
            type: boolean
        - description: Include tie/both_bad/cannot_tell outcomes (no preference signal).
          in: query
          name: include_nondecisive
          required: false
          schema:
            default: false
            description: Include tie/both_bad/cannot_tell outcomes (no preference signal).
            title: Include Nondecisive
            type: boolean
        - description: Restrict to votes involving a sample from this rlhf_loop round.
          in: query
          name: round_id
          required: false
          schema:
            anyOf:
              - format: uuid
                type: string
              - type: 'null'
            description: Restrict to votes involving a sample from this rlhf_loop round.
            title: Round Id
        - in: query
          name: limit
          required: false
          schema:
            default: 20000
            maximum: 100000
            minimum: 1
            title: Limit
            type: integer
        - in: header
          name: authorization
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
        - in: header
          name: X-API-Key
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Api-Key
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RlhfPreferencesResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - BearerAuth: []
        - ApiKeyAuth: []
components:
  schemas:
    RlhfPreferencesResponse:
      properties:
        axes:
          items:
            type: string
          title: Axes
          type: array
        experiment_id:
          title: Experiment Id
          type: string
        preferences:
          items:
            $ref: '#/components/schemas/RlhfPreferencePair'
          title: Preferences
          type: array
        summary:
          items:
            $ref: '#/components/schemas/RlhfAxisSummary'
          title: Summary
          type: array
        total_returned:
          title: Total Returned
          type: integer
        truncated:
          title: Truncated
          type: boolean
      required:
        - experiment_id
        - axes
        - summary
        - total_returned
        - truncated
        - preferences
      title: RlhfPreferencesResponse
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    RlhfPreferencePair:
      description: >-
        One per-axis human preference: a (preferred, rejected) pair on one
        criterion.
      properties:
        axis_key:
          title: Axis Key
          type: string
        counted_for_ranking:
          default: false
          title: Counted For Ranking
          type: boolean
        created_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Created At
        effective_reliability:
          anyOf:
            - type: number
            - type: 'null'
          title: Effective Reliability
        feedback:
          anyOf:
            - type: string
            - type: 'null'
          title: Feedback
        outcome:
          title: Outcome
          type: string
        preferred_sample_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Preferred Sample Id
        rejected_sample_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Rejected Sample Id
        reliability_weight:
          anyOf:
            - type: number
            - type: 'null'
          title: Reliability Weight
        sample_a:
          $ref: '#/components/schemas/RlhfSampleRef'
        sample_b:
          $ref: '#/components/schemas/RlhfSampleRef'
        vote_id:
          title: Vote Id
          type: string
      required:
        - vote_id
        - axis_key
        - outcome
        - sample_a
        - sample_b
      title: RlhfPreferencePair
      type: object
    RlhfAxisSummary:
      description: >-
        Per-axis labeled-pair volume across the whole experiment (independent of
        paging).
      properties:
        axis_key:
          title: Axis Key
          type: string
        decisive:
          title: Decisive
          type: integer
        nondecisive:
          title: Nondecisive
          type: integer
      required:
        - axis_key
        - decisive
        - nondecisive
      title: RlhfAxisSummary
      type: object
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
    RlhfSampleRef:
      description: >-
        A sample side of a comparison, joined back to its media and generation
        inputs.
      properties:
        anchor_value:
          anyOf:
            - type: string
            - type: 'null'
          title: Anchor Value
        candidate_key:
          anyOf:
            - type: string
            - type: 'null'
          title: Candidate Key
        file_path:
          anyOf:
            - type: string
            - type: 'null'
          title: File Path
        id:
          title: Id
          type: string
        parameters:
          additionalProperties: true
          title: Parameters
          type: object
      required:
        - id
      title: RlhfSampleRef
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: Supabase JWT
      scheme: bearer
      type: http
    ApiKeyAuth:
      in: header
      name: X-API-Key
      type: apiKey

````