AI搜索開放平臺支持通過API的方式調(diào)用圖片內(nèi)容提取服務(wù)，您可以將服務(wù)集成到您的業(yè)務(wù)處理鏈路中，解析后的文本可用于圖片檢索問答場景。

服務(wù)列表

前提條件

• 獲取身份鑒權(quán)信息

  通過API調(diào)用AI搜索開放平臺服務(wù)時，需要對調(diào)用者身份進行鑒權(quán)，如何獲取鑒權(quán)信息請參見獲取API-KEY。

• 獲取服務(wù)調(diào)用地址

  支持通過公網(wǎng)和VPC兩種方式調(diào)用服務(wù)，詳情請參見獲取服務(wù)接入地址。

創(chuàng)建異步提取任務(wù)

請求方式

POST

URL

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

• host：調(diào)用服務(wù)的地址，支持通過公網(wǎng)和VPC兩種方式調(diào)用API服務(wù)，可參見獲取服務(wù)接入地址。

  

• workspace_name：工作空間名稱，例如default。

• service_id： 系統(tǒng)內(nèi)置服務(wù)ID，例如ops-image-analyze-vlm-001。

請求參數(shù)

Header參數(shù)

API-KEY認證

Body參數(shù)

返回參數(shù)

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

響應(yīng)示例

正常響應(yīng)示例

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

異常響應(yīng)示例

在訪問請求出錯的情況下，輸出的結(jié)果中會通過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"
}

獲取異步提取任務(wù)狀態(tài)

請求方式

GET

URL

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

• host：調(diào)用服務(wù)的地址，支持通過公網(wǎng)和VPC兩種方式調(diào)用API服務(wù)，可參見獲取服務(wù)接入地址。

• workspace_name：工作空間名稱，例如default。

• service_id： 系統(tǒng)內(nèi)置服務(wù)ID，例如ops-image-analyze-vlm-001。

• task_id：創(chuàng)建圖片解析響應(yīng)中返回的任務(wù)標識ID，例如cd4e26f0-23ff-449c-83dc-20cc8ff1****。

請求參數(shù)

Header參數(shù)

API-KEY認證

返回參數(shù)

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" 

響應(yīng)示例

正常響應(yīng)示例

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

異常響應(yīng)示例

在訪問請求出錯的情況下，輸出的結(jié)果中會通過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"
}

創(chuàng)建同步提取任務(wù)

請求方式

POST

URL

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

參數(shù)說明

• host：調(diào)用服務(wù)的地址，支持通過公網(wǎng)和VPC兩種方式調(diào)用API服務(wù)，可參見獲取服務(wù)接入地址。

• workspace_name：工作空間名稱，例如default。

• service_id： 系統(tǒng)內(nèi)置服務(wù)ID，例如ops-image-analyze-vlm-001。

請求參數(shù)

Header參數(shù)

API-KEY認證

Body參數(shù)

返回參數(shù)

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

響應(yīng)示例

正常響應(yīng)示例

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

異常響應(yīng)示例

在訪問請求出錯的情況下，輸出的結(jié)果中會通過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\\"
}

狀態(tài)碼說明

更多狀態(tài)碼說明，請參見狀態(tài)碼說明。