OpenSearch:画像コンテンツの抽出

AI Search Open Platform は、API を介した画像コンテンツ抽出サービスの呼び出しをサポートしています。このサービスをビジネス処理チェーンに統合できます。解析されたテキストは、画像検索や会話型リサーチのシナリオに使用できます。

サービス一覧

• 認証情報を取得します。

  API を使用して AI Search Open Platform サービスを呼び出す場合は、呼び出し元の ID を認証する必要があります。

• サービスアクセスアドレスを取得します。

  インターネットまたは VPC（Virtual Private Cloud）経由でサービスを呼び出すことができます。詳細については、「サービス登録アドレスを取得する」をご参照ください。

非同期抽出タスクの作成

リクエストメソッド

POST

URL

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

• host：サービスを呼び出すためのアドレス。API サービスは、パブリックネットワークと VPC の両方で呼び出すことができます。詳細については、「参照ドキュメント」をご参照ください。

• workspace_name：ワークスペースの名前（例：default）。

• service_id：組み込みサービス ID（例：ops-image-analyze-vlm-001）。

リクエストパラメーター

ヘッダーパラメーター

API-KEY 認証

ボディパラメーター

レスポンスパラメーター

cURL リクエスト例

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

レスポンス例

正常なレスポンス例

{
	"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：サービスを呼び出すためのアドレス。API サービスは、パブリックネットワークと VPC の両方で呼び出すことができます。詳細については、「参照ドキュメント」をご参照ください。

• workspace_name：ワークスペースの名前（例：default）。

• service_id：組み込みサービス ID（例：ops-image-analyze-vlm-001）。

• task_id：画像解析レスポンスで返されたタスク ID（例：cd4e26f0-23ff-449c-83dc-20cc8ff1****）。

リクエストパラメーター

ヘッダーパラメーター

API-KEY 認証

レスポンスパラメーター

cURL リクエスト例

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****" 
 

レスポンス例

正常なレスポンス例

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

異常なレスポンス例

アクセスリクエストでエラーが発生した場合、出力結果には 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：サービスを呼び出すためのアドレス。API サービスはパブリックネットワークと VPC の両方で呼び出すことができます。詳細については、「参照ドキュメント」をご参照ください。

• workspace_name：ワークスペースの名前（例：default）。

• service_id：組み込みサービス ID（例：ops-image-analyze-vlm-001）。

リクエストパラメーター

ヘッダーパラメーター

API-KEY 認証

ボディパラメーター

レスポンスパラメーター

cURL リクエスト例

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

レスポンス例

正常なレスポンス例

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

異常なレスポンス例

アクセスリクエストでエラーが発生した場合、出力結果には 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\\""
}

状態コードの説明

その他の状態コードの説明については、「参照ドキュメント」をご参照ください。