OpenSearch：圖片內容提取

服務列表

• 擷取身份鑒權資訊

  通過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 -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <您的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"
    }
  }' \ 

響應樣本

正常響應樣本

{
	"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 -X GET \
-H"Content-Type: application/json" \
-H "Authorization: Bearer 您的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****" 
 

響應樣本

正常響應樣本

{
      "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 -X POST \
-H"Content-Type: application/json" \
-H "Authorization: Bearer 您的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\"
      }
}"

響應樣本

正常響應樣本

{
    "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\\"
}

狀態代碼說明

更多狀態代碼說明，請參見狀態代碼說明。