Referensi API DescribeKeywordLib untuk Pustaka Teks Kustom - Content Moderation

Topik ini menjelaskan operasi API dan parameter yang digunakan untuk mengambil daftar pustaka teks kustom Anda. Anda dapat menggunakan operasi API ini untuk mengelola pustaka teks guna deteksi spam teks. Informasi yang diperoleh melalui panggilan API ini konsisten dengan pustaka teks kustom yang ditampilkan di Konsol AI Guardrails.

Catatan penggunaan

Operasi API: DescribeKeywordLib

Anda dapat memanggil operasi API ini untuk mengambil daftar pustaka teks kustom. Untuk informasi tentang cara menyusun permintaan HTTP, lihat Struktur permintaan. Anda juga dapat menggunakan permintaan HTTP yang telah dibuat sebelumnya. Untuk informasi selengkapnya, lihat Ikhtisar SDK.

Penagihan: Operasi API ini gratis.

Batas QPS

Anda dapat memanggil operasi ini hingga 10 kali per detik per akun. Jika jumlah panggilan per detik melebihi batas, pembatasan kecepatan akan dipicu sehingga berpotensi mengganggu bisnis Anda. Kami menyarankan agar Anda memperhatikan batas ini saat memanggil operasi tersebut.

Parameter permintaan

Untuk informasi tentang parameter permintaan umum yang harus disertakan dalam permintaan, lihat Parameter umum.

Badan permintaan berupa struct. Tabel berikut menjelaskan strukturnya.

Name	Type	Required	Example	Description
ServiceModule	String	Yes	open_api	Modul fitur pustaka teks. Tetapkan nilainya ke open_api. Hal ini menunjukkan bahwa pustaka tersebut digunakan untuk API AI Guardrails.

Data yang dikembalikan

Untuk informasi tentang hasil yang dikembalikan, lihat Parameter respons.

Bidang KeywordLibList dalam badan respons berupa array JSON. Setiap elemen berisi bidang-bidang berikut:

Name	Type	Example	Description
Id	Integer	2147	ID pustaka teks.
ModifiedTime	String	2018-09-04 14:17:56 +0800	Waktu terakhir pustaka teks dimodifikasi.
Name	String	test1sdkdk	Nama pustaka teks.
Code	String	710001	Kode pustaka teks. Catatan Di Konsol AI Guardrails, kode pustaka teks ditampilkan pada halaman Machine Review > Threat Detection Library. Dalam operasi API, pustaka teks diidentifikasi berdasarkan ID-nya.
Count	String	3	Jumlah entri teks dalam pustaka teks.
Category	String	BLACK	Jenis pustaka teks. Nilai yang valid: BLACK: Jika ditemukan kecocokan dalam pustaka ini, teks yang terdeteksi dianggap sebagai spam. Hapus atau batasi teks tersebut. WHITE: Jika ditemukan kecocokan dalam pustaka ini, teks yang terdeteksi dianggap normal. Teks tersebut dapat langsung dilewatkan. REVIEW: Jika ditemukan kecocokan dalam pustaka ini, teks yang terdeteksi memerlukan tinjauan manual.
Source	String	MANUAL	Sumber pustaka teks kustom. Nilai yang valid: MANUAL: Pustaka teks yang dibuat secara manual. FEEDBACK: Pustaka teks yang dibuat secara otomatis oleh AI Guardrails.
BizTypes	StringArray	["bizTypeA","bizTypeB"]	Skenario bisnis. Untuk informasi selengkapnya, lihat Buat skenario bisnis.
ResourceType	String	TEXT	Jenis pustaka teks. Nilai yang valid: TEXT: Pustaka teks IMAGE: Pustaka gambar VOICE: Pustaka voice
LibType	String	textKeyword	Jenis pustaka teks dalam setiap skenario. Nilai yang valid: Skenario deteksi spam teks textKeyword: Pustaka kata kunci similarText: Pustaka teks serupa Skenario iklan gambar textKeyword: Pustaka kata kunci gambar Skenario deteksi spam voice voiceText: Pustaka kata kunci voice
MatchMode	String	fuzzy	Mode kecocokan untuk teks yang akan dideteksi. Nilai yang valid: fuzzy: Kecocokan fuzzy precise: Kecocokan eksak
Enable	Boolean	true	Status pustaka teks. true: Diaktifkan false: Dinonaktifkan. Catatan Untuk mengaktifkan kembali pustaka teks yang dinonaktifkan, Anda dapat memanggil operasi pembuatan pustaka teks untuk mengubah status pustaka teks tersebut. Untuk informasi selengkapnya, lihat Modifikasi pustaka teks.

Contoh

Contoh permintaan

http(s)://green.cn-shanghai.aliyuncs.com/?
Action=DescribeKeywordLib&ServiceModule=open_api
&<Common request parameters>

Contoh respons

{
  "requestId": "795D8871-4889-4C0F-A8B1-C7D2B990FF61",
  "data": {
    "TotalCount": 11,
    "KeywordLibList": [
      {
        "Name": "test1sdkdk",
        "Source": "MANUAL",
        "BizTypes": [],
        "Category": "BLACK",
        "ServiceModule": "open_api",
        "Count": 3,
        "ResourceType": "TEXT",
        "Id": 2147,
        "ModifiedTime": "2018-09-04 14:17:56 +0800",
        "Code": "710001",
        "LibType": "textKeyword",
        "MatchMode":"fuzzy",
        "Enable":"true"
      },
      {
        "Name": "Test001",
        "Source": "MANUAL",
        "BizTypes": [],
        "Category": "BLACK",
        "ServiceModule": "open_api",
        "Count": 3,
        "ResourceType": "VOICE",
        "Id": 2693,
        "ModifiedTime": "2018-09-03 17:11:04 +0800",
        "Code": "932001",
        "LibType": "voiceText",
        "MatchMode":"fuzzy",
        "Enable":"true"
      }
    ]
  },
  "code": 200,
  "success": true
}