Learning Companion¶
The Learning Companion is designed for students who want to independently explore course materials, test their understanding, and plan their studies using AI-powered tools.
This guide covers the full workflow: Landing Page → Add Courses → Add RAG Document Source → Summary Generator → Quiz Generator → FAQ Generator → AI Chat → Personalized Study Plan Generator.
Select Learning Companion Persona¶
- On the application home page, click Learning Companion Persona.
-
Click Get Started.

Landing Page¶
After selecting Get Started as Learning Companion, the landing page is displayed. Click Add Courses to upload courses from the installation package.

Add Courses¶
-
Click Courses then click Add Courses to upload courses from the installation package.

-
Upload the programme configuration file.
The programme configuration JSON file is included in the extracted installation package.
Info
Example programme configuration file name format:
programme-<programme_code>-<programme_version>-UCET-<application_version>.json
After uploading the programme configuration file, click Next.
-
Select the courses to add.
Choose the target courses from the available courses list, then click Add Selected Courses.

-
Select the active course.
Select a course from the course selector in the top-left corner.

Add RAG Document Source¶
Uploaded sources are used for Retrieval-Augmented Generation (RAG) to enhance AI responses across all features.
-
Click Add Source in the bottom-left corner.

-
Upload your document and click Upload.
Info
The currently supported format is PDF only.

-
Check the checkbox next to a source in the sources list.
Info
Selecting a document as a knowledge source is optional.

Summary Generator¶
Generate a summary from a single uploaded document.
Info
Only one document can be selected at a time for summary generation.
-
Select a document using the file selector in the sidebar.

-
Select the active course from the course selector in the top-left corner.

-
Click Generate Summary at the bottom of the page.

-
Once the summary is generated, scroll to the bottom to find the export options. Select your preferred format to download.

Quiz Generator¶
The Quiz Generator lets you create quizzes based on your learning materials.
-
In the Quiz tab, click Create Quiz.

-
Configure the quiz type using the available options, then click Start Now!.

-
Answer the quiz questions and click Next.

-
Review the quiz summary.

FAQ Generator¶
-
Check the checkbox next to a source in the sources list to apply a document source.

-
Configure the FAQ Settings, then click Generate FAQs.
Info
Optionally enter keywords to focus on specific topics.

-
Review the generated FAQs. Click Continue to generate more FAQs based on the source document.

Personalized Study Plan Generator¶
-
Upload or select your learning materials using the source selector in the sidebar, then click Create Study Plan.

-
Configure your study period, available time, and difficulty level, then click Generate Study Plan.

-
View your study plan with weekly schedules and resources.
Info
Download your study plan as a PDF for offline reference.
¶