Spaces:
Runtime error
Runtime error
docs: update README to enhance feature descriptions and add chat profile configuration details
Browse files
README.md
CHANGED
|
@@ -10,18 +10,33 @@ pinned: false
|
|
| 10 |
---
|
| 11 |
|
| 12 |
|
| 13 |
-
# Thinking Model Client
|
| 14 |
-
|
| 15 |
-
|
| 16 |
-
|
| 17 |
-
|
| 18 |
-
|
| 19 |
-
|
| 20 |
-
|
| 21 |
-
|
| 22 |
-
-
|
| 23 |
-
-
|
| 24 |
-
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 25 |
|
| 26 |
## Getting Started
|
| 27 |
|
|
@@ -57,11 +72,24 @@ This will concurrently run both the frontend development server and the backend
|
|
| 57 |
|
| 58 |
## Configuration
|
| 59 |
|
| 60 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 61 |
|
| 62 |
-
|
| 63 |
-
- Ends with / β /chat/completions will be appended
|
| 64 |
-
- Ends with # β # will be removed
|
| 65 |
-
- Other cases β /v1/chat/completions will be appended
|
| 66 |
-
- API Key
|
| 67 |
-
- Model Name (e.g., DeepSeek-R1)
|
|
|
|
| 10 |
---
|
| 11 |
|
| 12 |
|
| 13 |
+
# Thinking Model Client π§ π€
|
| 14 |
+
|
| 15 |
+
[](https://opensource.org/licenses/MIT)
|
| 16 |
+
[](https://nodejs.org/)
|
| 17 |
+
[](https://www.docker.com/)
|
| 18 |
+
|
| 19 |
+
A modern React-based chat application that provides a unique interface for interacting with AI models. The application not only displays model responses but also visualizes the thinking process behind each response, giving users insight into how the AI arrives at its conclusions.
|
| 20 |
+
|
| 21 |
+
## Table of Contents
|
| 22 |
+
- [Features](#features)
|
| 23 |
+
- [Getting Started](#getting-started)
|
| 24 |
+
- [Prerequisites](#prerequisites)
|
| 25 |
+
- [Installation](#installation)
|
| 26 |
+
- [Configuration](#configuration)
|
| 27 |
+
|
| 28 |
+
## Features β¨
|
| 29 |
+
|
| 30 |
+
- π§ **Thinking Process Visualization**: See the step-by-step reasoning behind each AI response with interactive visualizations
|
| 31 |
+
- π **Flexible API Integration**: Easily connect to different AI models through configurable API endpoints
|
| 32 |
+
- πΎ **Conversation Persistence**: All chats are automatically saved in local storage for continuity
|
| 33 |
+
- π³ **Docker Deployment**: Ready for containerized deployment with included Docker configuration
|
| 34 |
+
- βοΈ **Customizable Settings**: Adjust API parameters and model configurations through an intuitive settings panel
|
| 35 |
+
- π¬ **Real-time Chat**: Modern interface with smooth animations and multiple conversation tabs
|
| 36 |
+
- π€ **Multiple Models**: Support for various AI model integrations through a unified interface
|
| 37 |
+
- π οΈ **Modern Stack**: Built with React and Vite for optimal performance and development experience
|
| 38 |
+
- π§ͺ **Quality Assured**: Comprehensive unit tests ensure reliable functionality
|
| 39 |
+
- π **Local Data Storage**: All data is stored locally for enhanced privacy and security
|
| 40 |
|
| 41 |
## Getting Started
|
| 42 |
|
|
|
|
| 72 |
|
| 73 |
## Configuration
|
| 74 |
|
| 75 |
+
The application can be configured through the settings panel, which supports multiple profiles:
|
| 76 |
+
|
| 77 |
+
### Chat Profiles
|
| 78 |
+
|
| 79 |
+
Each chat profile includes:
|
| 80 |
+
- **Profile Name**: Custom name for the profile
|
| 81 |
+
- **API Endpoint**: The endpoint for the AI model
|
| 82 |
+
- Ends with `/` β `/chat/completions` will be appended
|
| 83 |
+
- Ends with `#` β `#` will be removed
|
| 84 |
+
- Other cases β `/v1/chat/completions` will be appended
|
| 85 |
+
- **API Key**: Your authentication key for the API
|
| 86 |
+
- **Model Name**: The model to use (e.g., DeepSeek-R1)
|
| 87 |
+
|
| 88 |
+
### Summarization Profile
|
| 89 |
+
|
| 90 |
+
A separate profile for conversation summarization:
|
| 91 |
+
- **API Endpoint**: Endpoint for the summarization service
|
| 92 |
+
- **API Key**: Authentication key for summarization
|
| 93 |
+
- **Model Name**: The model to use for summarization
|
| 94 |
|
| 95 |
+
All settings are stored locally for privacy and security. You can manage multiple chat profiles and switch between them as needed.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|