Compresr Compression-Models API

The Compression-Models API from Compresr — 2 operation(s) for compression-models.

OpenAPI Specification

compresr-compression-models-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Compresr Platform Admin Compression-Models API
  version: 1.0.0
tags:
- name: Compression-Models
paths:
  /api/compress/models:
    get:
      tags:
      - Compression-Models
      summary: List Compression Models
      description: List compression models; admin_only entries hidden for non-admins.
      operationId: list_compression_models_api_compress_models_get
      security:
      - HTTPBearer: []
      parameters:
      - name: model_type
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Model Type
      - name: X-API-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DemoDataResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/compress/models/{model_id}:
    get:
      tags:
      - Compression-Models
      summary: Get Compression Model
      description: Get a specific model. 404 (not 403) for admin_only when non-admin, to avoid leaking existence.
      operationId: get_compression_model_api_compress_models__model_id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: model_id
        in: path
        required: true
        schema:
          type: string
          title: Model Id
      - name: X-API-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DemoDataResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    SampleText:
      properties:
        name:
          type: string
          title: Name
        text:
          type: string
          title: Text
      type: object
      required:
      - name
      - text
      title: SampleText
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    DemoDataResponse:
      properties:
        success:
          type: boolean
          title: Success
          default: true
        message:
          anyOf:
          - type: string
          - type: 'null'
          title: Message
        data:
          $ref: '#/components/schemas/DemoData'
      type: object
      required:
      - data
      title: DemoDataResponse
    DemoCompressionModelOption:
      properties:
        value:
          type: string
          title: Value
        label:
          type: string
          title: Label
        description:
          type: string
          title: Description
          default: ''
        tier_scale:
          anyOf:
          - type: string
          - type: 'null'
          title: Tier Scale
      type: object
      required:
      - value
      - label
      title: DemoCompressionModelOption
    DemoData:
      properties:
        sample_texts:
          items:
            $ref: '#/components/schemas/SampleText'
          type: array
          title: Sample Texts
        compression_models:
          items:
            $ref: '#/components/schemas/DemoCompressionModelOption'
          type: array
          title: Compression Models
          default: []
      type: object
      required:
      - sample_texts
      title: DemoData
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer