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月