Platform AI Search Open mendukung pemanggilan layanan ekstraksi konten gambar melalui API. Anda dapat mengintegrasikan layanan ini ke dalam rantai pemrosesan bisnis Anda. Teks yang dihasilkan dapat digunakan untuk skenario penelitian pengambilan gambar dan percakapan.
Daftar layanan
Nama Layanan | ID Layanan | Deskripsi Layanan | Batas QPS untuk panggilan API (Akun Alibaba Cloud dan Pengguna RAM) |
Layanan pemahaman konten gambar 001 | ops-image-analyze-vlm-001 | Menyediakan layanan penguraian konten gambar. Dapat mengurai dan memahami konten gambar berdasarkan model multimodal besar dan melakukan OCR. Teks yang diurai dapat digunakan untuk skenario pengambilan gambar dan tanya jawab. | 10 Catatan Untuk mengajukan QPS lebih tinggi, ajukan tiket. |
Layanan pengenalan teks gambar 001 | ops-image-analyze-ocr-001 | Menyediakan layanan pengenalan OCR konten gambar. Dapat mengenali teks dalam gambar berdasarkan kemampuan OCR, mengekstrak informasi teks, dan menggunakannya untuk skenario pengambilan gambar dan tanya jawab. |
Informasi otentikasi diperoleh.
Saat memanggil layanan Platform AI Search Open menggunakan API, Anda perlu mengotentikasi identitas pemanggil.
Alamat akses layanan diperoleh.
Anda dapat memanggil layanan melalui Internet atau virtual private cloud (VPC). Untuk informasi lebih lanjut, lihat Dapatkan Alamat Pendaftaran Layanan.
Buat tugas ekstraksi asinkron
Metode permintaan
POST
URL
{host}/v3/openapi/workspaces/{workspace_name}/image-analyze/{service_id}/asynchost: Alamat untuk memanggil layanan. Layanan API dapat dipanggil melalui jaringan publik dan VPC. Untuk informasi lebih lanjut, lihat Dokumen yang Diriujuk.
workspace_name: Nama ruang kerja, seperti default.
service_id: ID layanan bawaan, seperti ops-image-analyze-vlm-001.
Parameter permintaan
Parameter Header
Otentikasi API-KEY
Parameter | Tipe | Diperlukan | Deskripsi | Contoh |
Content-Type | String | Ya | Jenis permintaan: application/json | application/json |
Authorization | String | Ya | API-Key | Bearer OS-d1**2a |
Parameter Body
Parameter | Tipe | Diperlukan | Deskripsi | Contoh |
service_id | String | Ya | ID layanan bawaan:
| ops-image-analyze-vlm-001 |
document.url | String | Tidak | Menentukan alamat URL tempat file disimpan. Salah satu URL atau konten harus dipilih. Mendukung protokol http dan https. | http://path/to/***.jpg |
document.content | String | Tidak | Menentukan konten file, dikodekan dengan Base64Encode. Salah satu URL atau konten harus dipilih. | "aGVsbG8gd29ybGQ=" |
document.file_name | String | Tidak | Nama file. Jika kosong, akan disimpulkan dari URL. Jika URL kosong, harus ditentukan secara eksplisit. | test.jpg |
document.file_type | String | Tidak | Tipe file. Jika kosong, akan disimpulkan dari akhiran file_name. Jika tidak bisa disimpulkan, harus ditentukan secara eksplisit, seperti jpg, jpeg, png, bmp, tiff. | jpg |
Parameter tanggapan
Parameter | Tipe | Deskripsi | Contoh |
result.task_id | String | ID tugas asinkron penguraian gambar. | 6177bf71-f87f-4d86-ab0c-e2b64dfe**** |
Contoh permintaan 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"
}
}' \
Contoh tanggapan
Contoh tanggapan normal
{
"request_id":"CD4E26F0-23FF-449C-83DC-20CC8FF1****",
"latency":8.0,
"http_code":200,
"result":{
"task_id":"cd4e26f0-23ff-449c-83dc-20cc8ff1****"
}
}Contoh tanggapan abnormal
Jika terjadi kesalahan dalam permintaan akses, hasil keluaran akan menunjukkan alasan kesalahan melalui kode dan pesan.
{
"request_id":"0CCAC03B-D83F-432F-B6BA-C3049576****",
"latency":0.0,
"code":"InvalidParameter",
"http_code":400,
"message":"document.content atau document.url diperlukan, dan keduanya tidak boleh ada secara bersamaan"
}Dapatkan status tugas ekstraksi asinkron
Metode permintaan
GET
URL
{host}/v3/openapi/workspaces/{workspace_name}/image-analyze/{service_id}/async/task-status?task_id=${task_id}host: Alamat untuk memanggil layanan. Layanan API dapat dipanggil melalui jaringan publik dan VPC. Untuk informasi lebih lanjut, lihat Dokumen yang Dirujuk.
workspace_name: Nama ruang kerja, misalnya, default.
service_id: ID layanan bawaan, misalnya, ops-image-analyze-vlm-001.
task_id: ID tugas yang dikembalikan dalam respons penguraian gambar, misalnya, cd4e26f0-23ff-449c-83dc-20cc8ff1****.
Parameter permintaan
Parameter Header
Otentikasi API-KEY
Parameter | Tipe | Diperlukan | Deskripsi | Contoh |
Content-Type | string | Ya | Jenis permintaan: application/json | application/json |
Authorization | string | Ya | API-Key | Bearer OS-d1**2a |
Parameter tanggapan
Parameter | Tipe | Deskripsi | Contoh |
request_id | String | Pengidentifikasi unik yang ditetapkan oleh sistem untuk panggilan API. | 3C09570D-12DB-46B4-BF0F-A100D79B**** |
latency | Float/Int | Latensi permintaan dalam ms. | 3,0 |
result.task_id | String | ID tugas asinkron, tidak ada dalam panggilan sinkron. | a7e4c0f6-874c-47e3-b05b-02278a96e**** |
result.status | String | Status tugas:
| SUCCESS |
result.data | Object | Hasil penguraian gambar. | {"content":"Gambar menunjukkan XXXX", "content_type":"plain"} |
result.data.content | String | Konten gambar. | "XXX" |
result.data.content_type | String | Tipe teks keluaran: plain. | plain |
usage.token_count | int | Jumlah token keluaran, berlaku untuk layanan ops-image-analyze-vlm-001. | 1234 |
usage.pv_count | int | Jumlah panggilan (tetap pada 1), berlaku untuk layanan ops-image-analyze-ocr-001. | 1 |
Contoh permintaan 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****"
Contoh tanggapan
Contoh tanggapan normal
{
"request_id":"3C09570D-12DB-46B4-BF0F-A100D79B****",
"latency":3,0,
"http_code":200,
"result":{
"status":"SUCCESS",
"data":{
"content":"Gambar menunjukkan blender merek WMF dikelilingi oleh berbagai buah dan sayuran. Di sebelah blender terdapat gelas yang diisi dengan jus merah, dengan sedotan dimasukkan. Berserakan di atas meja adalah beberapa irisan lemon, beberapa stroberi, dan beberapa kiwi. Di salah satu sudut meja, ada nanas potong dan jeruk. Selain itu, beberapa wortel dipotong menjadi potongan kecil dan ditempatkan di dalam blender, siap untuk dijus. Keseluruhan adegan terlihat sangat sehat dan lezat.",
"content_type":"plain"
},
"task_id":"d9781786-20b8-4fb4-bbb5-38f82e69****"
},
"usage":{
"token_count":95
}
}Contoh tanggapan abnormal
Jika terjadi kesalahan dalam permintaan akses, hasil keluaran akan menunjukkan alasan kesalahan melalui kode dan pesan.
{
"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"
}Buat tugas ekstraksi sinkron
Metode permintaan
POST
URL
{host}/v3/openapi/workspaces/{workspace_name}/image-analyze/{service_id}/syncDeskripsi parameter
host: Alamat untuk memanggil layanan. Layanan API dapat dipanggil melalui jaringan publik dan VPC. Untuk informasi lebih lanjut, lihat Dokumen yang Dirujuk.
workspace_name: Nama ruang kerja, misalnya, default.
service_id: ID layanan bawaan, misalnya, ops-image-analyze-vlm-001.
Parameter permintaan
Parameter Header
Otentikasi API-KEY
Parameter | Tipe | Diperlukan | Deskripsi | Contoh |
Content-Type | String | Ya | Jenis permintaan: application/json | application/json |
Authorization | String | Ya | API-Key | Bearer OS-d1**2a |
Parameter Body
Parameter | Tipe | Diperlukan | Deskripsi | Contoh |
service_id | String | Ya | ID layanan bawaan:
| ops-image-analyze-vlm-001 |
document.url | String | Tidak | Menentukan alamat URL tempat file disimpan. Salah satu url atau konten harus dipilih. Mendukung protokol http dan https. | http://path/to/***.jpg |
document.content | String | Tidak | Konten dokumen, dikodekan dengan Base64Encode Salah satu document.url atau document.content harus dipilih. | "aGVsbG8gd29ybGQ=" |
document.file_name | String | Tidak | Nama file. Jika kosong, akan disimpulkan dari URL. Jika url kosong, harus ditentukan secara eksplisit. | test.jpg |
document.file_type | String | Tidak | Tipe file. Jika kosong, akan disimpulkan dari akhiran file_name. Jika tidak bisa disimpulkan, harus ditentukan secara eksplisit, seperti jpg, jpeg, png, bmp, tiff. | jpg |
Parameter tanggapan
Parameter | Tipe | Deskripsi | Contoh |
result.status | String | Status tugas:
| SUCCESS |
result.error | String | Pesan kesalahan saat status=FAIL, biasanya kosong. | Gagal mendekripsi dokumen |
result.data | Object | Hasil penguraian gambar. | {"content":"Gambar menunjukkan XXXX", "content_type":"plain"} |
result.data.content | String | Konten gambar. | "XXX" |
result.data.content_type | String | Tipe teks keluaran: plain. | Plain |
request_id | String | Pengidentifikasi unik yang ditetapkan oleh sistem untuk panggilan API. | B4AB89C8-B135-xxxx-A6F8-2BAB801A2CE4 |
latency | Float/Int | Latensi permintaan dalam ms. | 10 |
usage | Object | Informasi penagihan untuk panggilan ini. | "usage": { "token_count": 1234 } |
usage.token_count | Int | Jumlah token keluaran, berlaku untuk layanan ops-image-analyze-vlm-001. | 1234 |
usage.pv_count | Int | Jumlah panggilan (tetap pada 1), berlaku untuk layanan ops-image-analyze-ocr-001. | 1 |
Contoh permintaan 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\"
}
}"Contoh tanggapan
Contoh tanggapan normal
{
"request_id":"BB5CD4C3-C8B6-40E7-A037-4ADAE88A****",
"latency":12525,0,
"http_code":200,
"result":{
"status":"SUCCESS",
"data":{
"content":"Gambar menunjukkan blender merek WMF dikelilingi oleh berbagai buah dan sayuran. Di sebelah blender terdapat gelas yang diisi dengan jus merah, dengan sedotan dimasukkan. Berserakan di atas meja adalah beberapa irisan lemon, beberapa stroberi, dan beberapa kiwi. Di salah satu sudut meja, ada nanas potong dan jeruk. Selain itu, beberapa wortel dipotong menjadi potongan kecil dan ditempatkan di dalam blender, siap untuk dijus. Keseluruhan adegan terlihat sangat sehat dan lezat.",
"content_type":"plain"
}
},
"usage":{
"token_count":95
}
}Contoh tanggapan abnormal
Jika terjadi kesalahan dalam permintaan akses, hasil keluaran akan menunjukkan alasan kesalahan melalui kode dan pesan.
{
"request_id": "6F33AFB6-A35C-4DA7-AFD2-9EA16CCF****",
"latency": 2.0,
"code": "InvalidParameter",
"http_code": 400,
"message": "Kesalahan penguraian JSON: Tidak dapat mendeserialisasi nilai tipe `ImageStorage` dari String \\"xxx\\""
}Deskripsi kode status
Kode status HTTP | Kode kesalahan | Deskripsi |
200 | - | Permintaan berhasil, termasuk skenario kegagalan tugas. Status tugas aktual perlu ditentukan dari result.status. |
404 | BadRequest.TaskNotExist | Tugas tidak ada. |
400 | InvalidParameter | Permintaan tidak valid. |
500 | InternalServerError | Kesalahan internal. |
Untuk deskripsi kode status lebih lanjut, lihat Dokumen yang Dirujuk.