Skip to main content
Hotword kustom

Referensi SDK Python hotwords kustom

Gunakan SDK Python untuk membuat, menampilkan daftar, mengkueri, memperbarui, dan menghapus kosakata kustom untuk pengenalan ucapan.

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 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.
Panduan pengguna: Tingkatkan akurasi pengenalan.
Kosakata kustom hanya didukung di ruang kerja primary. Sub-ruang kerja tidak mendukung fitur ini.

Endpoint

SDK terhubung ke endpoint China (Beijing) secara default. Untuk menggunakan wilayah lain, atur dashscope.base_http_api_url sebelum melakukan panggilan API apa pun.
  • Singapura
  • China (Beijing)
https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1Ganti {WorkspaceId} dengan Workspace ID Anda yang sebenarnya.
Untuk menggunakan wilayah Singapura, atur dashscope.base_http_api_url sebelum melakukan panggilan apa pun: 
import dashscope

# Atur ini di awal kode Anda
dashscope.base_http_api_url = 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1'
Catatan:
  • Kunci API berbeda antar wilayah. Gunakan Kunci API yang sesuai dengan wilayah Anda.
  • Pengaturan wilayah bersifat global dan memengaruhi semua panggilan API DashScope.

VocabularyService

Paket: dashscope.audio.asr.VocabularyService Deskripsi: Membuat, menampilkan daftar, mengkueri, memperbarui, dan menghapus kosakata kustom.

Konstruktor 

VocabularyService(api_key: str = None, workspace: str = None, model: str = None)
Jika api_key tidak diberikan, SDK akan menggunakan dashscope.api_key global.

create_vocabulary() - Buat kosakata kustom

Signature metode: 
def create_vocabulary(
    self,
    target_model: str,
    prefix: str,
    vocabulary: List[dict]) -> str
Parameter:

Parameter

Tipe

Wajib

Deskripsi

target_model

str

Ya

Model pengenalan ucapan yang menggunakan kosakata ini. Nilai ini harus sesuai dengan model yang Anda tentukan saat memanggil API pengenalan ucapan.

prefix

str

Ya

Awalan kustom untuk kosakata. Hanya huruf kecil dan angka yang diizinkan, dengan panjang maksimum 10 karakter.

vocabulary

List[dict]

Ya

Daftar hotword. Setiap entri adalah dict dengan bidang text, weight, dan lang.

Untuk informasi selengkapnya, lihat Struktur kamus hotword.

Nilai kembalian:

Jenis

Deskripsi

str

ID kosakata yang dibuat.

list_vocabularies() - Tampilkan daftar kosakata kustom

Memetakan ke API HTTP action: list_vocabulary (HTTP menggunakan bentuk tunggal, sedangkan nama metode Python list_vocabularies menggunakan bentuk jamak). Signature metode: 
def list_vocabularies(
    self,
    prefix: str = None,
    page_index: int = 0,
    page_size: int = 10) -> List[dict]
Parameter:

Parameter

Tipe

Wajib

Deskripsi

prefix

str

Tidak

Awalan kustom dari kosakata. Jika ditentukan, hanya kosakata dengan awalan ini yang dikembalikan.

page_index

int

Tidak

Nomor halaman, dimulai dari 0.

Nilai default: 0.

page_size

int

Tidak

Jumlah entri per halaman.

Nilai default: 10.

Nilai kembalian:

Tipe

Deskripsi

List[dict]

Daftar objek kosakata, masing-masing berisi vocabulary_id, gmt_create, gmt_modified, dan status.

Bidang yang dikembalikan oleh list_vocabularies():

Bidang

Tipe

Deskripsi

vocabulary_id

str

ID kosakata.

gmt_create

str

Waktu pembuatan.

gmt_modified

str

Waktu modifikasi terakhir.

status

str

Status:

  • OK: Siap.

  • UNDEPLOYED: Tidak tersedia.

query_vocabulary() - Kueri kosakata kustom

Signature metode: 
def query_vocabulary(
    self,
    vocabulary_id: str) -> dict
Parameter:

Parameter

Tipe

Wajib

Deskripsi

vocabulary_id

str

Ya

ID kosakata kustom yang akan dikueri.

Nilai kembalian:

Tipe

Deskripsi

dict

Objek kosakata yang berisi vocabulary, target_model, gmt_create, gmt_modified, dan status.

Bidang yang dikembalikan oleh query_vocabulary():

Bidang

Tipe

Deskripsi

vocabulary

List[dict]

Konten daftar hotword.

target_model

str

Model pengenalan ucapan yang menggunakan kosakata ini. Nilai ini harus sesuai dengan model yang Anda tentukan saat memanggil API pengenalan ucapan.

gmt_create

str

Waktu pembuatan.

gmt_modified

str

Waktu modifikasi terakhir.

status

str

Status:

  • OK: Siap.

  • UNDEPLOYED: Tidak tersedia.

update_vocabulary() - Perbarui kosakata kustom

Signature metode: 
def update_vocabulary(
    self,
    vocabulary_id: str,
    vocabulary: List[dict]) -> None
Parameter:

Parameter

Tipe

Wajib

Deskripsi

vocabulary_id

str

Ya

ID kosakata yang akan diperbarui.

vocabulary

List[dict]

Ya

Kosakata baru. Ini sepenuhnya menggantikan entri yang ada.

Nilai kembalian: None

delete_vocabulary() - Hapus kosakata kustom

Signature metode: 
def delete_vocabulary(
    self,
    vocabulary_id: str) -> None
Parameter:

Parameter

Tipe

Wajib

Deskripsi

vocabulary_id

str

Ya

ID kosakata yang akan dihapus.

Nilai kembalian: None

Struktur kamus hotword

Bidang dalam setiap dict kosakata:

Bidang

Type

Wajib

Deskripsi

text

str

Ya

Teks entri kosakata.

Bahasa teks harus didukung oleh model yang dipilih. Bahasa yang didukung bervariasi tergantung model.

Gunakan kata aktual, bukan kombinasi karakter arbitrer, 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

int

Ya

Bobot entri kosakata. Nilai yang direkomendasikan: 4.

Nilai valid: 1 hingga 5.

Jika akurasi pengenalan tidak membaik, tingkatkan bobotnya. Bobot yang terlalu tinggi dapat mengurangi akurasi pengenalan kata lain.

lang

str

Tidak

Kode bahasa audio yang akan dikenali. Saat diatur, sistem meningkatkan pengenalan entri kosakata dalam bahasa yang ditentukan. Jika Anda tidak dapat menentukan bahasa sebelumnya, biarkan parameter ini tidak diatur. 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

Kode contoh

Semua contoh membaca Kunci API dari variabel lingkungan.

Buat kosakata kustom 

import dashscope
from dashscope.audio.asr import *
import os

# Kunci API untuk wilayah Singapura dan Beijing berbeda. Dapatkan kunci API: https://www.alibabacloud.com/help/en/model-studio/get-api-key
# Jika tidak ada variabel lingkungan yang dikonfigurasi, ganti baris berikut dengan Kunci API Model Studio Anda: dashscope.api_key = "sk-xxx"
dashscope.api_key = os.environ.get('DASHSCOPE_API_KEY')

# Konfigurasi berikut untuk wilayah Singapura. Ganti "{WorkspaceId}" dengan workspace ID Anda yang sebenarnya. Konfigurasi bervariasi tergantung wilayah.
dashscope.base_http_api_url = 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1'

prefix = 'testpfx'
target_model = "fun-asr"

my_vocabulary = [
    {"text": "Seediq Bale", "weight": 4}
]

# Buat kosakata kustom
service = VocabularyService()
vocabulary_id = service.create_vocabulary(
    prefix=prefix,
    target_model=target_model,
    vocabulary=my_vocabulary)

print(f"Vocabulary ID: {vocabulary_id}")

Tampilkan daftar kosakata kustom 

import dashscope
from dashscope.audio.asr import *
import json
import os

# Kunci API untuk wilayah Singapura dan Beijing berbeda. Dapatkan kunci API: https://www.alibabacloud.com/help/en/model-studio/get-api-key
# Jika tidak ada variabel lingkungan yang dikonfigurasi, ganti baris berikut dengan Kunci API Model Studio Anda: dashscope.api_key = "sk-xxx"
dashscope.api_key = os.environ.get('DASHSCOPE_API_KEY')

# Konfigurasi berikut untuk wilayah Singapura. Ganti "{WorkspaceId}" dengan workspace ID Anda yang sebenarnya. Konfigurasi bervariasi tergantung wilayah.
dashscope.base_http_api_url = 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1'

service = VocabularyService()
vocabularies = service.list_vocabularies()
print(f"Vocabularies: {json.dumps(vocabularies)}")

Kueri kosakata kustom 

import dashscope
from dashscope.audio.asr import *
import json
import os

# Kunci API untuk wilayah Singapura dan Beijing berbeda. Dapatkan kunci API: https://www.alibabacloud.com/help/en/model-studio/get-api-key
# Jika tidak ada variabel lingkungan yang dikonfigurasi, ganti baris berikut dengan Kunci API Model Studio Anda: dashscope.api_key = "sk-xxx"
dashscope.api_key = os.environ.get('DASHSCOPE_API_KEY')

# Konfigurasi berikut untuk wilayah Singapura. Ganti "{WorkspaceId}" dengan workspace ID Anda yang sebenarnya. Konfigurasi bervariasi tergantung wilayah.
dashscope.base_http_api_url = 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1'

service = VocabularyService()
# Ganti dengan ID kosakata yang sebenarnya saat mengkueri
vocabulary = service.query_vocabulary("vocab-testpfx-xxx")
print(f"Vocabulary: {json.dumps(vocabulary, ensure_ascii=False)}")

Perbarui kosakata kustom 

import dashscope
from dashscope.audio.asr import *
import os

# Kunci API untuk wilayah Singapura dan Beijing berbeda. Dapatkan kunci API: https://www.alibabacloud.com/help/en/model-studio/get-api-key
# Jika tidak ada variabel lingkungan yang dikonfigurasi, ganti baris berikut dengan Kunci API Model Studio Anda: dashscope.api_key = "sk-xxx"
dashscope.api_key = os.environ.get('DASHSCOPE_API_KEY')

# Konfigurasi berikut untuk wilayah Singapura. Ganti "{WorkspaceId}" dengan workspace ID Anda yang sebenarnya. Konfigurasi bervariasi tergantung wilayah.
dashscope.base_http_api_url = 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1'

service = VocabularyService()
my_vocabulary = [
    {"text": "Seediq Bale", "weight": 4, "lang": "en"}
]
# Ganti dengan ID kosakata yang sebenarnya saat memperbarui
service.update_vocabulary("vocab-testpfx-xxx", my_vocabulary)

Hapus kosakata kustom 

import dashscope
from dashscope.audio.asr import *
import os

# Kunci API untuk wilayah Singapura dan Beijing berbeda. Dapatkan kunci API: https://www.alibabacloud.com/help/en/model-studio/get-api-key
# Jika tidak ada variabel lingkungan yang dikonfigurasi, ganti baris berikut dengan Kunci API Model Studio Anda: dashscope.api_key = "sk-xxx"
dashscope.api_key = os.environ.get('DASHSCOPE_API_KEY')

# Konfigurasi berikut untuk wilayah Singapura. Ganti "{WorkspaceId}" dengan workspace ID Anda yang sebenarnya. Konfigurasi bervariasi tergantung wilayah.
dashscope.base_http_api_url = 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1'

service = VocabularyService()
# Ganti dengan ID kosakata yang sebenarnya saat menghapus
service.delete_vocabulary("vocab-testpfx-xxxx")
Penggunaan API
Generasi teks
Pembuatan Gambar
  • FAQ
Video Generation
Model Dunia
Audio
Real-time multimodal
Realtime API
Penyematan Teks
Lainnya Model
Toolkit/Framework
TokenPlan
Model production
Manajemen file
Penagihan
Manajemen Model
Lebih Banyak Tentang Model