Altimate AI FEEDBACKS API

The FEEDBACKS API from Altimate AI — 7 operation(s) for feedbacks.

OpenAPI Specification

altimate-ai-feedbacks-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Fast ACCOUNT_COSTS FEEDBACKS API
  version: 0.1.0
tags:
- name: FEEDBACKS
paths:
  /feedbacks/term:
    post:
      tags:
      - FEEDBACKS
      summary: Term Feeedback
      operationId: term_feeedback_feedbacks_term_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TermGenerationFeedbackRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TermGenerationFeedbackResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response 400 Term Feeedback Feedbacks Term Post
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response 403 Term Feeedback Feedbacks Term Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
  /feedbacks/rule:
    post:
      tags:
      - FEEDBACKS
      summary: Rule Feedback
      operationId: rule_feedback_feedbacks_rule_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RuleRecommendationFeedbackRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuleRecommendationFeedbackResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response 400 Rule Feedback Feedbacks Rule Post
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response 403 Rule Feedback Feedbacks Rule Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
  /feedbacks/:
    post:
      tags:
      - FEEDBACKS
      summary: Feedback
      operationId: feedback_feedbacks__post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FeedbackRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response 400 Feedback Feedbacks  Post
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response 403 Feedback Feedbacks  Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
  /feedbacks/ai:
    get:
      tags:
      - FEEDBACKS
      summary: Get Ai Feedback
      operationId: get_ai_feedback_feedbacks_ai_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: feedback_id
        in: query
        required: false
        schema:
          type: string
          title: Feedback Id
      - name: feedback_type
        in: query
        required: false
        schema:
          type: string
          title: Feedback Type
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeebackAIResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Get Ai Feedback Feedbacks Ai Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Get Ai Feedback Feedbacks Ai Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - FEEDBACKS
      summary: Post Ai Feedback
      operationId: post_ai_feedback_feedbacks_ai_post
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: feedback_id
        in: query
        required: false
        schema:
          type: string
          title: Feedback Id
      - name: feedback_type
        in: query
        required: false
        schema:
          type: string
          title: Feedback Type
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FeebackAIPostRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeebackAIResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Post Ai Feedback Feedbacks Ai Post
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Post Ai Feedback Feedbacks Ai Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /feedbacks/ai/fb:
    post:
      tags:
      - FEEDBACKS
      summary: Post Oneway Feedback
      operationId: post_oneway_feedback_feedbacks_ai_fb_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OneWayFeedbackPostRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response 400 Post Oneway Feedback Feedbacks Ai Fb Post
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response 403 Post Oneway Feedback Feedbacks Ai Fb Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
  /feedbacks/studio:
    post:
      tags:
      - FEEDBACKS
      summary: Post Studio Feedback
      description: 'Submit feedback for Studio sessions.

        Stores feedback in the database and sends notification to Slack.'
      operationId: post_studio_feedback_feedbacks_studio_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlaygroundFeedbackRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlaygroundFeedbackResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response 400 Post Studio Feedback Feedbacks Studio Post
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response 403 Post Studio Feedback Feedbacks Studio Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      - HTTPBearer: []
  /feedbacks/playground:
    post:
      tags:
      - FEEDBACKS
      summary: Post Playground Feedback
      description: 'Submit feedback for AI Playground sessions.

        Stores feedback in the database and sends notification to Slack.'
      operationId: post_playground_feedback_feedbacks_playground_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlaygroundFeedbackRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlaygroundFeedbackResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response 400 Post Playground Feedback Feedbacks Playground Post
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response 403 Post Playground Feedback Feedbacks Playground Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
components:
  schemas:
    PlaygroundFeedbackResponse:
      properties:
        ok:
          type: boolean
          title: Ok
        message:
          anyOf:
          - type: string
          - type: 'null'
          title: Message
      type: object
      required:
      - ok
      - message
      title: PlaygroundFeedbackResponse
    OneWayFeedbackPostRequest:
      properties:
        feedback_value:
          $ref: '#/components/schemas/FeedbackValue'
        feedback_src:
          $ref: '#/components/schemas/FeedbackType'
        data:
          additionalProperties: true
          type: object
          title: Data
        feedback_text:
          type: string
          title: Feedback Text
      type: object
      required:
      - feedback_value
      - feedback_src
      - data
      - feedback_text
      title: OneWayFeedbackPostRequest
    RuleRecommendationFeedbackResponse:
      properties:
        ok:
          type: boolean
          title: Ok
      type: object
      required:
      - ok
      title: RuleRecommendationFeedbackResponse
    FeedbackType:
      type: string
      enum:
      - datapilot
      - query_tag
      - table_insights
      - dbtpu-extension
      - summary
      title: FeedbackType
    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
    FeedbackEnum:
      type: string
      enum:
      - good
      - bad
      title: FeedbackEnum
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PlaygroundFeedbackRequest:
      properties:
        messageId:
          type: string
          title: Messageid
        sessionId:
          type: string
          title: Sessionid
        feedback:
          additionalProperties: true
          type: object
          title: Feedback
      type: object
      required:
      - messageId
      - sessionId
      - feedback
      title: PlaygroundFeedbackRequest
    StandardResponse:
      properties:
        ok:
          type: boolean
          title: Ok
      type: object
      required:
      - ok
      title: StandardResponse
    FeedbackValue:
      type: string
      enum:
      - good
      - bad
      title: FeedbackValue
    TermGenerationFeedbackResponse:
      properties:
        ok:
          type: boolean
          title: Ok
      type: object
      required:
      - ok
      title: TermGenerationFeedbackResponse
    FeedbackRequest:
      properties:
        session_id:
          type: string
          title: Session Id
        workflow_type:
          type: string
          title: Workflow Type
        time_saved:
          anyOf:
          - type: integer
          - type: 'null'
          title: Time Saved
        feedback:
          $ref: '#/components/schemas/FeedbackEnum'
        message:
          anyOf:
          - type: string
          - type: 'null'
          title: Message
      type: object
      required:
      - session_id
      - workflow_type
      - feedback
      title: FeedbackRequest
    FeedbackForm:
      properties:
        good_form:
          items:
            $ref: '#/components/schemas/FeedbackFormInput'
          type: array
          title: Good Form
        bad_form:
          items:
            $ref: '#/components/schemas/FeedbackFormInput'
          type: array
          title: Bad Form
      type: object
      required:
      - good_form
      - bad_form
      title: FeedbackForm
    FeebackAIPostRequest:
      properties:
        feedback_value:
          $ref: '#/components/schemas/FeedbackValue'
        full_form:
          $ref: '#/components/schemas/FeedbackForm'
      type: object
      required:
      - feedback_value
      - full_form
      title: FeebackAIPostRequest
    TermGenerationFeedbackRequest:
      properties:
        term_generation_id:
          type: string
          title: Term Generation Id
        feedback:
          $ref: '#/components/schemas/FeedbackEnum'
        message:
          type: string
          title: Message
      type: object
      required:
      - term_generation_id
      - feedback
      - message
      title: TermGenerationFeedbackRequest
    FeedbackFormInput:
      properties:
        label:
          type: string
          title: Label
        type:
          type: string
          title: Type
        value:
          anyOf:
          - type: string
          - type: 'null'
          title: Value
      type: object
      required:
      - label
      - type
      title: FeedbackFormInput
    RuleRecommendationFeedbackRequest:
      properties:
        rule_recommendation_id:
          type: string
          title: Rule Recommendation Id
        updated_rule:
          type: string
          title: Updated Rule
      type: object
      required:
      - rule_recommendation_id
      - updated_rule
      title: RuleRecommendationFeedbackRequest
    FeebackAIResponse:
      properties:
        feedback_id:
          type: string
          title: Feedback Id
        feedback_type:
          type: string
          title: Feedback Type
        is_submitted:
          type: boolean
          title: Is Submitted
        feedback_value:
          anyOf:
          - $ref: '#/components/schemas/FeedbackValue'
          - type: 'null'
        full_form:
          $ref: '#/components/schemas/FeedbackForm'
      type: object
      required:
      - feedback_id
      - feedback_type
      - is_submitted
      - full_form
      title: FeebackAIResponse
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer