Platform Support Document
Kadal: Generative AI Platform for Education
Mar 4, 2024
By Jaya Sajnani
Table of Contents
Feature Overview
Log in
- Login using username and password
- When Admin adds a user to the account, the user receives a confirmation email.
- The confirmation email includes:
- Name of the user
- Link to the Platform
- Link for resetting password
- User can log in through the provided email link.
- Forgot your password
- Click on "Forgot password" on the login screen.
- Enter your email address and click on "Reset your password".
- Receive an email with a password reset link (valid for 24 hours).
- Follow the link to create a new password.
- Receive a confirmation email after successfully resetting the password.
Connectors
-
Canvas LMS:
- To configure the Canvas LMS, Click on the add connector
- Enter the name of the connector
- LMS Type → Canvas
- Enter the domain URL. For e.g. : https://learningmate.instructure.com/
- Select from the access token or developer key
- When selected the access token, user is asked to fill the access token field’
- When selected the developer key, user is asked to fill the Client ID and Secret key field. User would be navigated to the new tab and asked to authorize the App. Once the authorization is done, the connector would be saved
- Click on save button for saving the connection fields.
- For generating the access token on Canvas LMS: Refer this link: OAuth2 - Canvas LMS REST API Documentation (instructure.com)
- For generating the developer keys on Canvas LMS: Refer this link: How do I manage developer keys for an account? - Instructure Community - 249 (canvaslms.com)
- Log in to Canvas
- Click on the Account
- Click on Developer Keys
- Click on Add Developer keys
- Select API Key
- Add the redirect URI as : https://api.kadal.ai/aiwb/connector/api/v1/callback
- And Save the details
- Once the connector is saved, the following details can be updated
- Name
- Domain
- If the developer keys are selected, then the developer keys can be updated
- If the access token are selected, then the access token can be updated
- The selection between the access token and developer cannot be edited.
- To configure the Canvas LMS, Click on the add connector
Knowledge Base
-
Create
- Click on the "+" icon to create a folder.
- Enter folder name and create it.
-
Upload
- Click on "+" icon to upload a file.
- Select the file from the system and upload.
-
Import
- Click on "+" icon to import a course.
- Select the connector and course, then import.
- Receive email confirmation for successful import.
Try and Build
Bot Creation
- Go to "Try and Build" page and click on "Launch" under the bot card.
- Configure bot details including name, description, context, content, platform, and model version.
- Set temperature and max tokens.
- Add examples for fine-tuning the bot.
- Click "Save" to save the bot configurations.
Bot Updation
- Edit bot configurations by clicking on the settings icon.
- Modify name, context, platform, model, temperature, max tokens, and content.
- Update or discard changes as needed.
Bot Deletion
- Click on the ellipses (...) on the bot listing page and select "Delete" to remove the bot.
Note: This document provides detailed instructions for using the Kadal platform's features.