Ekstraksi konten gambar pada AI Search Open Platform - OpenSearch

OpenSearch memungkinkan Anda memanggil layanan ekstraksi konten gambar melalui API, mengintegrasikannya ke dalam alur kerja bisnis, serta memanfaatkan teks hasil ekstraksi untuk pengambilan gambar dan tanya jawab.

Daftar layanan

Nama layanan	ID layanan	Deskripsi	API QPS Limit
Image Content Understanding Service 001	ops-image-analyze-vlm-001	Menganalisis konten gambar dan mengenali teks menggunakan model besar multimodal, memungkinkan aplikasi seperti pengambilan gambar dan tanya jawab.	10 Catatan Untuk meminta batas QPS API yang lebih tinggi, kirimkan tiket ke dukungan teknis.
Image OCR Service 001	ops-image-analyze-ocr-001	Mengekstraksi teks dari gambar menggunakan OCR, memungkinkan aplikasi seperti pengambilan gambar dan tanya jawab.

Dapatkan kredensial autentikasi

Platform terbuka AI Search memerlukan Kunci API untuk autentikasi. Untuk petunjuknya, lihat Dapatkan Kunci API.
Dapatkan titik akhir layanan

Anda dapat memanggil layanan melalui jaringan publik atau VPC. Untuk detailnya, lihat Dapatkan titik akhir layanan.

Buat tugas ekstraksi asinkron

Metode permintaan

POST

URL

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

host: Titik akhir untuk layanan API. Anda dapat mengakses layanan API melalui jaringan publik atau melalui VPC. Untuk informasi selengkapnya, lihat Dapatkan titik akhir.

Di Konsol AI Search Open Platform, pilih API Keys dari panel navigasi kiri. Anda kemudian dapat menemukan Public API Domain Name dan Private API Domain Name di bagian Access Domain Name di bagian atas halaman.

workspace_name: Nama ruang kerja. Contohnya, default.
service_id: ID layanan sistem bawaan. Contohnya, ops-image-analyze-vlm-001.

Parameter permintaan

Parameter header

Autenikasi kunci API

Parameter	Tipe	Wajib	Deskripsi	Contoh
Content-Type	String	Wajib	Menentukan tipe media dari badan permintaan. Harus berupa application/json.	application/json
Authorization	String	Wajib	Kunci API untuk autentikasi, diawali dengan Bearer .	Bearer OS-d1**2a

Parameter body

Parameter	Type	Wajib	Deskripsi	Contoh
service_id	String	Ya	ID layanan bawaan: ops-image-analyze-vlm-001 ops-image-analyze-ocr-001	ops-image-analyze-vlm-001
document.url	String	Tidak	URL file. Salah satu parameter ini atau `document.content` harus ditentukan. Mendukung protokol `http` dan `https`.	http://path/to/***.jpg
document.content	String	Tidak	Konten file yang dikodekan Base64. Salah satu parameter ini atau `document.url` harus ditentukan.	"aGVsbG8gd29ybGQ="
document.file_name	String	Tidak	Nama file. Jika parameter ini dihilangkan, nama akan diinferensi dari `document.url`. Wajib jika `document.url` juga dihilangkan.	test.jpg
document.file_type	String	Tidak	Tipe file (misalnya, `jpg`, `jpeg`, `png`, `bmp`, `tiff`). Jika parameter ini dihilangkan, tipe akan diinferensi dari ekstensi `document.file_name`. Wajib jika tipe tidak dapat diinferensi secara otomatis.	jpg

Parameter respons

Parameter	Tipe	Deskripsi	Nilai
result.task_id	String	ID tugas analisis gambar asinkron.	6177bf71-f87f-4d86-ab0c-e2b64dfe****

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 respons

Respons normal

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

Contoh respons error

Jika permintaan akses gagal, respons berisi code dan message yang menjelaskan kesalahan tersebut.

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

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: Titik akhir layanan API. Anda dapat memanggil layanan API melalui jaringan publik atau melalui VPC. Untuk detailnya, lihat Dapatkan titik akhir layanan.
workspace_name: Nama ruang kerja. Contohnya, default.
service_id: ID layanan bawaan. Contohnya, ops-image-analyze-vlm-001.
task_id: ID tugas yang dikembalikan dalam respons saat Anda membuat tugas analisis gambar. Contohnya, cd4e26f0-23ff-449c-83dc-20cc8ff1****.

Parameter permintaan

Parameter header

Autenikasi kunci API

Parameter	Tipe	Wajib	Deskripsi	Contoh
Content-Type	string	Ya	Tipe permintaan. Harus berupa `application/json`.	application/json
Authorization	string	Ya	Kunci API untuk autentikasi, diawali dengan `Bearer` .	Bearer OS-d1**2a

Parameter respons

Parameter	Tipe	Deskripsi	Contoh
request_id	String	Pengidentifikasi unik untuk panggilan API.	3C09570D-12DB-46B4-BF0F-A100D79B****
latency	Float/Int	Latensi permintaan, dalam milidetik.	3.0
result.task_id	String	ID tugas asinkron. Parameter ini tidak dikembalikan untuk panggilan sinkron.	a7e4c0f6-874c-47e3-b05b-02278a96e****
result.status	String	Status tugas. Nilai yang mungkin: `PENDING`: Tugas sedang tertunda. `SUCCESS`: Tugas berhasil. `FAILED`: Tugas gagal.	SUCCESS
result.data	Object	Hasil analisis gambar.	{"content":"The image shows XXXX", "content_type":"plain"}
result.data.content	String	Konten gambar yang diekstraksi.	"XXX"
result.data.content_type	String	Tipe konten output. Nilainya selalu `plain`.	plain
usage.token_count	int	Jumlah token untuk output. Parameter ini berlaku untuk layanan `ops-image-analyze-vlm-001`.	1234
usage.pv_count	int	Jumlah pemanggilan, tetap bernilai 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 respons

Respons sukses

{
      "request_id":"3C09570D-12DB-46B4-BF0F-A100D79B****",
      "latency":3.0,
      "http_code":200,
      "result":{
           "status":"SUCCESS",
           "data":{
                "content":"The image shows a WMF blender surrounded by fruits and vegetables. Next to it is a glass of red juice with a straw. On the table are lemon slices, strawberries, and kiwifruit. A cut pineapple and an orange sit in one corner. Chopped carrots are in the blender, ready for juicing. The scene looks healthy and appetizing.",
                "content_type":"plain"
            },
            "task_id":"d9781786-20b8-4fb4-bbb5-38f82e69****"
       },
            "usage":{
                "token_count":95
            }
}

Contoh respons error

Saat permintaan akses gagal, respons mencakup code dan message yang menjelaskan kesalahan tersebut.

{
  "request_id":"153FC253-468D-4C46-873E-2AEB918C****",
  "latency":2.0,
  "code":"BadRequest.TaskNotExist",
  "http_code":404,
  "message":"task[d9781786-20b8-4fb4-bbb5-38f82e690b****] does not exist"
}

Membuat tugas ekstraksi sinkron

Metode permintaan

POST

URL

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

Parameter

host: Titik akhir layanan API. Anda dapat memanggil layanan API melalui jaringan publik atau melalui VPC. Untuk informasi selengkapnya, lihat Dapatkan titik akhir layanan.
workspace_name: Nama ruang kerja Anda. Contohnya, default.
service_id: ID layanan bawaan. Contohnya, ops-image-analyze-vlm-001.

Parameter

Parameter header

Autenikasi kunci API

Parameter	Tipe	Wajib	Deskripsi	Nilai contoh
Content-Type	String	Ya	Tipe media permintaan.	application/json
Authorization	String	Ya	Kunci API	Bearer OS-d1**2a

Parameter body

Parameter	Tipe	Wajib	Deskripsi	Contoh
service_id	String	Ya	ID layanan bawaan. Nilai yang valid: ops-image-analyze-vlm-001 ops-image-analyze-ocr-001	ops-image-analyze-vlm-001
document.url	String	Tidak	URL file. Mendukung HTTP dan HTTPS. Anda harus menentukan salah satu dari `document.url` atau `document.content`.	http://path/to/***.jpg
document.content	String	Tidak	Konten file yang dikodekan Base64. Anda harus menentukan salah satu dari `document.url` atau `document.content`.	"aGVsbG8gd29ybGQ="
document.file_name	String	Tidak	Nama file. Jika parameter ini dikosongkan, nama akan diinferensi dari `document.url`. Jika `document.url` juga dikosongkan, Anda harus menentukan parameter ini.	test.jpg
document.file_type	String	Tidak	Tipe file. Jika parameter ini dikosongkan, tipe akan diinferensi dari ekstensi nama file. Jika tipe tidak dapat diinferensi, Anda harus secara eksplisit menentukan tipe file. Contoh: `jpg`, `jpeg`, `png`, `bmp`, dan `tiff`.	jpg

Parameter respons

Parameter	Tipe	Deskripsi	Nilai contoh
result.status	String	Status tugas. Nilai yang mungkin: PENDING: Tugas sedang berlangsung. SUCCESS: Tugas berhasil. FAIL: Tugas gagal.	SUCCESS
result.error	String	Pesan kesalahan ketika `result.status` bernilai `FAIL`. Bidang ini kosong jika tidak.	Failed to decrypt the document.
result.data	Object	Hasil analisis gambar.	{"content":"The image shows XXXX", "content_type":"plain"}
result.data.content	String	Konten yang diekstraksi dari gambar.	"XXX"
result.data.content_type	String	Tipe konten output. Nilainya selalu `plain`.	plain
request_id	String	Pengidentifikasi unik untuk panggilan API.	B4AB89C8-B135-xxxx-A6F8-2BAB801A2CE4
latency	number	Latensi permintaan, dalam ms.	10
usage	Object	Penggunaan untuk panggilan API ini.	"usage": { "token_count": 1234 }
usage.token_count	integer	Jumlah token output. Ini berlaku untuk layanan `ops-image-analyze-vlm-001`.	1234
usage.pv_count	integer	Jumlah pemanggilan. Nilainya tetap 1. Ini berlaku untuk layanan `ops-image-analyze-ocr-001`.	1

cURL

Bagian ini menyediakan contoh panggilan API dan glosarium istilah teknis terkait.Contoh panggilan API
Contoh berikut menunjukkan cara melakukan panggilan sinkron ke Titik akhir API analisis gambar.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\"
      }
}"</your>Terminologi
Tabel berikut mencantumkan istilah teknis yang digunakan dalam panggilan API ini, format standarnya, dan konvensi terkait.


Kata kunci
Bentuk standar
Jenis
Catatan




API key
API key
Standar Industri
Istilah standar industri. Gunakan huruf kecil dalam teks naratif.


China (Hangzhou)
China (Hangzhou)
Wilayah Alibaba Cloud
Nama wilayah resmi. Identifier hangzhou dalam URL digunakan untuk keperluan sistem.


Open Search
Open Search
Produk Alibaba Cloud
Nama produk resmi. Identifier opensearch dalam URL digunakan untuk keperluan sistem.


workspace
workspace
Standar Industri
Konsep umum sumber daya cloud. Gunakan huruf kecil.


image analysis
image analysis
Standar Industri
Deskripsi fungsional. Identifier image-analyze dalam URL digunakan untuk keperluan sistem.


sync / async
sync / async
Standar Industri
Istilah standar untuk operasi sinkron dan asinkron.


document
document
Bidang JSON
Nama bidang JSON standar. Gunakan huruf kecil.


url
url
Bidang JSON
Nama bidang JSON standar. Gunakan huruf kecil.


file_type
file_type
Bidang JSON
Nama bidang JSON standar. Gunakan huruf kecil.


Elemen UI
Contoh pemanggilan API ini tidak merujuk pada elemen antarmuka pengguna (UI) mana pun.<p>Bagian ini menyediakan contoh panggilan API dan glosarium istilah teknis terkait.</p>
<h4>Contoh panggilan API</h4>
<p>Contoh berikut menunjukkan cara melakukan panggilan sinkron ke titik akhir API analisis gambar.</p>
<code code-type="xCode" data-tag="codeblock" id="65feb96cd5n4s" outputclass="language-shell">curl -X POST \
-H"Content-Type: application/json" \
-H "Authorization: Bearer <your>" \
 "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\"
      }
}"</your>

Contoh respons

Respons sukses

{
    "request_id":"BB5CD4C3-C8B6-40E7-A037-4ADAE88A****", 
    "latency":12525.0,
    "http_code":200,
    "result":{
        "status":"SUCCESS",
        "data":{
              "content":"The image shows a WMF blender surrounded by fruit and vegetables. Next to the blender is a cup of red juice with a straw in it. Scattered on the table are a few lemon slices, several strawberries, and some kiwifruit. In one corner of the table, there is a cut pineapple and an orange. Additionally, chopped carrots are in the blender, ready to be juiced. Everything looks healthy and delicious.",
              "content_type":"plain"
        }
      },
      "usage":{
          "token_count":95
      }
}

Respons error

Permintaan akses yang gagal mengembalikan code dan message yang menjelaskan kesalahan tersebut.

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

Kode status

Kode status HTTP	Kode error	Deskripsi
200	-	Permintaan yang berhasil tidak menjamin keberhasilan tugas; periksa status tugas di `result.status`.
404	BadRequest.TaskNotExist	Tugas tidak ada.
400	InvalidParameter	Permintaan tidak valid.
500	InternalServerError	Terjadi kesalahan internal.

Untuk informasi selengkapnya tentang kode status, lihat kode status.