Skip to content

Commit 3a2bd10

Browse files
committed
update docs
1 parent 27754f4 commit 3a2bd10

File tree

2 files changed

+43
-8
lines changed

2 files changed

+43
-8
lines changed

docs/dev.md

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,40 @@
1-
# YourFunctionName
2-
*Brief description of what this chat function does, from the developer perspective*
1+
# conciseChatFunction
2+
This chatbot aims to concisely respond to all relevant tasks the student requests based on the current Question they are working on. The Chatbot is aware of the Question details, answer, worked solution and guidance from the lecturer.
3+
4+
Some technical details:
5+
<pre style="white-space: pre-wrap;">
6+
<code>LLM model: Gemini-2.0-flash (Google)
7+
response time (on average): 10 seconds
8+
9+
Helping approach: provides short, direct answers without extra detail
10+
</code>
11+
</pre>
312

413
## Inputs
5-
*Specific input parameters which can be supplied when the calling this chat function.*
14+
Body:
15+
```JSON
16+
{
17+
"message":"hi",
18+
"params":{
19+
"conversation_id":"12345Test",
20+
"conversation_history":[{"type":"user","content":"hi"}],
21+
"include_test_data": true,
22+
}
23+
}
24+
```
625

726
## Outputs
8-
*Output schema/values for this function*
9-
10-
## Examples
11-
*List of example inputs and outputs for this function, each under a different sub-heading*
27+
```JSON
28+
{
29+
"chatbotResponse":"hi back",
30+
"metadata": {
31+
"summary": "",
32+
"conversational_style": "",
33+
"conversation_history": [],
34+
},
35+
"processing_time": 0
36+
}
37+
```
1238

1339
## Testing the Chat Function
1440

docs/user.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
11
# YourChatFunctionName
22

3-
Teacher- & Student-facing documentation for this function.
3+
This chatbot aims to concisely respond to all relevant tasks the student requests based on the current Question they are working on. The Chatbot is aware of the Question details, answer, worked solution and guidance from the lecturer.
4+
5+
Some technical details:
6+
<pre style="white-space: pre-wrap;">
7+
<code>LLM model: Gemini-2.0-flash (Google)
8+
response time (on average): 10 seconds
9+
10+
Helping approach: provides short, direct answers without extra detail
11+
</code>
12+
</pre>

0 commit comments

Comments
 (0)