图文转换

1. 接口概述

1.1 接口功能

夏柔API-图文转换提供以下核心功能：

• 图像文字识别（OCR）：从图像中提取文字内容。
• 多语言支持：支持中文、英文、日文、韩文等多种语言的文字识别。
• 复杂场景识别：能够处理复杂背景、倾斜文字、手写文字等具有挑战性的图像。
• 表格与结构化数据提取：从图像中提取表格数据，并转换为结构化格式（如Excel、CSV）。
• 手写文字识别：支持手写文字的识别，适用于笔记、签名等场景。

1.2 接口地址

• 正式环境：https://api.xiarou.com/v1/image-to-text
• 测试环境：https://sandbox.xiarou.com/v1/image-to-text

1.3 请求方式

• HTTP方法：POST
• Content-Type：application/json

2. 请求参数

2.1 请求头（Headers）

2.2 请求体（Body）

3. 返回结果

3.1 返回格式

返回结果为JSON格式，包含以下字段：

3.2 返回示例

成功示例

{
  "code": 200,
  "message": "success",
  "data": {
    "text": "这是一个示例文本。",
    "tables": [
      {
        "rows": [
          ["姓名", "年龄", "性别"],
          ["张三", "25", "男"],
          ["李四", "30", "女"]
        ]
      }
    ],
    "format": "json"
  }
}

失败示例

{
  "code": 400,
  "message": "Invalid image URL or Base64 data.",
  "data": null
}

4. 错误码说明

5. 使用示例

5.1 Python调用示例

import requests
import base64

# 设置API地址和认证令牌
url = "https://api.xiarou.com/v1/image-to-text"
headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
}

# 读取图像并转换为Base64
with open("example.jpg", "rb") as image_file:
    image_base64 = base64.b64encode(image_file.read()).decode("utf-8")

# 构造请求体
data = {
    "image_base64": image_base64,
    "language": "zh",
    "output_format": "json",
    "handwriting": False
}

# 发送请求
response = requests.post(url, headers=headers, json=data)

# 处理返回结果
if response.status_code == 200:
    result = response.json()
    print("识别结果：", result["data"]["text"])
else:
    print("请求失败：", response.json())

5.2 cURL调用示例

curl -X POST "https://api.xiarou.com/v1/image-to-text" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
  "image_url": "https://example.com/image.jpg",
  "language": "en",
  "output_format": "txt"
}'

6. 注意事项

1. 图像格式：支持JPG、PNG、BMP等常见图像格式。
2. 图像大小：建议图像大小不超过10MB，分辨率不低于300x300像素。
3. 认证令牌：请妥善保管您的认证令牌，避免泄露。
4. 错误处理：如果请求失败，请根据错误码和错误信息进行排查。

7. 技术支持

如有任何问题或需要技术支持，请联系：

• 邮箱：support@xiarou.com
• 电话：400-123-4567
• 在线客服：访问官网 https://www.xiarou.com 获取帮助。

8. 版本信息

• 当前版本：v1.0
• 更新日期：2023年10月