# ocr-proxy

**Repository Path**: yuexiaoban/ocr-proxy

## Basic Information

- **Project Name**: ocr-proxy
- **Description**: No description available
- **Primary Language**: Python
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-10-26
- **Last Updated**: 2025-12-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# OCR Proxy Service

OCR Proxy 是一个基于 FastAPI 构建的高性能 OCR 服务，支持多种输入方式的图片文字识别功能。该服务集成了 PaddleOCR 引擎，提供准确的文字识别能力。

## 功能特性

- **多输入方式支持**：
  - 文件上传识别
  - URL 图片识别
  - Base64 编码图片识别
- **高性能 OCR 引擎**：集成 PaddleOCR，支持中英文识别
- **RESTful API**：基于 FastAPI 构建，提供自动生成的 API 文档
- **异步处理**：支持高并发请求处理
- **图片存储**：自动保存处理过的图片文件

## API 接口

### 1. 文件上传 OCR

```http
POST /ocr/file
Content-Type: multipart/form-data
```


**参数**：
- `file`: 上传的图片文件

### 2. URL 图片 OCR

```http
POST /ocr/url
Content-Type: application/x-www-form-urlencoded
```


**参数**：
- `url`: 图片的 URL 地址

### 3. Base64 图片 OCR

```http
POST /ocr/base64
Content-Type: application/x-www-form-urlencoded
```


**参数**：
- `base64_image`: Base64 编码的图片数据

### 4. 健康检查

```http
GET /health
```


## 响应格式

所有接口返回统一的 OCRResponse 格式：

```json
{
  "success": true,
  "result": {
    "text_list": ["识别的文字内容1", "识别的文字内容2"],
    "poly_list": [[[x1,y1],[x2,y2],[x3,y3],[x4,y4]], [...]]
  },
  "error": null
}
```


## 快速开始

### 环境要求

- Python 3.13+
- 需要有英伟达的显卡
- CUDA 11.8 12.6 12.9


### 安装依赖

```bash
uv sync
```


### 启动服务
根据你的cuda版本修改仓库地址

CUDA-11.8: https://www.paddlepaddle.org.cn/packages/stable/cu118/

CUDA-12.6: https://www.paddlepaddle.org.cn/packages/stable/cu126/

CUDA-12.9: https://www.paddlepaddle.org.cn/packages/stable/cu129/

```bash
启动ocr服务.bat
```


服务默认运行在 `http://localhost:8000`

### 访问文档

启动服务后，可通过以下地址访问自动生成的 API 文档：

- Swagger UI: `http://localhost:8000/docs`
- ReDoc: `http://localhost:8000/redoc`

## 配置说明

服务配置通过环境变量进行管理：

- `UPLOAD_DIR`: 图片上传目录（默认：`./uploads`）

## 错误处理

服务提供完善的错误处理机制，常见错误类型：

- `400`: 请求参数错误
- `500`: 服务内部错误

## 日志记录

使用 `loguru` 进行日志记录，包含请求处理、OCR识别耗时等关键信息。

## 性能监控

- 支持异步文件处理
- OCR识别时间记录
- 详细的日志追踪

## 贡献指南

欢迎提交 Issue 和 Pull Request 来改进项目。

## 许可证

MIT License