Skip to content

Commit 5fbf506

Browse files
docs readme added.
1 parent 6ffbeaf commit 5fbf506

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

docs/README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Welcome to the Tiny AI API Documentation
2+
3+
Welcome to the official documentation for the **Tiny Ai API** system. This project is designed to help you manage and organize sessions efficiently, handling prompts, dialogues, file data, system instructions, and much more.
4+
5+
With this system, you can:
6+
- **Create and manage data sessions**: Start and stop sessions, and select the active session.
7+
- **Store and retrieve data**: Store prompts, dialogues, file data, and system instructions with easy retrieval.
8+
- **Track session tokens and hashes**: Monitor tokens and hashes associated with specific data within each session.
9+
- **Handle file uploads**: Attach files to sessions and retrieve them as needed.
10+
- **Customize your workflow**: Select the active session, update data, and perform actions programmatically using event-driven methods.
11+
12+
This documentation is designed to provide all the information you need to get up and running with the system. Whether you're building an application or managing multiple data sessions, this guide will walk you through every feature, offering a detailed explanation of how each function works and how to use it effectively.
13+
14+
---
15+
16+
### Table of Contents
17+
18+
- [Introduction](https://github.com/JasminDreasond/TinyAiApi/blob/main/docs/introduction.md) - Get started with the basic setup and first steps.
19+
- [Configs](https://github.com/JasminDreasond/TinyAiApi/blob/main/docs/configs.md) - Session configuration settings and management.
20+
- [Content](https://github.com/JasminDreasond/TinyAiApi/blob/main/docs/content.md) - Manage session content, including prompts, dialogues, and files.
21+
- [Custom](https://github.com/JasminDreasond/TinyAiApi/blob/main/docs/custom.md) - Working with custom values and user-specific configurations.
22+
- [Dev](https://github.com/JasminDreasond/TinyAiApi/blob/main/docs/dev.md) - Development tools and utilities for advanced users.
23+
- [Models](https://github.com/JasminDreasond/TinyAiApi/blob/main/docs/dev.md) - Model configuration and setup.
24+
25+
---
26+
27+
Feel free to explore the documentation to learn about each function and how it can enhance your data session management process. Let's dive in!

0 commit comments

Comments
 (0)