Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vedpatwardhan committed Sep 5, 2024
1 parent dfa69a8 commit d71071b
Show file tree
Hide file tree
Showing 6 changed files with 92 additions and 92 deletions.
16 changes: 8 additions & 8 deletions mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -98,18 +98,18 @@
{
"group": "",
"pages": [
"python/dataset",
"python/evaluation",
"python/evaluator",
"python/exceptions",
{
"group": "queries",
"group": "chat",
"pages": [
"python/queries/chat",
"python/queries/clients",
"python/queries/multi_llm"
"python/chat/chatbot",
"python/chat/clients",
"python/chat/multi_llm"
]
},
"python/dataset",
"python/evaluation",
"python/evaluator",
"python/exceptions",
{
"group": "utils",
"pages": [
Expand Down
27 changes: 14 additions & 13 deletions python/queries/chat.mdx → python/chat/chatbot.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: 'chat'
title: 'chatbot'
---

<a id="queries.chat.ChatBot"></a>
<a id="chat.chatbot.ChatBot"></a>

## ChatBot

Expand All @@ -12,7 +12,7 @@ class ChatBot()

Agent class represents an LLM chat agent.

<a id="queries.chat.ChatBot.__init__"></a>
<a id="chat.chatbot.ChatBot.__init__"></a>

---

Expand Down Expand Up @@ -46,7 +46,7 @@ Initializes the ChatBot object.

- `UnifyError` - If the API key is missing.

<a id="queries.chat.ChatBot.client"></a>
<a id="chat.chatbot.ChatBot.client"></a>

---

Expand All @@ -63,7 +63,7 @@ Get the client object.

The client.

<a id="queries.chat.ChatBot.set_client"></a>
<a id="chat.chatbot.ChatBot.set_client"></a>

---

Expand All @@ -79,7 +79,7 @@ Set the client.

- `value` - The unify client.

<a id="queries.chat.ChatBot.model"></a>
<a id="chat.chatbot.ChatBot.model"></a>

---

Expand All @@ -96,7 +96,7 @@ Get the model name.

The model name.

<a id="queries.chat.ChatBot.set_model"></a>
<a id="chat.chatbot.ChatBot.set_model"></a>

---

Expand All @@ -112,7 +112,7 @@ Set the model name.

- `value` - The model name.

<a id="queries.chat.ChatBot.provider"></a>
<a id="chat.chatbot.ChatBot.provider"></a>

---

Expand All @@ -129,7 +129,7 @@ Get the provider name.

The provider name.

<a id="queries.chat.ChatBot.set_provider"></a>
<a id="chat.chatbot.ChatBot.set_provider"></a>

---

Expand All @@ -145,7 +145,7 @@ Set the provider name.

- `value` - The provider name.

<a id="queries.chat.ChatBot.endpoint"></a>
<a id="chat.chatbot.ChatBot.endpoint"></a>

---

Expand All @@ -162,7 +162,7 @@ Get the endpoint name.

The endpoint name.

<a id="queries.chat.ChatBot.set_endpoint"></a>
<a id="chat.chatbot.ChatBot.set_endpoint"></a>

---

Expand All @@ -178,7 +178,7 @@ Set the endpoint name.

- `value` - The endpoint name.

<a id="queries.chat.ChatBot.clear_chat_history"></a>
<a id="chat.chatbot.ChatBot.clear_chat_history"></a>

---

Expand All @@ -190,7 +190,7 @@ def clear_chat_history() -> None

Clears the chat history.

<a id="queries.chat.ChatBot.run"></a>
<a id="chat.chatbot.ChatBot.run"></a>

---

Expand All @@ -207,3 +207,4 @@ Starts the chat interaction loop.
- `show_credits` - Whether to show credit consumption. Defaults to False.
- `show_provider` - Whether to show the provider used. Defaults to False.

<a id="chat.multi_llm"></a>
Loading

0 comments on commit d71071b

Please sign in to comment.