OpenSearch:Image content extraction

AI Search Open Platform supports invoking image content extraction services through APIs. You can integrate the service into your business processing chain. The parsed text can be used for image retrieval and conversational research scenarios.

Service list

• The authentication information is obtained.

  When you call an AI Search Open Platform service by using an API, you need to authenticate the caller's identity.

• The service access address is obtained.

  You can call a service over the Internet or a virtual private cloud (VPC). For more information, see Get service registration address.

Create an asynchronous extraction task

Request method

POST

URL

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

• host: the address for invoking the service. The API service can be invoked through both public network and VPC. For more information, see the referenced document.

• workspace_name: the name of the workspace, such as default.

• service_id: the built-in service ID, such as ops-image-analyze-vlm-001.

Request parameters

Header parameters

API-KEY authentication

Body parameters

Response parameters

cURL request example

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <Your API key>" \
  "http://***-hangzhou.opensearch.aliyuncs.com/v3/openapi/workspaces/default/image-analyze/ops-image-analyze-vlm-001/async"
  --data '{
    "document": {
      "url": "https://img01.yzcdn.cn/****/2017/05/11/FoTMgBa0SvUaAeFruY7i7O_EUMhf.jpg%21middle.jpg",
      "file_type": "jpg"
    }
  }' \ 

Response example

Normal response example

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

Abnormal response example

In case of an error in the access request, the output result will indicate the error reason through code and 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 the asynchronous extraction task status

Request method

GET

URL

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

• host: The address for invoking the service. The API service can be invoked through both public network and VPC. For more information, see the referenced document.

• workspace_name: The name of the workspace, for example, default.

• service_id: The built-in service ID, for example, ops-image-analyze-vlm-001.

• task_id: The task ID returned in the image parsing response, for example, cd4e26f0-23ff-449c-83dc-20cc8ff1****.

Request parameters

Header parameters

API-KEY authentication

Response parameters

cURL request example

curl -X GET \
-H"Content-Type: application/json" \
-H "Authorization: Bearer <Your API key>" \
"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****" 
 

Response example

Normal response example

{
      "request_id":"3C09570D-12DB-46B4-BF0F-A100D79B****",
      "latency":3.0,
      "http_code":200,
      "result":{
           "status":"SUCCESS",
           "data":{
                "content":"The image shows a WMF brand blender surrounded by various fruits and vegetables. Next to the blender is a cup filled with red juice, with a straw inserted. Scattered on the table are a few slices of lemon, some strawberries, and some kiwis. In one corner of the table, there is a cut pineapple and an orange. Additionally, some carrots are cut into small pieces and placed in the blender, ready for juicing. The whole scene looks very healthy and delicious.",
                "content_type":"plain"
            },
            "task_id":"d9781786-20b8-4fb4-bbb5-38f82e69****"
       },
            "usage":{
                "token_count":95
            }
}

Abnormal response example

In case of an error in the access request, the output result will indicate the error reason through code and 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"
}

Create a synchronous extraction task

Request method

POST

URL

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

Parameter description

• host: The address for invoking the service. The API service can be invoked through both public network and VPC. For more information, see the referenced document.

• workspace_name: The name of the workspace, for example, default.

• service_id: The built-in service ID, for example, ops-image-analyze-vlm-001.

Request parameters

Header parameters

API-KEY authentication

Body parameters

Response parameters

cURL request example

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

Response example

Normal response example

{
    "request_id":"BB5CD4C3-C8B6-40E7-A037-4ADAE88A****", 
    "latency":12525.0,
    "http_code":200,
    "result":{
        "status":"SUCCESS",
        "data":{
              "content":"The image shows a WMF brand blender surrounded by various fruits and vegetables. Next to the blender is a cup filled with red juice, with a straw inserted. Scattered on the table are a few slices of lemon, some strawberries, and some kiwis. In one corner of the table, there is a cut pineapple and an orange. Additionally, some carrots are cut into small pieces and placed in the blender, ready for juicing. The whole scene looks very healthy and delicious.",
              "content_type":"plain"
        }
      },
      "usage":{
          "token_count":95
      }
}

Abnormal response example

In case of an error in the access request, the output result will indicate the error reason through code and 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\\""
}

Status code description

For more status code descriptions, see the referenced document.