🚀 DdddOcr API

基于 FastAPI 和 DdddOcr 的高性能 OCR API 服务，提供图像文字识别、滑动验证码匹配和目标检测功能。

自营各类GPT聚合平台

📋 目录

系统要求
安装和启动
API 端点
API 调用示例
注意事项
故障排除
许可证

💻 系统要求

组件	版本
操作系统	Linux（推荐 Ubuntu 20.04 LTS 或更高版本）
Docker	20.10 或更高
Docker Compose	1.29 或更高

🚀 安装和启动

克隆仓库

git clone https://github.com/your-repo/ddddocr-api.git
cd ddddocr-api

启动服务

有三种方式可以启动应用：

a. 使用 docker启动：
1. 构建 Docker 镜像一键docker环境服务器购买，可一元试用
2. 打包镜像
```
  docker build -t ddddocr-api .
```
3. 启动镜像
```
 docker run -d -p 8000:8000 --name ddddocr-api-container ddddocr-api
```
b. 使用 python 命令直接运行：
```
  python app/main.py
```
b. 使用 uvicorn（支持热重载，适合开发）：
```
  uvicorn app.main:app --reload
```
验证服务
```
curl http://localhost:8000/docs
```
如果成功，您将看到 Swagger UI 文档页面。
停止服务

如果使用 Docker：
```
docker stop ddddocr-api-container
```
如果使用 Docker Compose：
```
docker-compose down
```

查看日志

如果使用 Docker：
```
docker logs ddddocr-api-container
```
如果使用 Docker Compose：
```
docker-compose logs
```

🔌 API 端点

1. OCR 识别

🔗 端点：POST /ocr

参数	类型	描述
`file`	File	图片文件（可选）
`image`	String	Base64 编码的图片字符串（可选）
`probability`	Boolean	是否返回概率（默认：false）
`charsets`	String	字符集（可选）
`png_fix`	Boolean	是否进行 PNG 修复（默认：false）

2. 滑动验证码匹配

🔗 端点：POST /slide_match

参数	类型	描述
`target_file`	File	目标图片文件（可选）需要与target字段同时使用
`target`	String	Base64 编码的目标图片字符串（可选）需要与target_file字段同时使用
`background_file`	File	背景图片文件（可选）需要与background字段同时使用
`background`	String	Base64 编码的背景图片字符串（可选）需要与background_file字段同时使用
`simple_target`	Boolean	是否使用简单目标（默认：false）
	`target_file`和`target` 为一组字段，`background_file`和`background` 为一组字段，两组字段不可同时使用，同时使用则仅一组会生效

3. 目标检测

🔗 端点：POST /detection

参数	类型	描述
`file`	File	图片文件（可选）
`image`	String	Base64 编码的图片字符串（可选）

📘 API 调用示例

Python

```python import requests import base64 url = "http://localhost:8000/ocr" image_path = "path/to/your/image.jpg" with open(image_path, "rb") as image_file: encoded_string = base64.b64encode(image_file.read()).decode('utf-8') data = { "image": encoded_string, "probability": False, "png_fix": False } response = requests.post(url, data=data) print(response.json()) ```

Node.js

```javascript const axios = require('axios'); const fs = require('fs'); const url = 'http://localhost:8000/ocr'; const imagePath = 'path/to/your/image.jpg'; const imageBuffer = fs.readFileSync(imagePath); const base64Image = imageBuffer.toString('base64'); const data = { image: base64Image, probability: false, png_fix: false }; axios.post(url, data) .then(response => { console.log(response.data); }) .catch(error => { console.error('Error:', error); }); ```

```csharp using System; using System.Net.Http; using System.IO; using System.Threading.Tasks; class Program { static async Task Main(string[] args) { var url = "http://localhost:8000/ocr"; var imagePath = "path/to/your/image.jpg"; var imageBytes = File.ReadAllBytes(imagePath); var base64Image = Convert.ToBase64String(imageBytes); var client = new HttpClient(); var content = new MultipartFormDataContent(); content.Add(new StringContent(base64Image), "image"); content.Add(new StringContent("false"), "probability"); content.Add(new StringContent("false"), "png_fix"); var response = await client.PostAsync(url, content); var result = await response.Content.ReadAsStringAsync(); Console.WriteLine(result); } } ```

PHP

```php $imageData, 'probability' => 'false', 'png_fix' => 'false' ); $options = array( 'http' => array( 'header' => "Content-type: application/x-www-form-urlencoded\r\n", 'method' => 'POST', 'content' => http_build_query($data) ) ); $context = stream_context_create($options); $result = file_get_contents($url, false, $context); echo $result; ?> ```

```go package main import ( "bytes" "encoding/base64" "encoding/json" "fmt" "io/ioutil" "net/http" "net/url" ) func main() { apiURL := "http://localhost:8000/ocr" imagePath := "path/to/your/image.jpg" imageData, err := ioutil.ReadFile(imagePath) if err != nil { panic(err) } base64Image := base64.StdEncoding.EncodeToString(imageData) data := url.Values{} data.Set("image", base64Image) data.Set("probability", "false") data.Set("png_fix", "false") resp, err := http.PostForm(apiURL, data) if err != nil { panic(err) } defer resp.Body.Close() body, err := ioutil.ReadAll(resp.Body) if err != nil { panic(err) } fmt.Println(string(body)) } ```

易语言

```易语言 .版本 2 .程序集调用OCR接口 .子程序主函数, 整数型 .局部变量请求头, QQ.HttpHeaders .局部变量请求内容, QQ.HttpMultiData .局部变量图片路径, 文本型 .局部变量图片数据, 字节集 .局部变量 HTTP, QQ.Http 图片路径＝ "path/to/your/image.jpg" 图片数据＝读入文件 (图片路径) 请求头.添加 ("Content-Type", "application/x-www-form-urlencoded") 请求内容.添加文本 ("image", 到Base64 (图片数据)) 请求内容.添加文本 ("probability", "false") 请求内容.添加文本 ("png_fix", "false") HTTP.发送POST请求 ("http://localhost:8000/ocr", 请求内容, 请求头) 调试输出 (HTTP.获取返回文本()) 返回 (0) ```

注意：使用示例前，请确保安装了必要的依赖库，并根据实际环境修改服务器地址和图片路径。

⚠️ 注意事项

确保防火墙允许访问 8000 端口。
生产环境建议配置 HTTPS 和适当的身份验证机制。
定期更新 Docker 镜像以获取最新的安全补丁和功能更新。

🔧 故障排除

遇到问题？请检查以下几点：

确保 Docker 服务正在运行。
检查容器日志：
```
docker logs ddddocr-api-container
```
确保没有其他服务占用 8000 端口。

如果问题仍然存在，请提交 issue 到本项目的 GitHub 仓库。

📄 许可证

本项目采用 MIT 许可证。详情请参见 LICENSE 文件。

Made with ❤️ by sml2h3

sml2h3 / ddddocr-fastapi

readme