# chatchat4nl

**Repository Path**: beichenlpl/chatchat

## Basic Information

- **Project Name**: chatchat4nl
- **Description**: 基于python开发的大模型调用基础框架
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 5
- **Forks**: 0
- **Created**: 2024-12-06
- **Last Updated**: 2026-03-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Python, llm, AI

## README



# chatchat

#### 介绍
`chatchat` 是一个基于 Python 开发的大模型调用基础框架。它整合了多种功能，包括对话生成、热点信息提取、事件总结等。该项目旨在为用户提供一个轻量级、可扩展的工具，以方便与大模型进行交互。

#### 核心特性
- 支持通过 API、CLI 以及 GUI 多种方式进行交互。
- 提供记忆增强功能，以优化对话体验。
- 可扩展的 Agent 架构，支持多种任务类型。
- 内置 MiniSearch 模块，用于文档检索。

#### 使用说明
1. 安装依赖
   - 通过 `chat_GUI/install.sh`（Linux/Mac）或 `chat_GUI/install.bat`（Windows）安装项目所需的运行环境。

2. 配置
   - 修改 `model.config.demo` 中的模型参数以匹配你的使用场景。

3. 启动 API 服务
   - 运行 `main.py` 启动服务。

4. 交互方式
   - 通过 CLI 调用 Agent: 使用 `cli/__init__.py` 提供的功能。
   - 使用 GUI: 通过运行 `chat_GUI/mini_chat.pyw` 进行简易对话。
   - 通过 `/chat` 和 `/agent` 接口进行 HTTP 请求交互。

5. 搜索功能
   - 使用 `mini_search/__init__.py` 模块来创建、索引和搜索文档。

#### 参与贡献
欢迎提交 PR 和 Issue，以帮助我们改进框架。请参考 `.gitee/ISSUE_TEMPLATE.zh-CN.md` 和 `.gitee/PULL_REQUEST_TEMPLATE.zh-CN.md` 了解如何提交问题和请求审核。