文档
图片生成文字结果接口

获取图片转文字结果

1. 接口地址

https://www.hidreamai.com/api-pub/gw/v3/text/img2txt/async/results

 

2. 请求方式

GET

 

3. 请求参数

Header

参数类型是否必填说明
Authorizationstring客户授权Token
X-accept-languagestring语言偏好,支持['en', 'zh'],en:英文,zh:中文,默认"zh"

Query Params

参数类型是否必填说明
task_idstring提交任务时返回的任务task_id
request_idstring请求的ID,默认为""

curl示例

curl -H 'Authorization: Bearer {USER_Authorization}' -X GET 
-v 'https://www.hidreamai.com/api-pub/gw/v3/text/img2txt/async/results?task_id=9af30d22-3aa3-11ef-b9c0-a28d6ca60ecd&request_id=425d6094-3a73-11ee-85e2-0a4fb61b1c34'

Python示例

import requests

USER_Authorization = <token>
task_id = "6fd16a7c-d6b1-11ee-af0a-52cbc25497eb"  # <task_id>

# 请求头
headers = {
    'Authorization': f'Bearer {USER_Authorization}'
}

# 请求参数
params = {
    'task_id': task_id,
    'request_id': ''
}

# 发送GET请求
url = 'https://www.hidreamai.com/api-pub/gw/v3/text/img2txt/async/results'
response = requests.get(url, headers=headers, params=params)

# 处理响应
if response.status_code == 200:
    if response.json()['code'] == 0:
        results = response.json()['result']['sub_task_results']
        for result in results:
            print(f"task_status: {result['task_status']}, task_completion: {result['task_completion']}, image_url: {result['image']}")
    else:
        print(response.json()['message'])
else:
    print(response.status_code)

 

4. 返回参数

参数类型说明
codeint返回状态码
messagestring返回状态信息
request_idstring本次请求的ID
resultdict返回结果

其中返回结果 result字段具体为:

参数类型说明
task_idstring任务的task_id
sub_task_idslist各个子任务的生成结果

其中sub_task_result字段具体为

参数类型说明
imagestring拓展的的图片的url
image_wmstring加水印的拓展图片的URL
sub_task_idstring子任务的task_id
task_completionfloat子任务的进度,取值范围为0-1的小数点后保留2位的小数
task_statusint子任务的状态,0: 等待中,1: 完成,2: 处理中,3: 失败,4: 未通过审核

示例

{
    "code":0,
    "message":"Success",
    "request_id":"128bfb62-884f-11ee-8ab6-451cb37c3789",
    "result":{
        "sub_task_results":[
            {
                "text":"https://media.hidreamai.com/0ea32e2f-919a-4802-bcb6-11c16a4b03ff.txt",
                "sub_task_id":"2fa58fbb-18d5-445c-bb49-fea88479b06a",
                "task_completion":1,
                "task_status":1
            }
        ],
        "task_id":"9af30d22-3aa3-11ef-b9c0-a28d6ca60ecd"
    }
}