Managing VTA Knowledge Base (VTA Setup Page 5: Training Data)

Written By Asad Jobanputra

Last updated 3 months ago

Overview

This guide covers the Training Data page, which allows you to define the entire knowledge base for your Virtual Teaching Assistant (VTA). This involves two methods: Custom Files (manual upload of specific documents) and Canvas Integration (automated sync of course materials).

Who it's For

  • Instructors: To upload syllabi, readings, and lecture notes.

  • LMS Admins/IT Staff: To complete the technical configuration of the Canvas LTI and API connection.

Why Use It

The VTA is only as smart as the data you provide. Configuring the knowledge base ensures:

  • Accuracy: The VTA answers questions based solely on verified, current course content.

  • Relevance: The VTA supports the specific nuances of your course, not general internet knowledge.

  • Automated Sync: Once configured, the VTA automatically updates its knowledge when you update files in the LMS.

Part 1: Custom Files (Instructor Task)

This section allows instructors to manually upload specific documents that may not be in the LMS.

  1. Enable Custom Files: Ensure the Enable Custom Files checkbox is marked.

  2. Upload Files: Use the Upload file button or drag and drop files into the designated area.

    • Accepted Formats: PDFs, documents, text files, and video transcripts are typically supported.

    • Review Files: After uploading, the file name, like 02_Corporate-Financing...pdf, and the upload date are displayed.

  3. Synchronize Data: Click Synchronize with Datasource Now (located on the Synchronization page) to immediately process new uploads.

Part 2: Canvas LTI Integration (LMS Admin Task)

This complex step is required to securely embed the VTA into your Canvas course and enable content synchronization.

A. Canvas LTI Configuration (Embedding the Tool)

This procedure configures the LTI 1.3 connection needed to launch the VTA from the course menu.

  1. Pre-requisite: The CampusMind (or previous Classbuddy) Developer Key must be installed at the account or sub-account level of Canvas.

  2. Go to Courses > select the desired course.

  3. In the course menu, go to Settings, and click the Apps tab.

  4. Click View App Configurations, then click + App.

  5. Set Configuration Type to Choose By Client ID.

  6. Enter the Client ID provided by the LTI vendor (CampusMind). Click Submit.

  7. Verify Canvas fetches the LTI 1.3 configuration from the Developer Key.

  8. Fill in the remaining fields using the LTI configuration details: LTI Tool URL (Target Link URL)* and LTI Deployment ID*.

B. Canvas DataSource (Enabling Content Sync)

This procedure grants CampusMind API access to read course files for the VTA's knowledge base.

  1. Obtain a Developer Key:

    • Log in to your Canvas Admin account.

    • From the Global Navigation, click Admin, then select your root account.

    • In the left-hand menu, click Developer Keys, and select the API Keys tab.

  2. Enter the generated API Course Token* into the CampusMind field.

Part 3: Synchronization and Content Selection

1. Data Synchronization Frequency

Select how often the VTA should check the LMS for updated content. Choose the option that balances data freshness with system load: Daily, Weekly, or Monthly.

  • Note: Synchronizations happen at midnight.

2. Configure Course Content

Select the specific types of course content the VTA is allowed to use for training.

  1. Under Canvas Features, select only the content types necessary for the VTA's function:

    • Announcements, Assignments, Syllabus, Pages (and referenced files) are generally recommended.

    • Avoid selecting items like Enrollments or Groups unless absolutely required, as this can increase data sensitivity.