Documentation

Requirements

NOTE: The requirements section contains functional and non-functional requirements.

ID	Requirements	Importance
R0	As Shansai I want to have an easy to use CLI, so that I can ask questions to ChatGPT-4	High
R1	As a Tester I want to test the CLI-application without connecting to ChatGPT-4	High
R2	As a Developer I want to add easily new providers for asking questions	High
R3	As Shansai I want to have a history of all the asked questions with the answers	High
R4	As Shansai I want to have an encrypted connection for asking questions, so that no one else can see what I am asking	High
R5	As Gianni I want to have aSOLID compliant software design, so that Shansai can write better software that is more robust, reusable, extensible, readable and maintainable	High
R6	As Gianni I want to have logic sperated from data so that the logic is encapsulated and can be used in different context	High

Design

Package

CLI package

classDiagram
    class main
    class cli

    main --> cli

Loading

Classes

• main
  • Responsibility: Starting point of the application
• cli
  • Responsibility: Manages all the CLI commands

Ask package

classDiagram
  class Ask{
  
  }
  class IAnswerProvider
  class Mock
  class GPT
  class AnswerProviderFactory

  Ask --> IAnswerProvider
  Ask --> AnswerProviderFactory
  IAnswerProvider <|-- Mock
  IAnswerProvider <|-- GPT

  AnswerProviderFactory *-- Mock
  AnswerProviderFactory *-- GPT

  GPT --> GPTQuestionRequest
  GPT --> GPTQuestionAnswer
  class AnswerProviderFactory{
        +createProvider(provider: enum)
  }

  class IAnswerProvider{
        +ask(question: string) Answer
  }

  class GPT{
        +ask(question: string) Answer
  }

  class Mock{
        +ask(question: string) Answer
  }

  class GPTQuestionRequest{
  
  }

  class GPTQuestionAnswer{
  
  }

Loading

• Responsibility: Manages the question asking with 3rd party providers
• Dependency-Inversion-Principle: Introduced IAnswerProvider as an interface class, so that the implementations of the interface a decoupled from the consumer (class ask)

Create GPT provider

sequenceDiagram
    Ask->>AnswerProviderFactory: create(GPT)
    AnswerProviderFactory->>GPT: new()
    GPT ->> AnswerProviderFactory : return new GPT instance

Loading

Answer package

classDiagram
    class IAnswerProvider{
    }
    class question{
      - question : string
    }
    class ask {
      + ask(question: string)
    }

    ask --> IAnswerProvider
    IAnswerProvider --> question

Loading

sequenceDiagram
  Ask->>AnswerProvider: ask(question)
  AnswerProvider->>Question: new question
  AnswerProvider->>OpenAI: question
  OpenAI->>AnswerProvider: answers
  AnswerProvider->>Ask: answer

Loading

Classes

• answer
  • Responsibility: Fetches the answer and provides it
• question
  • Responsibility: Contains the question
• ask
  • Responsibility: Asks GPT-4 or a Mock the user-entered question

History package

classDiagram
  class question{
    - question : string
  }
  class answer{
    - id : UUID
    - answer : string
    - TimeStamp : timestamp
    + getAnswer() Answer
  }
  class history{
    - answers : Answer[]
    + save(answer : Answer)
    + getHistory() Answer[]
    + getHistoryById(id : UUID) Answer
  }

  question <-- history
  answer <--* question

Loading

Classes

• answer
  • Responsibility: Receives the answer of GPT-4
• history
  • Responsibility: Saves questions and answers in a csv

CLI-Commands

Command	Explanation
ask	The ask method is used to ask questions to the OpenAI API
history	With the history command, the chat history with GPT-4 is shown

Process