Skip to content

Commit 0badc0d

Browse files
committed
fix for consistency
1 parent 6f06b39 commit 0badc0d

2 files changed

Lines changed: 5 additions & 5 deletions

File tree

docs/advanced/chat_functions/info.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ The Chatbots have at their basis a [Large Language Model (LLM)](https://en.wikip
77
- the details of the Question the student is on currently,
88
- the final answer, structured tutorial, and worked solutions of the Question,
99
- the answer for each Response Area,
10-
- the student's progress on all parts of the Question,
11-
- the students's current previewed part,
10+
- the progress of the student on all parts of the Question,
11+
- the current student previewed part,
1212
- the guidance time and tips form the lecturer.
1313

1414
---

docs/advanced/chat_functions/quickstart.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## What is a Chat Function?
44

5-
It's a function which calls Large Language Models (LLMs) to respond to the student's messages given contextual data:
5+
A chat function is a function which calls Large Language Models (LLMs) to respond to the messages of students given contextual data:
66

77
- question data
88
- user data such as past responses to the problem
@@ -16,7 +16,7 @@ Chat functions host a chatbot. Chatbots capture and automate the process of assi
1616
- For new functions: clone the template repo for [chat-function-boilerplate](https://github.com/lambda-feedback/chat-function-boilerplate). **Make sure the new repository is set to public (it needs access to organisation secrets)**.
1717
- For existing functions: please make your changes on a new separate branch
1818

19-
2. _If you are creating a new chatbot_, you can either edit the `scr/agents/base_agent` or copy it and rename it based on your chatbot's name.
19+
2. _If you are creating a new chatbot_, you can either edit the `scr/agents/base_agent` or copy it and rename it based on the name of your chatbot.
2020
3. You are now ready to start making changes and implementing features by editing each of the main function-logic files:
2121

2222
1. **`scr/agents/{base_agent}/{base}_agent.py`**: This file contains the main LLM pipeline using [LangGraph](https://langchain-ai.github.io/langgraph/) and [LangChain](https://python.langchain.com/docs/introduction/).
@@ -56,7 +56,7 @@ Chat functions host a chatbot. Chatbots capture and automate the process of assi
5656

5757
3. _If you edited the chatbot agent file name_, make sure to add your chatbot `invoke()` function to the `module.py` file.
5858

59-
4. Update the `config.json` file with the chatbot's name.
59+
4. Update the `config.json` file with the name of the chat function.
6060

6161
5. Please add a `README.md` file to describe the use and behaviour of your chatbot.
6262

0 commit comments

Comments
 (0)