Mengirimkan tugas pengenalan karakter optik (OCR) asinkron dan menanyakan hasil OCR asinkron. Operasi ini digunakan untuk mendeteksi dan mendapatkan teks dalam gambar.
Deskripsi operasi asinkron
Operasi: /green/image/asyncscan
Anda dapat memanggil operasi ini untuk mengirimkan tugas moderasi gambar asinkron. Untuk informasi lebih lanjut tentang cara membuat permintaan HTTP, lihat Struktur Permintaan. Anda juga bisa memilih permintaan HTTP yang sudah ada. Untuk informasi lebih lanjut, lihat Ikhtisar SDK.
Billing method:
Anda akan dikenakan biaya untuk memanggil operasi ini. Untuk informasi lebih lanjut tentang metode penagihan, lihat
Response timeout:
Waktu respon maksimum yang diizinkan untuk permintaan moderasi sinkron adalah 6 detik. Jika moderasi tidak selesai dalam 6 detik, kesalahan timeout akan dikembalikan. Jika Anda tidak memerlukan hasil moderasi secara real-time, Anda dapat mengirimkan permintaan moderasi asinkron. Dalam banyak kasus, kami merekomendasikan Anda mengirimkan permintaan moderasi sinkron karena operasi moderasi sinkron lebih mudah dipanggil. Kami merekomendasikan Anda menyetel periode timeout menjadi 6 detik untuk memanggil operasi moderasi sinkron.
Returned results:
Jika Anda mengirimkan permintaan moderasi asinkron, hasil moderasi tidak akan dikembalikan secara real-time. Untuk mendapatkan hasil moderasi, Anda dapat memantau hasil moderasi secara berkala atau mengaktifkan notifikasi callback. Hasil moderasi disimpan hingga 1 jam.
Aktifkan notifikasi callback untuk mendapatkan hasil moderasi: Saat Anda mengirimkan tugas moderasi asinkron, Anda dapat menentukan URL callback untuk menerima hasil moderasi dalam parameter callback dari permintaan moderasi. Untuk informasi lebih lanjut tentang parameter callback, lihat Parameter Permintaan.
Pantau hasil moderasi pada interval reguler: Anda tidak perlu menyetel parameter callback saat mengirimkan tugas moderasi asinkron. Setelah Anda mengirimkan tugas, Anda dapat memanggil operasi /green/video/results untuk menanyakan hasil moderasi. Untuk informasi lebih lanjut tentang operasi, lihat Deskripsi Operasi /green/image/results.
Limits on images:
URL gambar harus berupa URL HTTP atau HTTPS.
Gambar harus dalam format PNG, JPG, JPEG, BMP, GIF, atau WEBP.
Ukuran gambar tidak boleh lebih dari 20 MB. Batas ukuran gambar berlaku untuk operasi moderasi sinkron maupun asinkron.
Durasi untuk mengunduh gambar dibatasi hingga 3 detik. Jika gambar gagal diunduh dalam 3 detik, kesalahan timeout akan dikembalikan.
Kami merekomendasikan Anda mengirimkan gambar setidaknya 256 × 256 piksel untuk memastikan efek moderasi.
Waktu respon operasi untuk memoderasi gambar bervariasi berdasarkan durasi untuk mengunduh gambar tersebut. Pastikan Anda menggunakan layanan penyimpanan yang stabil dan andal untuk menyimpan gambar yang akan dimoderasi. Kami merekomendasikan Anda menggunakan Object Storage Service (OSS) atau Content Delivery Network (CDN).
Batas QPS
Anda dapat memanggil operasi ini hingga 10 kali per detik per akun. Jika jumlah panggilan per detik melebihi batas, throttling akan dipicu. Akibatnya, bisnis Anda mungkin terpengaruh. Kami merekomendasikan Anda memperhatikan batas ini saat memanggil operasi ini.
Parameter Permintaan
Parameter | Tipe | Wajib | Contoh | Deskripsi |
bizType | String | Tidak | default | Skenario bisnis. Anda dapat membuat skenario bisnis di Content Moderation console. Untuk informasi lebih lanjut, lihat Sesuaikan kebijakan untuk moderasi bantuan mesin. |
scenes | StringArray | Ya | ["ocr"] | Skenario moderasi. Tetapkan nilai menjadi ocr. |
callback | String | Tidak | http://www.aliyundoc.com/xx.json | URL callback untuk memberi tahu Anda tentang hasil moderasi asinkron. URL HTTP dan HTTPS didukung. Jika Anda tidak menyetel parameter ini, Anda harus memantau hasil moderasi secara berkala. Jika Anda menyetel parameter callback dalam permintaan moderasi, pastikan URL HTTP atau HTTPS yang ditentukan memenuhi persyaratan berikut: mendukung metode POST, menggunakan UTF-8 untuk mengkodekan data yang ditransmisikan, dan mendukung parameter checksum dan content. Untuk mengirimkan hasil moderasi ke URL callback yang ditentukan, Content Moderation mengembalikan parameter checksum dan content dalam notifikasi callback berdasarkan aturan dan format berikut:
Catatan Jika server Anda berhasil menerima notifikasi callback, server mengirimkan kode status HTTP 200 ke Content Moderation. Jika server Anda gagal menerima notifikasi callback, server mengirimkan kode status HTTP lain ke Content Moderation. Jika server Anda gagal menerima notifikasi callback, Content Moderation terus mendorong notifikasi callback hingga server Anda menerimanya. Content Moderation dapat mendorong notifikasi callback hingga 16 kali. Setelah 16 kali, Content Moderation berhenti mendorong notifikasi callback. Dalam hal ini, kami merekomendasikan Anda memeriksa status URL callback. |
seed | String | Tidak | aabbcc123 | String acak yang digunakan untuk menghasilkan tanda tangan untuk permintaan notifikasi callback. String ini dapat memiliki panjang hingga 64 karakter dan dapat berisi huruf, digit, dan garis bawah (_). Anda dapat menyesuaikan string ini. Ini digunakan untuk memverifikasi permintaan notifikasi callback saat Content Moderation mendorong notifikasi callback ke server Anda. Catatan Parameter ini diperlukan jika Anda menyetel parameter callback. |
cryptType | String | Tidak | SHA256 | Algoritma enkripsi yang digunakan untuk mengenkripsi konten notifikasi callback saat Anda mengaktifkan notifikasi callback. Content Moderation mengenkripsi string yang dikembalikan menggunakan algoritma enkripsi yang Anda tentukan dan mengirimkan string terenkripsi ke URL callback. String yang dikembalikan dalam format UID + Seed + Content. Nilai valid:
|
tasks | JSONArray | Ya | Daftar objek yang ingin Anda moderasi. Array JSON dapat berisi satu atau lebih elemen. Setiap elemen adalah struktur. Array JSON dapat berisi hingga 100 elemen. Dengan kata lain, Anda dapat mengirimkan hingga 100 objek moderasi sekaligus. Untuk mengirimkan 100 objek moderasi sekaligus, Anda harus menaikkan batas konkurensi terkait menjadi angka lebih dari 100. Untuk informasi lebih lanjut tentang struktur setiap elemen, lihat task. |
Tabel 1. task
Parameter | Tipe | Wajib | Contoh | Deskripsi |
dataId | String | Tidak | test_data_xxxx | ID data. Pastikan setiap ID unik dalam permintaan. |
url | String | Ya | https://www.aliyundoc.com/test_image_xxxx.png | URL HTTP atau HTTPS yang dapat diakses melalui Internet. URL memiliki panjang hingga 2.048 karakter. |
interval | Integer | Tidak | 2 | Interval antara dua frame yang diambil berturut-turut. Parameter ini khusus untuk moderasi GIF atau gambar panjang.
Secara default, hanya frame pertama dari gambar GIF atau gambar panjang yang dimoderasi. Anda dapat menggunakan parameter interval untuk menentukan interval antara dua frame yang sistem tangkap berturut-turut. Ini membantu mengurangi biaya moderasi. Catatan Parameter interval dan maxFrames harus digunakan bersamaan. Sebagai contoh, parameter interval diatur ke 2, dan parameter maxFrames diatur ke 100 untuk memoderasi gambar GIF atau gambar panjang. Dalam contoh ini, satu dari setiap dua frame dimoderasi, dan maksimum 100 frame dimoderasi. Biaya dihitung berdasarkan jumlah frame yang sebenarnya dimoderasi. |
maxFrames | Integer | Tidak | 100 | Jumlah maksimum frame yang akan ditangkap. Parameter ini khusus untuk moderasi GIF atau gambar panjang. Nilai default: 1. Jika nilai parameter interval dikalikan dengan nilai parameter |
Parameter Respons
Parameter | Tipe | Contoh | Deskripsi |
code | Integer | 200 | Kode status HTTP yang dikembalikan. Untuk informasi lebih lanjut, lihat Kode kesalahan umum. |
msg | String | OK | Pesan yang dikembalikan untuk permintaan. |
dataId | String | test_data_xxxx | ID objek moderasi. Catatan Jika Anda menyetel parameter dataId dalam permintaan moderasi, nilai parameter permintaan dataId akan dikembalikan di sini. |
taskId | String | aaa25f95-4892-4d6b-aca9-7939bc6e9baa-148619876**** | ID tugas moderasi. |
url | String | https://www.aliyundoc.com/test_image_xxxx.png | URL HTTP atau HTTPS yang dapat diakses melalui Internet. URL memiliki panjang hingga 2.048 karakter. |
extras | JSONObject | xxx | Jika Anda menyetel parameter extras dalam permintaan moderasi, nilai parameter permintaan extras akan dikembalikan di sini. Catatan Parameter ini mungkin berubah. Gunakan nilai terbaru dari parameter ini. |
Contoh
Permintaan Contoh
http(s)://[Endpoint]/green/image/asyncscan
&<Parameter permintaan umum>
{
"scenes": [
"ocr"
],
"tasks": [
{
"dataId": "test_data_xxxx",
"url": "https://www.aliyundoc.com/test_image_xxxx.png"
}
]
}Respons Sukses Contoh
{
"code": 200,
"msg": "OK",
"requestId": "92AD868A-F5D2-4AEA-96D4-E1273B8E074C",
"data": [
{
"code": 200,
"msg": "OK",
"dataId": "test_data_xxxx",
"taskId": "aaa25f95-4892-4d6b-aca9-7939bc6e9baa-148619876****",
"url": "https://www.aliyundoc.com/test_image_xxxx.png"
}
]
}Deskripsi operasi /green/image/results
Operasi: /green/image/results
Anda dapat memanggil operasi ini untuk menanyakan hasil OCR asinkron.Untuk informasi lebih lanjut tentang cara membuat permintaan HTTP, lihat Struktur Permintaan. Anda juga bisa memilih permintaan HTTP yang sudah ada. Untuk informasi lebih lanjut, lihat Ikhtisar SDK.
Billing method:
Operasi ini gratis.
Response timeout:
Kami merekomendasikan Anda menanyakan hasil moderasi setidaknya 30 detik setelah Anda mengirimkan permintaan moderasi asinkron. Content Moderation menyimpan hasil moderasi hingga 4 jam. Setelah 4 jam, hasil tersebut dihapus.
Batas QPS
Anda dapat memanggil operasi ini hingga 10 kali per detik per akun. Jika jumlah panggilan per detik melebihi batas, throttling akan dipicu. Akibatnya, bisnis Anda mungkin terpengaruh. Kami merekomendasikan Anda memperhatikan batas ini saat memanggil operasi ini.
Parameter Permintaan
Parameter | Tipe | Wajib | Contoh | Deskripsi |
body | JSONArray | Ya | ["aaa25f95-4892-4d6b-aca9-7939bc6e9baa-1486198766695"] | Daftar ID tugas moderasi asinkron yang ingin Anda tanyakan. Array dapat berisi hingga 100 elemen. Setelah Anda mengirimkan tugas moderasi, Anda dapat memperoleh ID tugas dari respons. |
Parameter Respons
Parameter | Tipe | Contoh | Deskripsi |
code | Integer | 200 | Kode status HTTP yang dikembalikan. Untuk informasi lebih lanjut, lihat Kode kesalahan umum. |
msg | String | OK | Pesan yang dikembalikan untuk permintaan. |
dataId | String | test_data_xxxx | ID objek moderasi. Catatan Jika Anda menyetel parameter dataId dalam permintaan moderasi, nilai parameter permintaan dataId akan dikembalikan di sini. |
taskId | String | aaa25f95-4892-4d6b-aca9-7939bc6e9baa-148619876**** | ID tugas moderasi. |
url | String | https://www.aliyundoc.com/test_image_xxxx.png | URL HTTP atau HTTPS yang dapat diakses melalui Internet. URL memiliki panjang hingga 2.048 karakter. |
results | Array | Hasil yang dikembalikan. Jika kode status HTTP 200 dikembalikan, array dalam hasil yang dikembalikan berisi satu atau lebih elemen. Setiap elemen adalah struktur. Untuk informasi lebih lanjut tentang struktur setiap elemen, lihat result. |
Tabel 2. result
Parameter | Tipe | Contoh | Deskripsi |
scene | String | ocr | Skenario moderasi. Tetapkan nilai menjadi ocr. |
label | String | ocr | Kategori hasil moderasi. Nilai valid:
|
suggestion | String | review | Rekomendasi operasi selanjutnya. Nilai valid:
|
rate | Float | 99.91 | Probabilitas bahwa gambar yang dimoderasi termasuk dalam kategori yang terdeteksi. Anda dapat mengabaikan parameter ini dalam skenario OCR. |
ocrLocations | Array | Informasi tentang entri teks tunggal dalam gambar statis yang dimoderasi, yang mencakup teks, ukuran area teks, dan lokasi teks. Untuk informasi lebih lanjut tentang struktur, lihat ocrLocation. | |
ocrData | Array | Topik ini menjelaskan cara memanggil operasi untuk mengirimkan tugas moderasi gambar asinkron. | Kombinasi semua teks dalam gambar statis yang dimoderasi. Secara umum, kombinasi teks disimpan sebagai elemen pertama dari array. |
frames | Array | xxx | Frame yang ditangkap dari gambar animasi yang dimoderasi dan teks yang terdeteksi di setiap frame. |
| Parameter | Tipe | Contoh | Deskripsi |
| text | String | hello | Entri teks tunggal yang terdeteksi dalam gambar yang dimoderasi. |
| x | Float | 41 | Jarak antara sudut kiri atas area teks dan sumbu-y, dengan sudut kiri atas gambar sebagai titik koordinat asal. Satuan: piksel. |
| y | Float | 84 | Jarak antara sudut kiri atas area teks dan sumbu-x, dengan sudut kiri atas gambar sebagai titik koordinat asal. Satuan: piksel. |
| w | Float | 83 | Lebar area teks. Satuan: piksel. |
| h | Float | 26 | Tinggi area teks. Satuan: piksel. |
Tabel 3. ocrDetailInfo
Tabel 4. wordsInfo
Contoh
Permintaan Contoh
http(s)://[Endpoint]green/image/results
&<Parameter permintaan umum>
[
"aaa25f95-4892-4d6b-aca9-7939bc6e9baa-148619876****"
]Contoh Respons Sukses
{
"code": 200,
"data": [
{
"code": 200,
"dataId": "test_data_xxxx",
"extras": {
},
"msg": "OK",
"results": [
{
"label": "ocr",
"ocrData": [
"Topik ini menjelaskan cara memanggil operasi untuk mengirimkan tugas moderasi gambar asinkron."
],
"ocrLocations": [
{
"h": 19,
"text": "Topik ini menjelaskan cara memanggil operasi untuk mengirimkan tugas moderasi gambar asinkron.",
"w": 362,
"x": 31,
"y": 11
}
],
"rate": 99.91,
"scene": "ocr",
"suggestion": "review"
}
],
"taskId": "aaa25f95-4892-4d6b-aca9-7939bc6e9baa-148619876****",
"url": "https://www.aliyundoc.com/test_image_xxxx.png"
}
],
"msg": "OK",
"requestId": "992C7849-AA45-4055-8F82-8D44D64C15E3"
}