Referensi API HTTP kosa kata kustom - Alibaba Cloud Model Studio

Panduan pengguna: Tingkatkan akurasi pengenalan.

Kosa kata kustom hanya didukung di ruang kerja primary. Sub-ruang kerja tidak mendukung fitur ini.

Endpoint

Singapura
China (Beijing)

POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/audio/asr/customizationGanti {WorkspaceId} dengan Workspace ID Anda yang sebenarnya.

Alibaba Cloud Model Studio telah merilis domain khusus ruang kerja untuk wilayah China (Beijing) dan Singapura. Domain khusus baru ini memberikan performa unggul dan stabilitas lebih tinggi untuk permintaan inferensi. Kami merekomendasikan migrasi ke domain baru berikut:

China (Beijing): dari dashscope.aliyuncs.com ke {WorkspaceId}.cn-beijing.maas.aliyuncs.com
Singapura: dari dashscope-intl.aliyuncs.com ke {WorkspaceId}.ap-southeast-1.maas.aliyuncs.com

Ganti {WorkspaceId} dengan Workspace ID Anda yang sebenarnya. Domain lama tetap berfungsi sepenuhnya.

Header permintaan

Parameter	Tipe	Wajib	Deskripsi
Authorization	string	Ya	Token Bearer. Gunakan format `Bearer <api_key>`, dengan `<api_key>` sebagai Kunci API Anda.
Content-Type	string	Ya	Jenis media badan permintaan. Atur ke `application/json`.

Buat kosa kata

Badan permintaan

modelstring(Wajib)Model kosa kata kustom. Atur ke speech-biasing.inputobject(Wajib)Parameter input.

Properti

action string(Wajib)Jenis operasi. Atur ke create_vocabulary.target_model string(Wajib)Model pengenalan ucapan yang menggunakan kosa kata ini. Nilai ini harus sesuai dengan model yang Anda tentukan saat memanggil API pengenalan ucapan.prefix string(Wajib)Awalan kustom untuk kosa kata. Hanya huruf kecil dan angka yang diperbolehkan, dengan panjang maksimum 10 karakter.vocabulary array[object](Wajib)Array entri kosa kata.

Properti

text string(Wajib)Teks entri kosa kata.Bahasa teks harus didukung oleh model yang dipilih. Bahasa yang didukung bervariasi tergantung model.Gunakan kata-kata aktual, bukan kombinasi karakter sembarang, untuk meningkatkan akurasi pengenalan.Panjang maksimum: 15 karakter untuk teks yang mencakup karakter non-ASCII, atau 7 kata yang dipisahkan spasi untuk teks ASCII saja.weight integer(Wajib)Bobot entri kosa kata. Nilai yang direkomendasikan: 4.Nilai valid: 1 hingga 5.Jika akurasi pengenalan tidak meningkat, naikkan bobotnya. Bobot yang terlalu tinggi dapat mengurangi akurasi pengenalan kata lain.lang string(Opsional)Kode bahasa audio yang akan dikenali. Jika ditentukan, sistem akan meningkatkan pengenalan entri kosa kata dalam bahasa tersebut. Jika Anda tidak dapat menentukan bahasa sebelumnya, biarkan parameter ini kosong. Model akan mendeteksi bahasa secara otomatis.Nilai valid (bervariasi tergantung model):

Paraformer:
- zh: Chinese
- en: English
- ja: Japanese
- yue: Cantonese
- ko: Korean
- de: German
- fr: French
- ru: Russian
Fun-ASR:
- zh: Chinese
- en: English
- ja: Japanese

URL berikut berlaku untuk wilayah Singapura. Ganti WorkspaceId dengan Workspace ID Anda yang sebenarnya. URL bervariasi tergantung wilayah.Kunci API untuk wilayah Singapura dan Beijing berbeda. Untuk informasi selengkapnya, lihat Dapatkan Kunci API.

curl -X POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/audio/asr/customization \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
    "model": "speech-biasing",
    "input": {
        "action": "create_vocabulary",
        "target_model": "fun-asr",
        "prefix": "testpfx",
        "vocabulary": [
          {"text": "Seediq Bale", "weight": 4}
        ]
    }
}'

Isi respons

request_idstringIdentifikasi unik permintaan ini.outputobjectData respons.

Properti

vocabulary_idstringID kosa kata yang dibuat.

usageobjectInformasi penggunaan permintaan ini.

Properti

count integerJumlah kosa kata yang dibuat. Selalu bernilai 1.

{
    "output": {
        "vocabulary_id": "vocab-testpfx-5112c3de3705486baxxxxxxx"
    },
    "usage": {
        "count": 1
    },
    "request_id": "aee47022-2352-40fe-acfa-xxxx"
}

Daftar kosa kata

Isi permintaan

modelstring(Wajib)Model kosa kata kustom. Atur ke speech-biasing.inputobject(Wajib)Parameter input.

Properti

action string(Wajib)Jenis operasi. Atur ke list_vocabulary.prefix string(Opsional)Awalan kustom kosa kata. Jika ditentukan, hanya kosa kata dengan awalan ini yang dikembalikan.page_index integerNomor halaman, dimulai dari 0.Nilai default: 0.page_size integerJumlah entri per halaman.Nilai default: 10.

curl -X POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/audio/asr/customization \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
    "model": "speech-biasing",
    "input": {
        "action": "list_vocabulary",
        "prefix": "testpfx",
        "page_index": 0,
        "page_size": 10
    }
}'

Isi respons

request_idstringIdentifikasi unik permintaan ini.outputobjectData respons.

Properti

vocabulary_listarray[object]Kosakata yang di-query.

Properti

vocabulary_idstringID kosa kata.gmt_createstringWaktu pembuatan.gmt_modifiedstringWaktu modifikasi terakhir.statusstringStatus:

OK: Siap.
UNDEPLOYED: Tidak tersedia.

usageobjectInformasi penggunaan permintaan ini.

Properti

count integerSelalu bernilai 1.

{
    "output": {
        "vocabulary_list": [
            {
                "gmt_create": "2026-03-02 18:07:38",
                "gmt_modified": "2026-03-02 18:07:38",
                "status": "OK",
                "vocabulary_id": "vocab-ciotest-8e74bef2accf4xxxxxxxx"
            },
            {
                "gmt_create": "2026-02-27 19:04:48",
                "gmt_modified": "2026-02-28 13:40:40",
                "status": "OK",
                "vocabulary_id": "vocab-sifasr-f483ad46e1844fxxxxxxxx"
            }
        ]
    },
    "usage": {
        "count": 1
    },
    "request_id": "81d51a05-8cdd-45c0-973f-xxxxxxxx"
}

Ambil kosa kata

Isi permintaan

modelstring(Wajib)Model kosa kata kustom. Atur ke speech-biasing.inputobject(Wajib)Parameter input.

Properti

action string(Wajib)Jenis operasi. Atur ke query_vocabulary.vocabulary_id string(Wajib)ID kosa kata yang akan diambil.

curl -X POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/audio/asr/customization \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
    "model": "speech-biasing",
    "input": {
        "action": "query_vocabulary",
        "vocabulary_id": "vocab-testpfx-xxxx"
    }
}'

Isi respons

request_idstringIdentifikasi unik permintaan ini.outputobjectData respons.

Properti

gmt_createstringWaktu pembuatan.gmt_modifiedstringWaktu modifikasi terakhir.statusstringStatus:

OK: Siap.
UNDEPLOYED: Tidak tersedia.

target_model stringModel pengenalan ucapan yang menggunakan kosa kata ini. Nilai ini harus sesuai dengan model yang Anda tentukan saat memanggil API pengenalan ucapan.vocabularyarray[object]Kosakata yang dicari.

Properti

text stringTeks entri kosa kata.weight integerBobot entri kosa kata.lang stringBahasa audio yang akan dikenali.

usageobjectInformasi penggunaan permintaan ini.

Properti

count integerSelalu bernilai 1.

{
  "output": {
    "gmt_create": "2025-12-19 11:47:11",
    "gmt_modified": "2025-12-19 11:47:11",
    "status": "OK",
    "target_model": "fun-asr",
    "vocabulary": [
      {
        "lang": "en",
        "text": "Seediq Bale",
        "weight": 4
      }
    ]
  },
  "usage": {
    "count": 1
  },
  "request_id": "3d461d3f-b2c4-4de5-xxxx"
}

Perbarui kosa kata

Isi permintaan

modelstring(Wajib)Model kosa kata kustom. Atur ke speech-biasing.inputobject(Wajib)Parameter input.

Properti

action string(Wajib)Jenis operasi. Atur ke update_vocabulary.vocabulary_id string(Wajib)ID kosa kata yang akan diperbarui.vocabulary array[object](Wajib)Kosa kata baru. Ini sepenuhnya menggantikan entri yang ada.

Properti

Paraformer:
- zh: Chinese
- en: English
- ja: Japanese
- yue: Cantonese
- ko: Korean
- de: German
- fr: French
- ru: Russian
Fun-ASR:
- zh: Chinese
- en: English
- ja: Japanese

curl -X POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/audio/asr/customization \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
    "model": "speech-biasing",
    "input": {
        "action": "update_vocabulary",
        "vocabulary_id": "vocab-testpfx-xxx",
        "vocabulary": [
          {"text": "Seediq Bale", "weight": 4, "lang": "en"}
        ]
    }
}'

Badan respons

request_idstringIdentifikasi unik permintaan ini.outputobjectData respons. Selalu kosong.usageobjectInformasi penggunaan permintaan ini.

Properti

count integerJumlah kosa kata yang diperbarui. Selalu bernilai 1.

{
  "output": {},
  "usage": {
    "count": 1
  },
  "request_id": "aee47022-2352-40fe-acfa-xxxx"
}

Hapus kosa kata

Badan permintaan

modelstring(Wajib)Model kosa kata kustom. Atur ke speech-biasing.inputobject(Wajib)Parameter input.

Properti

action string(Wajib)Jenis operasi. Atur ke delete_vocabulary.vocabulary_id string(Wajib)ID kosa kata yang akan dihapus.

curl -X POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/audio/asr/customization \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
    "model": "speech-biasing",
    "input": {
        "action": "delete_vocabulary",
        "vocabulary_id": "vocab-testpfx-xxx"
    }
}'

Isi respons

request_idstringIdentifikasi unik permintaan ini.outputobjectData respons. Selalu kosong.usageobjectInformasi penggunaan permintaan ini.

Properti

count integerJumlah kosa kata yang dihapus. Selalu bernilai 1.

{
  "output": {},
  "usage": {
    "count": 1
  },
  "request_id": "aee47022-2352-40fe-acfa-xxxx"
}

​Endpoint

​Header permintaan

​Buat kosa kata

Badan permintaan

Isi respons

​Daftar kosa kata

Isi permintaan

Isi respons

​Ambil kosa kata

Isi permintaan

Isi respons

​Perbarui kosa kata

Isi permintaan

Badan respons

​Hapus kosa kata

Badan permintaan

Isi respons

Endpoint

Header permintaan

Buat kosa kata

Daftar kosa kata

Ambil kosa kata

Perbarui kosa kata

Hapus kosa kata