All guides & tutorials
in this lesson
1
Study Catalogue: AI coach
2
Setting up the AI coach
3
What you can ask the AI coach
4
How the AI coach answers
5
Which data the AI coach uses
6
Where the data goes
7
The AI coach status under Administration → AI
8
Known issues and limitations
9
Set up
10
11
share
How-to-guides
Study Guide
Curriculum

Study Catalogue: AI coach

The Study Catalogue provides two different AI agents using the study guide information to assist students and staff.

in this lesson
1
Study Catalogue: AI coach
2
Setting up the AI coach
3
What you can ask the AI coach
4
How the AI coach answers
5
Which data the AI coach uses
6
Where the data goes
7
The AI coach status under Administration → AI
8
Known issues and limitations
9
Set up
10
11
Requirements

Study Catalogue: AI coach

The AI coach is a widget that answers questions about the curriculum in your study catalogue. A student types a question, the coach searches your studies, module groups and modules, and answers with links to the pages it found. The admin page explains what the coach does when a question is asked, which data it uses and where that data goes, how it is set up for your organisation, and what administrators see and can do. In a next iteration, we'll move this to TE Admin.

The AI coach is in active development. It can be unstable, and its answers can be incomplete or wrong. We would be glad to hear what works for your users and what could be better: please share your feedback with us.

On this page:

  • Setting up the AI coach
  • What you can ask the AI coach
  • How the AI coach answers
  • Which data the AI coach uses
  • Where the data goes
  • The AI coach status under Administration → AI
  • Time limits and errors
  • Known issues and limitations
  • What administrators need to do

‍

Setting up the AI coach

Setting up the coach takes two steps: TimeEdit Support enables it for your organisation, and you place and configure the widget.

‍

Step 1: have TimeEdit Support enable the AI

Before the coach can answer, TimeEdit Support has to build a search index of your curriculum. Building it sends your module texts to Google, so it happens per organisation, by choice.

  1. Contact TimeEdit Support and ask them to set up the AI coach for your organisation. Administration → AI shows the organisation ID to give them.
  2. TimeEdit Support starts the first embedding run for your organisation. It adds all your studies, module groups and modules to the search index. While it runs, Administration → AI shows since when, and users cannot use the coach yet.
  3. Once the run has finished, users can use the coach.

From then on, every study, module group and module saved in Curriculum is added to the search index straight away, and one that is deleted is removed from it. You do not need to ask for a new run after changing your descriptions.

A later embedding run adds all your studies, module groups and modules to the search index again, for example after the embedding model has changed. Users can keep using the coach while it runs.

To stop the coach and have your organisation's search index removed, contact TimeEdit Support.

‍

Step 2: configure the widget

You can place the widget and configure it before step 1 is done. Until then, users see that the coach is not available yet.

Place the widget on a tab. The coach is a widget that you place on a tab, like any other widget.

Set the greeting. The welcome message at the top of the coach is the greeting configured on the widget.

Set up the suggested questions. Under the welcome, the coach offers suggested questions. These are the prompts set up under Administration → AI that are marked Visible.

Choose who the coach talks to. On a tab marked Authenticated under Administration, Tabs, which only signed-in users can open, the coach shows the prompts marked Authenticated; on any other tab it shows the prompts that are not. On a tab marked Authenticated, the coach addresses signed-in staff; on any other tab it addresses students.

The year switcher. The coach answers for the year selected in the year switcher above it.

What you can ask the AI coach

The coach answers questions about your curriculum for the selected year, in the language of the question. Students can use their own words: "course", "programme", "exam" and "learning form" are understood as module, study, assessment and teaching method.

‍

Questions about a topic

  • "Which modules teach statistics?"
  • "Welke vakken gaan over programmeren?", answered in Dutch.

‍

Questions with a level, credits, a period, a type or a study. The coach narrows its search to what the question asks for. It knows the levels, types and periods your curriculum holds for that year.

  • "Is there a 6 ECTS master course on statistics?"
  • "Which courses in period 2 are about programming?"
  • "Which courses are part of programme X?"

‍

Questions about a code. A code or id that the student types is looked up directly, including the code of an assessment or teaching method.

  • "What is module ABC123 about?"
  • "How is module ABC123 assessed?"

‍

Follow-up questions. A follow-up is answered with the earlier questions and answers of the conversation in mind.

  • "Which of those has fieldwork?"
  • "Which of those courses is in period 2?"

‍

What the coach does not do

  • It only knows your curriculum for the selected year. It does not know who is asking, so it cannot answer questions about a student's own situation.
  • On a student tab, it only helps with studying at your institution and kindly declines other requests. When it is unsure, it refers the student to a study advisor.
  • It never makes up a code, name or link. When a student asks for a code that does not exist in the selected year, the coach says so instead of suggesting a similar one.
  • Terminated studies, module groups and modules are never found.

How the AI coach answers

It searches before it answers. For the first question of a conversation, the coach searches your curriculum with the question before it starts writing, so most answers need a single round. When the matches do not fit the question, the coach searches again or looks up details itself.

‍

It narrows the conversation down when needed. On a student tab, when a search finds nothing or far too much, the coach asks about the student's previous studies, interests or goals. On a staff tab, it asks for more information when it is unsure about the results.

‍

It shows what it is doing. While it works, the coach shows "Searching the curriculum..." and a line for each step, such as "Searched the catalogue: 12 results" or "Looked up details: 3 results". Once the answer is written, the steps fold away under "Searched the curriculum", and the student can open them again.

‍

The answer appears as it is written. The text arrives on screen while the coach writes it, instead of all at once at the end.

‍

It explains its suggestions. For a student, the coach says briefly why each option suits them; for staff, why each match fits.

‍

Every study, module group or module it names is a link. Each one is shown as a badge with its type, code and name, which opens its page in a new tab. A screen reader reads a badge as its type followed by its code and name. Details such as credits follow the badge. Objects without a page in your study catalogue, such as teaching methods and assessments, are named by their code and name without a link. Any other link in an answer, such as a link to your institution's own website, also opens in a new tab, so the conversation stays open.

‍

After the answer, the student can copy it or ask the same question again. The latest answer always shows these two actions; earlier answers show them on hover or keyboard focus, and always on touch screens. New conversation, in the menu above the coach, starts an empty conversation and clears an unsent question.

Which data the AI coach uses

The coach works in two steps: it uses a search index to find the objects that fit a question, and then it reads those objects to write its answer. The two steps use different data.

‍

The curriculum broker

The curriculum broker is the TimeEdit service that passes your Curriculum data to Study Catalogue. Every study, module group and module you save in Curriculum reaches the broker, and the broker also keeps the coach's search index. The search index is kept in your organisation's own database in the curriculum broker, hosted in your region. It is not part of Curriculum's own database.

‍

What goes into the search index

For each study, module group and module, the search index holds the code, name, level, credits, periods, organisation, objectives, subjects, teaching and assessment types, and all descriptions, including description types your study catalogue pages do not show. Email addresses and long phone numbers are taken out first. Member lists, persons, links and dates are not included.

The search index only decides which objects the coach finds. The coach does not read its text, so a description type your pages do not show can help an object be found, but is not quoted.

‍

What the coach reads to answer

  • Objects it found by searching: the coach reads them as your study catalogue pages show them, with their names, credits and the descriptions your pages show.
  • Objects it looked up by code or id: the coach gets the fields and relations your pages show, including the people in those relations with their contact details, and the rest of the object in full, such as offerings, links and a module's teaching methods and assessments.
  • Teaching methods and assessments looked up on their own come with all their fields, including fields your pages do not show.
  • When a signed-in user asks, the fields on tabs marked Authenticated count as shown too.

The coach can quote anything it reads. Check that these texts hold nothing you would not want your users to read.

‍

What the coach never gets

  • Fields set to Only visible for admins are never given to the coach, whoever asks, administrators included.
  • Who is asking: the coach does not receive the user's name or account.

‍

Where the data goes

  • The coach answers with Google's Gemini model and searches with Google's embedding models, both on Google Cloud.
  • For EU, UK and Australia-New Zealand customers, Google commits to processing this data in that region. For Singapore it does so for the answers, but not yet for the search.
  • Gemini receives each question and the conversation so far, without the user's name or account. Questions are also used as search text.
  • Conversations are kept in the memory of the Study Catalogue service, separately per organisation, and are not stored in a database. The coach forgets a conversation an hour after its last question.
  • TimeEdit's logs keep the codes the coach looks up, and on Test environments also what it searched for. Performance monitoring of the coach records timings only, never the text of questions or answers.

‍

The AI coach status under Administration → AI

Under Administration → AI, a button above the prompts shows the coach's status. Each figure has a tooltip that explains what it means.

  • Embeddings: Set up or Not set up. Set up once TimeEdit Support has created a search index for your organisation.
  • Objects in the search index: the studies, module groups and modules the coach can find, each counted once.
  • Last embedding run: when the last run finished, in your own time zone.
  • Embedding model: the Google model that turns your texts into the search index. Which model is used depends on your region.

‍

Below the figures, an alert says what to do when users cannot use the coach:

  • Not set up, or set up with an empty search index: the warning "Users can't use the AI coach yet", with what to ask TimeEdit Support and the organisation ID to give them.
  • The first embedding run is going: "Users can use the AI coach once the embedding run has finished", with the time it started. The page checks again every 30 seconds.
  • The search service could not be reached: the figures are left out, as they are unknown, and the warning says that users see the coach is not available until the service is reachable again. Try again in a few minutes. If it keeps happening, contact TimeEdit Support and mention the organisation ID.

Under the alert, a notice says the coach is in active development and asks for feedback. A second notice, "How the AI coach handles your data", unfolds to explain what is sent to Google and where, what the search index holds, and what the coach reads and can quote, as described on this page.

Known issues and limitations

  • In active development. The coach can be unstable, and its answers can be incomplete or wrong.
  • Set-up goes through TimeEdit Support. Administrators cannot enable the coach or start an embedding run themselves yet.
  • No nightly run on Production. On Test environments, a nightly run also brings existing search indexes up to date. On Production, the search index is kept up to date by each save in Curriculum.
  • Singapore. For Singapore customers, Google does not yet commit to processing the search in the region; the answers are processed in the region.
  • A conversation can be lost without notice. In rare cases, such as a restart of the service, a conversation is forgotten before the hour is up. The next question is then answered as the start of a new conversation, without the notice, so a follow-up such as "which of those..." is answered without the earlier answers in mind.
  • Long searches end without a match. After 20 searches and lookups, or two minutes, the coach stops; the student can try again with a more specific question.
  • Studies, module groups and modules your study catalogue does not show can still be found and linked by the coach.
  • Copy answer copies the answer with its formatting marks, such as asterisks and link addresses.
  • Screen readers do not announce the coach's progress while it works; the finished answer is announced.
  • Keyboard focus: after sending a question with the Send button, keyboard focus moves to the top of the page. Pressing Enter in the question box does not have this problem.

‍

Set up

  • To use the coach, ask TimeEdit Support to set it up for your organisation, with the organisation ID shown under Administration → AI. If a tab already has the coach widget, users cannot use it until then.
  • Check what the coach can quote: the descriptions your pages show, the people and contact details in the relations your pages show, and the fields of your teaching methods and assessments.
  • Set the greeting on the coach widget, and the suggested questions under Administration → AI.
  • After changing your curriculum, nothing is needed: every save is added to the search index straight away.
  • Share your feedback with us.

‍

More Guides & Tutorials