You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+60-2Lines changed: 60 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,9 @@ This class is responsible for managing AI session data, including models, histor
4
4
5
5
The script is designed to interact with the AI API, providing a complete structure for building user interfaces (UI) or AI-powered chatbots.
6
6
7
-
It implements a session management system to help handle multiple different bots.
7
+
It implements a session management system to help handle multiple different bots, allowing you to manage various aspects of interactions such as system instructions, file handling, tokens, and more.
8
+
9
+
---
8
10
9
11
## Limitations
10
12
@@ -20,6 +22,8 @@ Developers must implement their own logic to monitor and manage token usage if n
20
22
21
23
## 📦 Installation
22
24
25
+
To install the package, use the following command:
26
+
23
27
```bash
24
28
npm install tiny-ai-api
25
29
```
@@ -28,7 +32,7 @@ npm install tiny-ai-api
28
32
29
33
## 🔧 Usage Example
30
34
31
-
The two methods will work identically.
35
+
You can interact with the AI using two methods, both of which are valid.
Understand how to manage content like prompts, dialogues, file data, and how to retrieve and modify this content.
80
+
81
+
### [Custom](https://github.com/JasminDreasond/TinyAiApi/blob/main/docs/custom.md) - Working with Custom Values
82
+
83
+
Understand how to implement custom values, including session-specific data and any user-defined parameters.
84
+
85
+
### [Dev](https://github.com/JasminDreasond/TinyAiApi/blob/main/docs/dev.md) - Development Tools
86
+
87
+
For developers looking to extend or debug the API, this section provides tools and guidelines for working with the internal workings of the library.
88
+
89
+
### [Models](https://github.com/JasminDreasond/TinyAiApi/blob/main/docs/models.md) - Model Configuration
90
+
91
+
Set up models and manage their configurations to interact with the API correctly. This includes handling different types of models and adjusting their parameters.
92
+
93
+
---
94
+
95
+
## 💡 Features
96
+
97
+
-**Session Management**: Keep track of multiple AI instances with full session history.
98
+
-**Content Handling**: Easily manage data like user inputs, AI-generated responses, and file handling.
99
+
-**Token and Hash Tracking**: Monitor token usage for each session and track hash values for specific items.
100
+
-**Customizable**: Fully configurable session data and model setups for different environments.
101
+
-**Error Handling**: Built-in error management to ensure robust session handling and prevent crashes.
102
+
-**Event-driven**: Supports event-driven architecture to handle real-time updates and triggers.
103
+
104
+
---
105
+
106
+
## 🛠 Development Tools
107
+
108
+
For advanced users, you can access several development tools to help with debugging and extending the API:
109
+
110
+
-**Token Tracking**: Manually track token usage for specific message categories like prompt, system instruction, or file.
111
+
-**Custom Session IDs**: Create and manage custom session IDs to differentiate between different AI sessions.
112
+
-**File Data Management**: Set, get, and remove file data associated with specific sessions, ideal for sending or receiving large data files.
113
+
114
+
---
115
+
116
+
## 📄 License
117
+
118
+
This project is licensed under the AGPL-3.0 License - see the [LICENSE](./LICENSE) file for details.
0 commit comments