Uncovr Inference (V3, Backwards Compatible) API

The Inference (V3, Backwards Compatible) API from Uncovr — 1 operation(s) for inference (v3, backwards compatible).

OpenAPI Specification

uncovr-inference-v3-backwards-compatible-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Uncovr Inference (V3, Backwards Compatible) Inference (V3, Backwards Compatible) Inference (V3, Backwards Compatible) API
  version: 0.1.0
tags:
- name: Inference (V3, Backwards Compatible)
paths:
  /v1/inference/{operation}/process_embeddings:
    post:
      tags:
      - Inference (V3, Backwards Compatible)
      summary: Process Embeddings Compat
      operationId: process_embeddings_compat_v1_inference__operation__process_embeddings_post
      security:
      - HTTPBearer: []
      parameters:
      - name: operation
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/Operation'
      - name: case_id
        in: query
        required: false
        schema:
          type: string
          format: uuid
          title: Case Id
      - name: video_id
        in: query
        required: false
        schema:
          type: integer
          default: 1
          title: Video Id
      - name: user_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: User Id
      - name: device_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Device Id
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_process_embeddings_compat_v1_inference__operation__process_embeddings_post'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/IngestionResponse'
                - $ref: '#/components/schemas/IngestionErrorResponse'
                - $ref: '#/components/schemas/IngestionAcceptedResponse'
                title: Response Process Embeddings Compat V1 Inference  Operation  Process Embeddings Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
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
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    IngestionResponse:
      properties:
        report:
          anyOf:
          - type: string
          - type: 'null'
          title: Report
        assessments:
          anyOf:
          - items:
              $ref: '#/components/schemas/CaseAssessment'
            type: array
          - type: 'null'
          title: Assessments
      type: object
      title: IngestionResponse
    Body_process_embeddings_compat_v1_inference__operation__process_embeddings_post:
      properties:
        file:
          type: string
          contentMediaType: application/octet-stream
          title: File
      type: object
      required:
      - file
      title: Body_process_embeddings_compat_v1_inference__operation__process_embeddings_post
    Operation:
      type: string
      enum:
      - cholecystectomy
      - hiatal-hernia
      title: Operation
      description: List of supported operations.
    IngestionErrorResponse:
      properties:
        error_code:
          type: string
          title: Error Code
        detail:
          type: string
          title: Detail
      type: object
      required:
      - error_code
      - detail
      title: IngestionErrorResponse
    CaseAssessment:
      properties:
        name:
          type: string
          title: Name
        finding:
          type: string
          title: Finding
        severity:
          anyOf:
          - type: string
            enum:
            - normal
            - mild
            - moderate
            - severe
          - type: 'null'
          title: Severity
        evidence_frame:
          anyOf:
          - type: integer
          - type: 'null'
          title: Evidence Frame
        rationale:
          anyOf:
          - type: string
          - type: 'null'
          title: Rationale
      type: object
      required:
      - name
      - finding
      title: CaseAssessment
      description: A qualitative verdict about one entity/aspect of the case (not a time span).
    IngestionAcceptedResponse:
      properties:
        code:
          type: string
          title: Code
          default: ingestion_accepted
        detail:
          type: string
          title: Detail
          default: Input accepted and submitted for processing.
      type: object
      title: IngestionAcceptedResponse
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer