openapi: 3.1.0
info:
  title: Agent Assist API
  version: 0.1.0
  description: |-
    This API exposes [DialOnce](<https://dialonce.ai>)'s functions that
    integrators can use for adding extra AI functions at the core of
    their CCaS.
  termsOfService: <https://dialonce.ai/en/legal-terms.html>
  contact:
    email: [email protected]
servers:
  - url: <https://agent-assist.dialonce.ai/v0.1>
security:
  - bearerAuth: []

tags:
  - name: analysis
    description: Analysis functions
  - name: classify
    description: Classification functions
  - name: generate
    description: Generation function
paths:
  /classify/text:
    post:
      tags:
        - classify
      description: Classify a text string
      summary: Classify a text string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/TextClassificationRequest"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TextClassificationResponse"

  /classify/document:
    post:
      tags:
        - classify
      description: Classify a document
      summary: Classify a document
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: "#/components/schemas/DocumentClassificationRequest"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DocumentClassificationResponse"

  /analyze/sentiment:
    post:
      tags:
        - analysis
      description: Analyze sentiment of a text string
      summary: Analyze sentiment of a text string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SentimentAnalysisRequest"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SentimentAnalysisResponse"

  /generate/chatbot-response:
    post:
      tags:
        - generate
      description: Generate a chatbot response
      summary: Generate a chatbot response
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ChatbotResponseGenerationRequest"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ChatbotResponseGenerationResponse"

  /generate/rag-response:
    post:
      tags:
        - generate
      description: Generate a RAG response
      summary: Generate a RAG response
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/RAGResponseGenerationRequest"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/RAGResponseGenerationResponse"

  /generate/prompt-response:
    post:
      tags:
        - generate
      description: Generate a response from a prompt
      summary: Generate a response from a prompt
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PromptResponseGenerationRequest"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/PromptResponseGenerationResponse"

  /generate/conversation-summary:
    post:
      tags:
        - generate
      description: Generate a summary of a conversation
      summary: Generate a summary of a conversation
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ConversationSummaryGenerationRequest"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ConversationSummaryGenerationResponse"

  /generate/text-summary:
    post:
      tags:
        - generate
      description: Generate a summary of a text string
      summary: Generate a summary of a text string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/TextSummaryGenerationRequest"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TextSummaryGenerationResponse"

  /generate/document-summary:
    post:
      tags:
        - generate
      description: Generate a summary of a document
      summary: Generate a summary of a document
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: "#/components/schemas/DocumentSummaryGenerationRequest"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DocumentSummaryGenerationResponse"

components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

  schemas:
    TextClassificationRequest:
      type: object
      properties:
        text:
          type: string

    TextClassificationResponse:
      type: object
      properties:
        category:
          type: string

    DocumentClassificationRequest:
      type: object
      properties:
        document:
          type: string
          format: binary

    DocumentClassificationResponse:
      type: object
      properties:
        category:
          type: string

    SentimentAnalysisRequest:
      type: object
      properties:
        text:
          type: string

    SentimentAnalysisResponse:
      type: object
      properties:
        sentiment:
          type: string

    ChatbotResponseGenerationRequest:
      type: object
      properties:
        context:
          type: string

    ChatbotResponseGenerationResponse:
      type: object
      properties:
        response:
          type: string

    RAGResponseGenerationRequest:
      type: object
      properties:
        prompt:
          type: string

    RAGResponseGenerationResponse:
      type: object
      properties:
        options:
          type: array
          items:
            type: string

    PromptResponseGenerationRequest:
      type: object
      properties:
        prompt:
          type: string

    PromptResponseGenerationResponse:
      type: object
      properties:
        response:
          type: string

    ConversationSummaryGenerationRequest:
      type: object
      properties:
        conversation:
          type: string

    ConversationSummaryGenerationResponse:
      type: object
      properties:
        summary:
          type: string

    TextSummaryGenerationRequest:
      type: object
      properties:
        text:
          type: string

    TextSummaryGenerationResponse:
      type: object
      properties:
        summary:
          type: string

    DocumentSummaryGenerationRequest:
      type: object
      properties:
        document:
          type: string
          format: binary

    DocumentSummaryGenerationResponse:
      type: object
      properties:
        summary:
          type: string
agent-assits.openapi.yml
Displaying agent-assits.openapi.yml.