openapi: 3.2.0
info:
  title: Fast Cluster Suggestions API
  version: 0.1.0
tags:
- name: Cluster Suggestions
paths:
  /cluster-suggestions:
    post:
      summary: ' Handle Cluster Suggestions'
      operationId: _handle_cluster_suggestions_cluster_suggestions_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClusterSuggestionsRequestPayload'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterSuggestionsResponsePayload'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Cluster Suggestions
components:
  schemas:
    ClusterSuggestionsResponsePayload:
      properties:
        categories:
          items:
            type: string
          type: array
          title: Categories
        on_columns:
          items:
            type: string
          type: array
          title: On Columns
      additionalProperties: true
      type: object
      required:
      - categories
      - on_columns
      title: ClusterSuggestionsResponsePayload
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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
    ClusterSuggestionsRequestPayload:
      properties:
        datasetId:
          type: string
          title: Datasetid
          description: ID of the dataset to get clustering suggestions for
        guidance:
          anyOf:
          - type: string
          - type: 'null'
          title: Guidance
          description: Optionally provided guidance as to what clusters the user wants to create.
          default: Group in the way you think most usefully clusters the data.
        suggestions:
          items:
            type: string
          type: array
          title: Suggestions
          description: Existing suggestions we should use as additional context in order to generate the rest.
          default: []
      additionalProperties: true
      type: object
      required:
      - datasetId
      title: ClusterSuggestionsRequestPayload