openapi: 3.1.0
info:
  title: Opik REST Feedback-definitions API
  description: "The Opik REST API is currently in beta and subject to change. If you have any questions or feedback about the APIs, please reach out on GitHub: https://github.com/comet-ml/opik.\n\nAll of the methods listed in this documentation are used by either the SDK or the UI to interact with the Opik server. As a result,\nthe methods have been optimized for these use-cases in mind. If you are looking for a method that is not listed above, please create\nand issue on GitHub or raise a PR!\n\nOpik includes two main deployment options that results in slightly different API usage:\n\n- **Self-hosted Opik instance:** You will simply need to specify the URL as `http://localhost:5173/api/<endpoint_path>` or similar. This is the default option for the docs.\n- **Opik Cloud:** You will need to specify the Opik API Key and Opik Workspace in the header. The format of the header should be:\n\n  ```\n  {\n    \"Comet-Workspace\": \"your-workspace-name\",\n    \"authorization\": \"your-api-key\"\n  }\n  ```\n\n  The full payload would therefore look like:\n  \n  ```\n  curl -X GET 'https://www.comet.com/opik/api/v1/private/projects' \\\n  -H 'Accept: application/json' \\\n  -H 'Comet-Workspace: <your-workspace-name>' \\\n  -H 'authorization: <your-api-key>'\n  ```\n\n  Do take note here that the authorization header value does not include the `Bearer ` prefix. To switch to using the Opik Cloud in the documentation, you can\n  click on the edit button displayed when hovering over the `Base URL` displayed on the right hand side of the docs.\n"
  contact:
    name: Github Repository
    url: https://github.com/comet-ml/opik
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: 1.0.0
servers:
- url: http://localhost:5173/api
  description: Local server
- url: https://www.comet.com/opik/api
  description: Opik Cloud
tags:
- name: Feedback-definitions
  description: Feedback definitions related resources
paths:
  /v1/private/feedback-definitions:
    get:
      tags:
      - Feedback-definitions
      summary: Find Feedback definitions
      description: Find Feedback definitions
      operationId: findFeedbackDefinitions
      parameters:
      - name: page
        in: query
        schema:
          minimum: 1
          type: integer
          format: int32
          default: 1
      - name: size
        in: query
        schema:
          minimum: 1
          type: integer
          format: int32
          default: 10
      - name: name
        in: query
        schema:
          type: string
          description: Filter feedback definitions by name (partial match, case insensitive)
      - name: type
        in: query
        schema:
          type: string
          enum:
          - numerical
          - categorical
          - boolean
      responses:
        '200':
          description: Feedback definitions resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeedbackDefinitionPage_Public'
    post:
      tags:
      - Feedback-definitions
      summary: Create feedback definition
      description: Get feedback definition
      operationId: createFeedbackDefinition
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Feedback_Create'
      responses:
        '201':
          description: Created
          headers:
            Location:
              required: true
              style: simple
              schema:
                type: string
              example: ${basePath}/v1/private/feedback-definitions/{feedbackId}
  /v1/private/feedback-definitions/{id}:
    get:
      tags:
      - Feedback-definitions
      summary: Get feedback definition by id
      description: Get feedback definition by id
      operationId: getFeedbackDefinitionById
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Feedback definition resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Feedback_Public'
    put:
      tags:
      - Feedback-definitions
      summary: Update feedback definition by id
      description: Update feedback definition by id
      operationId: updateFeedbackDefinition
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Feedback_Update'
      responses:
        '204':
          description: No Content
    delete:
      tags:
      - Feedback-definitions
      summary: Delete feedback definition by id
      description: Delete feedback definition by id
      operationId: deleteFeedbackDefinitionById
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: No Content
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
  /v1/private/feedback-definitions/delete:
    post:
      tags:
      - Feedback-definitions
      summary: Delete feedback definitions
      description: Delete feedback definitions batch
      operationId: deleteFeedbackDefinitionsBatch
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchDelete'
      responses:
        '204':
          description: No Content
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
components:
  schemas:
    FeedbackObject_Public:
      required:
      - name
      - type
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        name:
          minLength: 1
          type: string
        description:
          maxLength: 255
          minLength: 0
          type: string
          description: Optional description for the feedback definition
          example: This feedback definition is used to rate response quality
        createdAt:
          type: string
          format: date-time
          readOnly: true
        createdBy:
          type: string
          readOnly: true
        lastUpdatedAt:
          type: string
          format: date-time
          readOnly: true
        lastUpdatedBy:
          type: string
          readOnly: true
        type:
          type: string
          enum:
          - numerical
          - categorical
          - boolean
      discriminator:
        propertyName: type
        mapping:
          numerical: '#/components/schemas/NumericalFeedbackDefinition_Public'
          categorical: '#/components/schemas/CategoricalFeedbackDefinition_Public'
          boolean: '#/components/schemas/BooleanFeedbackDefinition_Public'
    BatchDelete:
      required:
      - ids
      type: object
      properties:
        ids:
          maxItems: 1000
          minItems: 1
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
    Feedback_Public:
      required:
      - name
      - type
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        name:
          minLength: 1
          type: string
        description:
          maxLength: 255
          minLength: 0
          type: string
          description: Optional description for the feedback definition
          example: This feedback definition is used to rate response quality
        createdAt:
          type: string
          format: date-time
          readOnly: true
        createdBy:
          type: string
          readOnly: true
        lastUpdatedAt:
          type: string
          format: date-time
          readOnly: true
        lastUpdatedBy:
          type: string
          readOnly: true
        type:
          type: string
          enum:
          - numerical
          - categorical
          - boolean
      discriminator:
        propertyName: type
        mapping:
          numerical: '#/components/schemas/NumericalFeedbackDefinition_Public'
          categorical: '#/components/schemas/CategoricalFeedbackDefinition_Public'
          boolean: '#/components/schemas/BooleanFeedbackDefinition_Public'
    FeedbackDefinitionPage_Public:
      type: object
      properties:
        page:
          type: integer
          format: int32
        size:
          type: integer
          format: int32
        total:
          type: integer
          format: int64
        content:
          type: array
          items:
            $ref: '#/components/schemas/FeedbackObject_Public'
    ErrorMessage:
      type: object
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
        details:
          type: string
    Feedback_Update:
      required:
      - name
      - type
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        name:
          minLength: 1
          type: string
        description:
          maxLength: 255
          minLength: 0
          type: string
          description: Optional description for the feedback definition
          example: This feedback definition is used to rate response quality
        type:
          type: string
          enum:
          - numerical
          - categorical
          - boolean
      discriminator:
        propertyName: type
        mapping:
          numerical: '#/components/schemas/NumericalFeedbackDefinition_Update'
          categorical: '#/components/schemas/CategoricalFeedbackDefinition_Update'
          boolean: '#/components/schemas/BooleanFeedbackDefinition_Update'
    Feedback_Create:
      required:
      - name
      - type
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        name:
          minLength: 1
          type: string
        description:
          maxLength: 255
          minLength: 0
          type: string
          description: Optional description for the feedback definition
          example: This feedback definition is used to rate response quality
        type:
          type: string
          enum:
          - numerical
          - categorical
          - boolean
      discriminator:
        propertyName: type
        mapping:
          numerical: '#/components/schemas/NumericalFeedbackDefinition_Create'
          categorical: '#/components/schemas/CategoricalFeedbackDefinition_Create'
          boolean: '#/components/schemas/BooleanFeedbackDefinition_Create'