|
1 | | -# NextConsole |
2 | 1 |
|
3 | | -## 项目简介 |
| 2 | +<p align="center"> |
| 3 | + <img src="docs/logo_text.svg" width="200" alt="NextConsole Logo"> |
| 4 | + <p align="center">Unleashing the Power of LLM for Enterprises💪</p> |
| 5 | + <p align="center"> |
| 6 | + <img src="https://img.shields.io/badge/Python-3.10%2B-blue" alt="Python Version"> |
| 7 | + <img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" alt="Apache 2.0 License"> |
| 8 | + </p> |
| 9 | +</p> |
| 10 | + |
| 11 | +## Introduction |
| 12 | +NextConsole is an open - source project meticulously crafted for enterprise users, designed to empower businesses to rapidly and efficiently construct intelligent systems based on large - language models. With NextConsole, enterprises can effortlessly build intelligent agents, knowledge bases, workflows, and a wide range of applications, significantly reducing development time and costs while accelerating the process of enterprise digital transformation. 🚀 |
| 13 | + |
| 14 | +### Key Features |
| 15 | +| Feature | Description | |
| 16 | +| ---- | ---- | |
| 17 | +| **Rapid Development** ⚡ | NextConsole streamlines the development process, allowing enterprises to quickly implement large - language model - based solutions without getting bogged down in complex technical details. | |
| 18 | +| **Customization** 🛠️ | The open - source nature of NextConsole enables enterprises to customize the system according to their specific needs, tailoring intelligent agents, knowledge bases, and workflows to fit unique business requirements. | |
| 19 | +| **Scalability** 🔀 | The architecture of NextConsole is designed to scale, accommodating the growth of enterprise data and business operations, ensuring long - term viability and adaptability. | |
| 20 | + |
| 21 | +### Application Scenarios |
| 22 | + |
| 23 | +#### IT Operations |
| 24 | +In the realm of IT operations, NextConsole revolutionizes the way enterprises manage their systems. Intelligent agents can continuously monitor system status in real - time, leveraging the knowledge base to swiftly diagnose and resolve issues. By optimizing workflows, NextConsole enhances the efficiency and quality of IT operations. |
| 25 | + |
| 26 | +| Company Type | Before NextConsole | After NextConsole | |
| 27 | +| ---- | ---- | ---- | |
| 28 | +| Multinational Corporation | Incident response time: long <br> Problem resolution rate: relatively low | Incident response time reduced by 50% <br> Problem resolution rate increased by 30% | |
| 29 | + |
| 30 | +For instance, a multinational corporation's IT department adopted NextConsole and witnessed remarkable improvements as shown in the table above. |
| 31 | + |
| 32 | +#### Document Intelligent Review |
| 33 | +NextConsole also excels in document intelligent review scenarios. It can perform rapid and accurate reviews of documents based on predefined rules and the knowledge base, highlighting errors, vulnerabilities, and improvement suggestions. |
| 34 | + |
| 35 | +| Company Type | Before NextConsole | After NextConsole | |
| 36 | +| ---- | ---- | ---- | |
| 37 | +| Leading Law Firm | Review cycle: days <br> Service responsiveness: limited | Review cycle reduced from days to hours <br> Service responsiveness significantly enhanced | |
| 38 | + |
| 39 | +A leading law firm integrated NextConsole into its document review process, and the results are clearly presented in the table. |
| 40 | + |
| 41 | +NextConsole offers enterprises a powerful, open - source platform that combines the latest advancements in large - language models with practical, real - world applications. Whether you're looking to enhance IT operations or streamline document review processes, NextConsole is your go - to solution for building intelligent, efficient, and customized enterprise applications. 🌟 |
| 42 | + |
| 43 | + |
| 44 | +### Quick Start |
| 45 | + |
| 46 | +#### Basic Resource Dependencies |
| 47 | +Before starting to use NextConsole, please ensure that your environment meets the following basic resource dependencies: |
| 48 | +- **Hardware Configuration**: At least 2 CPU cores and 4GB of memory. |
| 49 | +- **Operating System**: Linux system. |
| 50 | +- **Browser**: Chrome browser, version 110 or higher. |
| 51 | +- **Containerization Tool**: Docker. |
| 52 | + |
| 53 | +#### Operation Steps |
| 54 | + |
| 55 | +##### 1. Navigate to the Project Directory |
| 56 | +Open the terminal and use the `cd` command to enter the Docker directory of NextConsole: |
| 57 | +```bash |
| 58 | +cd next_console/docker |
| 59 | +``` |
| 60 | + |
| 61 | +##### 2. Configure the Service |
| 62 | +Use the `vi` editor to open the configuration file `config/server/config_private.py`: |
| 63 | +```bash |
| 64 | +vi config/server/config_private.py |
| 65 | +``` |
| 66 | +In the configuration file, you need to make the following configurations: |
| 67 | + |
| 68 | +**Domain Configuration**: |
| 69 | +Set the domain name of the application. Here is an example using the local address: |
| 70 | +```python |
| 71 | +app.config["domain"] = "http://127.0.0.1:8080" |
| 72 | +``` |
| 73 | + |
| 74 | +**RAG (Retrieval Augmented Generation) Configuration**: |
| 75 | +It is recommended to use the free embedding and reranking models provided by Siliconflow. The specific configurations are as follows: |
| 76 | +```python |
| 77 | +# Vector model (It is recommended to use the free embed and rerank models from Siliconflow) |
| 78 | +app.config["EMBEDDING_ENDPOINT"] = "https://api.siliconflow.cn/v1/embeddings" |
| 79 | +app.config["EMBEDDING_MODEL"] = "BAAI/bge-m3" |
| 80 | +app.config["EMBEDDING_KEY"] = "" |
| 81 | +app.config["RERANK_ENDPOINT"] = "https://api.siliconflow.cn/v1/rerank" |
| 82 | +app.config["RERANK_MODEL"] = "BAAI/bge-reranker-v2-m3" |
| 83 | +app.config["RERANK_KEY"] = "" |
| 84 | +app.config["search_engine_endpoint"] = "https://google.serper.dev/search" |
| 85 | +app.config["search_engine_key"] = "" |
| 86 | +``` |
| 87 | +Please fill in the corresponding keys (`EMBEDDING_KEY`, `RERANK_KEY`, `search_engine_key`) according to the actual situation. If you don't have them for now, you can leave them blank. |
| 88 | + |
| 89 | +##### 3. Start the Docker Containers |
| 90 | +After the configuration is completed, use the following command to start the Docker containers: |
| 91 | +```bash |
| 92 | +docker compose up -d |
| 93 | +``` |
| 94 | + |
| 95 | +##### 4. Access the Services |
| 96 | +After the successful startup, you can access the corresponding services through the following addresses: |
| 97 | +- **Server Service**: Visit `http://127.0.0.1:8080` |
| 98 | +- **Admin Service**: Visit `http://127.0.0.1:8082` |
| 99 | + |
| 100 | +**Default Login Information**: |
| 101 | +- **Username**: `admin@nextconsole.cn` |
| 102 | +- **Password**: `next_console` |
| 103 | + |
| 104 | +##### 5. Initial Model Configuration |
| 105 | +Log in to the Admin service at port `8082`. Find the "Model Management" function module and configure the corresponding models according to your needs. |
| 106 | + |
| 107 | +##### 6. Start the First Conversation |
| 108 | +Log in to the Server service at port `8080`. Click on the "AI Workbench" to start your intelligent experience! |
4 | 109 |
|
5 | | -NextConsole是一款专门为快速解决AI-Agent企业落地应用而设计的软件。它采用了最新的人工智能技术，可以解析用户的问题，通过预设的答案库或者实时计算来给出答案，有效提高运维效率。 |
6 | | - |
7 | | -## 功能特性 |
8 | | - |
9 | | -- **智能诊断**：NextConsole可以对用户提出的问题进行智能诊断，通过匹配问题关键词，找出问题的可能原因，并给出解决方案。 |
10 | | - |
11 | | -- **自动化运维**：NextConsole可以执行一些常见的运维任务，如系统状态检查、日志分析、备份等。 |
12 | | - |
13 | | -- **实时监控**：NextConsole可以实时监控系统状态，当发现异常时会自动发送报警通知。 |
14 | | - |
15 | | -- **知识库搜索**：NextConsole内置了丰富的知识库工具，用户可以通过关键词搜索找到所需的信息。 |
16 | | - |
17 | | -## 环境需求 |
18 | | - |
19 | | -nc需要在Python 3.10以上版本环境中运行。 |
20 | | -## 安装步骤 |
21 | | - |
22 | | -1. 克隆或下载本项目到本地 |
23 | | -2. 在项目目录下打开命令行，运行以下命令安装依赖： |
24 | | - ``` |
25 | | - pip install -r requirements.txt |
26 | | - ``` |
27 | | -3. 运行启动命令来启动小亦运维助手： |
28 | | - ```bash |
29 | | - bash start.sh |
30 | | - ``` |
31 | | - |
32 | | -## 使用说明 |
33 | | - |
34 | | -打开NextConsole的主界面，输入你的问题或任务，然后点击“提交”按钮，nc会自动处理并给出结果。 |
35 | | - |
36 | | -## 项目支持 |
37 | | - |
38 | | -如果你在使用过程中遇到任何问题，欢迎提交Issues，我们会尽快解答。同时，我们也欢迎你参与到NextConsole的开发和完善中来。 |
39 | | - |
40 | | ---- |
41 | | -感谢你对NextConsole的关注和支持，希望它能成为你工作的得力助手！ |
42 | | - |
43 | | - |
| 110 | +By following the above steps, you can quickly start NextConsole and begin using it! 😃 |
| 111 | + |
| 112 | + |
| 113 | +### Core Feature Descriptions |
| 114 | + |
| 115 | +#### 1. AI Resource Library 📚 |
| 116 | +The AI Resource Library serves as a reliable data management assistant, providing fundamental data for Retrieval Augmented Generation (RAG). |
44 | 117 |
|
| 118 | +| Function | Description | |
| 119 | +| ---- | ---- | |
| 120 | +| File Management | Allows users to upload, download, delete, and rename files. It also supports creating folders for organized storage. For example, a company's R & D department can categorize technical documents. | |
| 121 | +| File Preview | Enables direct preview of common file formats without the need for external applications. Marketing staff can quickly view research reports, for instance. | |
| 122 | +| File Sharing | Supports sharing files with customizable access permissions through various methods. A project manager can share progress reports securely. | |
| 123 | +| Data Provision for RAG | Conducts semantic analysis and indexing of files to assist large - language models in providing accurate responses. An intelligent customer service can refer to the library for answers. | |
| 124 | + |
| 125 | +#### 2. AI Workbench 🛠️ |
| 126 | +The AI Workbench integrates AI search and AI - agent application functions, offering a one - stop interactive experience. |
| 127 | + |
| 128 | +| Function | Description | |
| 129 | +| ---- | ---- | |
| 130 | +| AI Search | Supports both keyword - based and semantic searches, presenting sorted results. Searching for ways to enhance product competitiveness can yield comprehensive answers. | |
| 131 | +| AI - agent Applications | Integrates a variety of professional AI - agents that can be invoked with simple instructions. Copywriters can use them to generate promotional copy. | |
| 132 | + |
| 133 | +#### 3. AI Application Factory 🏭 |
| 134 | +The AI Application Factory enables visual construction and management of large - model agents. |
| 135 | + |
| 136 | +| Function | Description | |
| 137 | +| ---- | ---- | |
| 138 | +| Visual Construction | Uses a graphical interface to drag and drop components without complex coding. A business department can build an intelligent customer - service workflow, for example. | |
| 139 | +| Release Management | Supports version control, performance monitoring, etc., and allows for on - demand optimization. A development team can regularly optimize agents. | |
0 commit comments