# code

**Repository Path**: zhengxscode/code

## Basic Information

- **Project Name**: code
- **Description**: c
 project
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-08-07
- **Last Updated**: 2026-01-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 芯片手册阅读器

一个基于火山引擎deepseek API的芯片手册阅读器，支持PDF和TXT格式的芯片手册，提供专业的芯片相关问答功能。

## 功能特点

- 支持PDF和TXT格式的芯片手册
- 自动文档处理和文本分块
- 基于关键词匹配的上下文检索
- 与火山引擎deepseek API集成
- 支持多轮对话
- 支持从.env文件加载配置
- 提供命令行和Web两种使用方式
- 简洁美观的Web界面
- 实时聊天体验
- 系统状态监控

## 系统要求

- CentOS 7/8
- Python 3.7+
- 网络连接（用于调用API）

## 部署步骤

### 1. 准备工作

- 确保您有火山引擎的API Key
- 将芯片手册PDF文件（TC3XXp1.pdf）准备好

### 2. 自动部署

使用提供的部署脚本进行自动部署：

```bash
# 赋予执行权限
chmod +x deploy.sh

# 执行部署脚本
./deploy.sh
```

部署脚本会自动完成以下工作：
- 检查并安装Python 3
- 升级pip
- 安装系统依赖
- 创建项目目录
- 安装项目依赖
- 创建启动脚本
- 创建配置文件示例

### 3. 手动部署

如果您希望手动部署，可以按照以下步骤进行：

#### 3.1 安装系统依赖

```bash
yum install -y python3 python3-pip python3-devel gcc gcc-c++ make openssl-devel libffi-devel
```

#### 3.2 安装项目依赖

```bash
pip3 install -e .
pip3 install httpx pydantic PyPDF2 python-dotenv
```

#### 3.3 配置环境变量

编辑.env文件，设置您的API Key和PDF文件路径：

```bash
vim .env
```

添加以下内容：

```
ARK_API_KEY=your_api_key_here
PDF_FILE_PATH=/project/TC397/TC3XXp1.pdf
```

### 4. 启动脚本

```bash
python3 volcengine_sample/chip_manual_reader.py
```

或者使用创建的启动脚本：

```bash
./start.sh
```

## 使用说明

1. 脚本启动后会自动处理指定的PDF文件
2. 处理完成后会显示主菜单
3. 选择2进行提问，输入您的问题
4. 系统会基于文档内容生成专业回答

## 配置说明

### .env文件配置

| 配置项 | 说明 | 默认值 |
|--------|------|--------|
| ARK_API_KEY | 火山引擎API Key | 0623b496-dcfd-4c3b-a3c7-19f8f7201138 |
| PDF_FILE_PATH | PDF文件路径 | /project/TC397/TC3XXp1.pdf |

### 代码配置

如果您需要修改更多配置，可以编辑`volcengine_sample/chip_manual_reader.py`文件：

- `chunk_size`: 文本分块大小，默认1000字符
- `chunk_overlap`: 块之间的重叠字符数，默认200字符
- `max_pages`: PDF处理的最大页数，默认5页

## 目录结构

```
.
├── volcengine_sample/
│   ├── chip_manual_reader.py  # 主脚本
│   └── __init__.py
├── deploy.sh                  # 部署脚本
├── start.sh                   # 启动脚本
├── .env                       # 环境配置文件
├── .env.example               # 环境配置示例
├── setup.py                   # 项目依赖配置
└── README.md                  # 项目说明文档
```

## 故障排除

### 1. API调用失败

- 检查API Key是否正确
- 检查网络连接是否正常
- 查看脚本输出的错误信息

### 2. PDF文件处理失败

- 检查PDF文件路径是否正确
- 检查PDF文件是否损坏
- 查看脚本输出的错误信息

### 3. 脚本无法启动

- 检查Python环境是否正确安装
- 检查依赖是否安装完成
- 查看脚本输出的错误信息

## 许可证

MIT

## 联系方式

如有问题，请联系项目维护者。