图片内容提取

AI搜索开放平台支持通过API的方式调用图片内容提取服务，您可以将服务集成到您的业务处理链路中，解析后的文本可用于图片检索问答场景。

服务列表

• 获取身份鉴权信息

  通过API调用AI搜索开放平台服务时，需要对调用者身份进行鉴权，如何获取鉴权信息请参见获取API-KEY。

• 获取服务调用地址

  支持通过公网和VPC两种方式调用服务，详情请参见获取服务接入地址。

创建异步提取任务

请求方式

POST

URL

{host}/v3/openapi/workspaces/{workspace_name}/image-analyze/{service_id}/async

• host：调用服务的地址，支持通过公网和VPC两种方式调用API服务，可参见获取服务接入地址。

  

• workspace_name：工作空间名称，例如default。

• service_id： 系统内置服务ID，例如ops-image-analyze-vlm-001。

请求参数

Header参数

API-KEY认证

Body参数

返回参数

Curl请求示例

curl -XPOST -H"Content-Type: application/json" 
"http://***-hangzhou.opensearch.aliyuncs.com/v3/openapi/workspaces/default/image-analyze/ops-image-analyze-vlm-001/async" 
-H "Authorization: Bearer 您的API-KEY" \ 
-d "{    
      \"document\":{    
            \"url\":\"https://img01.yzcdn.cn/****/2017/05/11/FoTMgBa0SvUaAeFruY7i7O_EUMhf.jpg%21middle.jpg\",   
            \"file_type\":\"jpg\"
      }
}"

响应示例

正常响应示例

{
	"request_id":"CD4E26F0-23FF-449C-83DC-20CC8FF1****",
        "latency":8.0,
        "http_code":200,
        "result":{
                  "task_id":"cd4e26f0-23ff-449c-83dc-20cc8ff1****"
        }
}

异常响应示例

在访问请求出错的情况下，输出的结果中会通过code和message指明出错原因。

{
      "request_id":"0CCAC03B-D83F-432F-B6BA-C3049576****",
      "latency":0.0,
      "code":"InvalidParameter",
      "http_code":400,
      "message":"document.content or document.url required, and both cannot be present at the same time"
}

获取异步提取任务状态

请求方式

GET

URL

{host}/v3/openapi/workspaces/{workspace_name}/image-analyze/{service_id}/async/task-status?task_id=${task_id}

• host：调用服务的地址，支持通过公网和VPC两种方式调用API服务，可参见获取服务接入地址。

• workspace_name：工作空间名称，例如default。

• service_id： 系统内置服务ID，例如ops-image-analyze-vlm-001。

• task_id：创建图片解析响应中返回的任务标识ID，例如cd4e26f0-23ff-449c-83dc-20cc8ff1****。

请求参数

Header参数

API-KEY认证

返回参数

Curl请求示例

curl -XGET -H"Content-Type: application/json" 
"http://***-hangzhou.opensearch.aliyuncs.com/v3/openapi/workspaces/default/image-analyze/ops-image-analyze-vlm-001/async/task-status?task_id=d9781786-20b8-4fb4-bbb5-38f82e69****" 
-H "Authorization: Bearer 您的API-KEY" 

响应示例

正常响应示例

{
      "request_id":"3C09570D-12DB-46B4-BF0F-A100D79B****",
      "latency":3.0,
      "http_code":200,
      "result":{
           "status":"SUCCESS",
           "data":{
                "content":"图中展示的是一台WMF品牌的搅拌机，周围摆放着各种水果和蔬菜。搅拌机旁边有一个装有红色果汁的杯子，杯子里还插着一根吸管。桌子上散落着几片柠檬、几个草莓和一些猕猴桃。在桌子的一角还有一个切好的菠萝和一个橙子。此外，还有一些胡萝卜被切成小块放在搅拌机里准备榨汁。整个场景看起来非常健康和美味。",
                "content_type":"plain"
            },
            "task_id":"d9781786-20b8-4fb4-bbb5-38f82e69****"
       },
            "usage":{
                "token_count":95
            }
}

异常响应示例

在访问请求出错的情况下，输出的结果中会通过code和message指明出错原因。

{
  "request_id":"153FC253-468D-4C46-873E-2AEB918C****",
  "latency":2.0,
  "code":"BadRequest.TaskNotExist",
  "http_code":404,
  "message":"task[d9781786-20b8-4fb4-bbb5-38f82e690b****] not exist"
}

创建同步提取任务

请求方式

POST

URL

{host}/v3/openapi/workspaces/{workspace_name}/image-analyze/{service_id}/sync

参数说明

• host：调用服务的地址，支持通过公网和VPC两种方式调用API服务，可参见获取服务接入地址。

• workspace_name：工作空间名称，例如default。

• service_id： 系统内置服务ID，例如ops-image-analyze-vlm-001。

请求参数

Header参数

API-KEY认证

Body参数

返回参数

Curl请求示例

curl -XPOST -H"Content-Type: application/json" 
 "http://***-hangzhou.opensearch.aliyuncs.com/v3/openapi/workspaces/default/image-analyze/ops-image-analyze-vlm-001/sync" 
-H "Authorization: Bearer 您的API-KEY" 
\ -d "{    
      \"document\":{    
            \"url\":\"https://img01.yzcdn.cn/****/2017/05/11/FoTMgBa0SvUaAeFruY7i7O_EUMhf.jpg%21middle.jpg\",   
            \"file_type\":\"jpg\"
      }
}"

响应示例

正常响应示例

{
    "request_id":"BB5CD4C3-C8B6-40E7-A037-4ADAE88A****", 
    "latency":12525.0,
    "http_code":200,
    "result":{
        "status":"SUCCESS",
        "data":{
              "content":" 图中展示的是一台WMF品牌的搅拌机，周围摆放着各种水果和蔬菜。搅拌机旁边有一个装有红色果汁的杯子，杯子里还插着一根吸管。桌子上散落着几片柠 檬、几个草莓和一些猕猴桃。在桌子的一角还有一个切好的菠萝和一个橙子。此外，还有一些胡萝卜被切成小块放在搅拌机里准备榨汁。整个场景看起来非常健康和美味。",
              "content_type":"plain"
        }
      },
      "usage":{
          "token_count":95
      }
}

异常响应示例

在访问请求出错的情况下，输出的结果中会通过code和message指明出错原因。

{
    "request_id": "6F33AFB6-A35C-4DA7-AFD2-9EA16CCF****",
    "latency": 2.0,
    "code": "InvalidParameter",
    "http_code": 400,
    "message": "JSON parse error: Cannot deserialize value of type `ImageStorage` from String \\"xxx\\"
}

状态码说明

更多状态码说明，请参见状态码说明。