Contextual AI LMUnit API

openapi: 3.2.0
info:
  title: Contextual Ai /lmunit API
  version: '1.0'
  description: 'Operations tagged /lmunit across 2 of this provider''s published API definitions: contextual-ai-openapi.json, contextual-ai-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.contextual.ai/v1
tags:
- name: /lmunit
paths:
  /lmunit:
    post:
      tags:
      - /lmunit
      summary: LMUnit
      description: 'Given a `query`, `response`, and a `unit_test`, return the response''s `score` on the unit test on a 5-point continuous scale. The total input cannot exceed 7000 tokens.


        See a code example in our blog post. Email lmunit-feedback@contextual.ai with any feedback or questions.


        >🚀 Obtain an LMUnit API key by completing this form'
      operationId: lmunit_lmunit_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LMUnitRequestV1'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LMUnitResponseV1'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - BearerAuth: []
    servers:
    - url: https://api.contextual.ai/v1
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
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    LMUnitRequestV1:
      properties:
        query:
          type: string
          title: Query
          description: The prompt to which the model responds
        response:
          type: string
          title: Response
          description: The model response to evaluate
        unit_test:
          type: string
          title: Unit Test
          description: A natural language statement or question against which to evaluate the response
      additionalProperties: false
      type: object
      required:
      - query
      - response
      - unit_test
      title: LMUnitRequestV1
      description: LMUnit input request object.
    LMUnitResponseV1:
      properties:
        score:
          type: number
          title: Score
          description: The response is scored on a continuous scale from 1 to 5 on the unit test. The discrete scores 1, 2, 3, 4, and 5 roughly correspond to "Strongly fails," "Fails," "Neutral," "Passes," and "Strongly passes," respectively.
      type: object
      required:
      - score
      title: LMUnitResponseV1
      description: LMUnit result object.
    LMUnitRequest:
      type: object
      required:
      - query
      - response
      - unit_test
      properties:
        query:
          type: string
          description: The prompt to which the model responds.
        response:
          type: string
          description: The model response to evaluate.
        unit_test:
          type: string
          description: Natural-language statement to evaluate the response against.
    HTTPValidationError_2:
      type: object
      properties:
        detail:
          type: array
          items:
            $ref: '#/components/schemas/ValidationErrorDetail'
    LMUnitResponse:
      type: object
      properties:
        score:
          type: number
          minimum: 1
          maximum: 5
          description: Continuous score from 1 (strongly fails) to 5 (strongly passes).
    ValidationErrorDetail:
      type: object
      properties:
        loc:
          type: array
          items:
            oneOf:
            - type: string
            - type: integer
        msg:
          type: string
        type:
          type: string
  responses:
    ValidationError:
      description: Validation error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/HTTPValidationError_2'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
    bearerAuth:
      type: http
      scheme: bearer
      description: Contextual AI API key supplied as a Bearer token.
x-refined-from:
- contextual-ai-openapi.json
- contextual-ai-openapi.yml