Panduan ini memandu Anda melalui SDK iOS pengenalan ucapan non-real-time Qwen-Audio-ASR-Filetrans, sehingga Anda dapat mengonversi audio menjadi teks.
Untuk persyaratan input seperti format audio yang didukung, batas ukuran file, dan batas durasi, lihat Spesifikasi audio.
Konfigurasikan parameter ini dengan meneruskan string JSON dalam argumen
Deskripsi parameter
Konfigurasikan semua parameter pengenalan suara melalui antarmuka
Deskripsi parameter
Menginisialisasi instance SDK pengenalan ucapan. SDK ini adalah singleton. Jangan menginisialisasinya lagi sebelum Anda memanggil
Deskripsi parameter
Gunakan antarmuka ini untuk mengatur atau memperbarui parameter
Deskripsi parameter
Memulai pengenalan.
Signature metode
Deskripsi parameter
Gunakan antarmuka ini untuk secara aktif mengkueri status dan hasil saat ini dari tugas asinkron. Setelah panggilan berhasil, hasil dikembalikan melalui event
Signature metode
Deskripsi parameter
Membatalkan tugas saat ini secara langsung.
Signature metode
Deskripsi parameter
Melepaskan semua sumber daya internal SDK dan menghentikan paksa semua tugas yang sedang berlangsung. Setelah Anda memanggil metode ini, instance SDK menjadi tidak tersedia. Untuk menggunakannya lagi, Anda harus memanggil
Mendapatkan informasi versi SDK saat ini.
Signature metode
Nilai kembalian
Informasi versi SDK saat ini.
Signature metode
Deskripsi parameter
Gunakan callback ini untuk menerima log internal SDK yang terperinci untuk pemecahan masalah dan debugging.
Mulai cepat
- Dapatkan Kunci API:Dapatkan kunci API
-
Unduh SDK dan jalankan kode contoh:
- Unduh bundel SDK terbaru.
- Ekstrak paket ZIP dan tambahkan nuisdk.framework yang disertakan ke proyek Anda.
- Di bawah Build Phases → Link Binary With Libraries, tambahkan
nuisdk.xcframework. - Di bawah General → Frameworks, Libraries, and Embedded Content, atur
nuisdk.xcframeworkke Embed & Sign. - Buka proyek contoh di Xcode. Kode contoh terletak di
DashFunAsrFileTranscriberViewController.m. Ganti API Key untuk mencoba fitur tersebut.
Langkah panggilan
- Mode sinkron
- Mode asinkron
- Inisialisasi SDK.
- Konfigurasikan parameter yang relevan untuk kasus penggunaan Anda.
- Atur
async_requestkefalsedan panggilnui_file_trans_startuntuk mengirimkan permintaan pengenalan ucapan non-real-time dan menunggu hasilnya. - Pada callback
onFileTransEventCallback, dengarkan eventEVENT_FILE_TRANS_RESULTuntuk mendapatkan hasil pengenalan akhir. - Panggil
nui_releaseuntuk melepaskan sumber daya SDK.
Parameter permintaan
Parameter koneksi dan kontrol
Konfigurasikan parameter ini dengan meneruskan string JSON dalam argumen parameters dari antarmuka nui_initialize.
Contoh parameter
Berikut ini adalah contoh string JSON. Tidak semua parameter dicantumkan. Tambahkan yang Anda butuhkan saat menulis kode:
| Parameter | Tipe | Wajib | Deskripsi |
|---|---|---|---|
url | String | Ya | Endpoint layanan:
{WorkspaceId} dengan ID Workspace Anda yang sebenarnya. |
apikey | String | Ya | Kunci API. |
service_mode | String | Ya | Mode eksekusi. Diatur tetap ke "1" untuk pengenalan suara non-real-time. |
device_id | String | Ya | String unik yang mengidentifikasi pengguna akhir. Atur ke ID pengguna dalam aplikasi atau pengenal perangkat yang dihasilkan oleh klien. ID ini terutama digunakan untuk pelacakan log dan pemecahan masalah. |
debug_path | String | Tidak | Jalur penyimpanan untuk file log.Parameter ini hanya berlaku ketika save_log diatur ke YES saat Anda memanggil antarmuka nui_initialize. Dalam hal ini, Anda harus mengatur jalur file log; jika tidak, error akan dikembalikan.Maksimal dua file log disimpan secara lokal. |
max_log_file_size | int | Tidak | Ukuran maksimum file log, dalam byte.Parameter ini hanya berlaku ketika save_log diatur ke YES saat Anda memanggil antarmuka nui_initialize.Nilai default: 104857600 (100 * 1024 * 1024 byte, yaitu, 100 MiB). |
log_track_level | int | Tidak | Mengontrol tingkat filter konten log yang dikirim melalui callback log (onFileTransLogTrackCallback).Nilai default: 2.Nilai yang valid:
log_track_level dan level (diatur melalui antarmuka nui_initialize) bersama-sama menentukan log mana yang akhirnya dikirim ke callback. Nilai tingkat log harus lebih besar dari atau sama dengan log_track_level dan level sebelum dikirim ke callback. Misalnya, jika log_track_level diatur ke 2 (INFO) dan level diatur ke 3 (WARNING), hanya log pada tingkat WARNING atau lebih tinggi (nilai >= 3) yang dikirim ke callback. |
Parameter efek pengenalan suara
Konfigurasikan semua parameter pengenalan suara melalui antarmuka nui_file_trans_start.
Contoh parameter
Berikut ini adalah contoh string JSON. Tidak semua parameter dicantumkan. Tambahkan yang Anda butuhkan saat menulis kode:
| Parameter | Tipe | Wajib | Deskripsi |
|---|---|---|---|
file_urls | array[string] | Ya | Daftar URL file audio atau video yang akan ditranskripsikan. HTTP dan HTTPS didukung. Satu permintaan hanya mendukung satu URL. Untuk persyaratan input seperti format audio yang didukung, batas ukuran file, dan batas durasi, lihat Spesifikasi audio.Jika rekaman disimpan di Alibaba Cloud OSS, API RESTful mendukung URL sementara dengan awalan oss://, sedangkan SDK tidak mendukung URL sementara dengan awalan oss://. |
async_request | boolean | Tidak | Apakah permintaan pengenalan suara bersifat asinkron.Nilai default: false.Nilai yang valid:
|
apikey | string | Tidak | Jika apikey di Parameter koneksi dan kontrol adalah API Key sementara, Anda dapat memperbaruinya di sini untuk mencegah kedaluwarsa. |
nls_config | object | Ya | Objek konfigurasi pengenalan suara inti. Ini berisi parameter kunci seperti pemilihan model dan kontrol efek pengenalan. |
nls_config.model | string | Ya | Nama model. |
nls_config.special_word_filter | object | Tidak | Kata sensitif yang akan diproses selama pengenalan suara. Anda dapat mengatur metode penanganan yang berbeda untuk setiap kata sensitif. Untuk detailnya, lihat Pemfilteran kata sensitif. |
nls_config.channel_id | array[integer] | Tidak | Indeks trek audio yang akan dikenali dalam file audio multi-trek. Indeks dimulai dari 0. Misalnya, [0] mengenali trek pertama, dan [0, 1] mengenali trek pertama dan kedua secara bersamaan. Jika Anda menghilangkan parameter ini, hanya trek pertama yang diproses.Nilai default: [0]. |
nls_config.diarization_enabled | boolean | Tidak | Apakah akan mengaktifkan diarization pembicara. Dinonaktifkan secara default.Hanya berlaku untuk audio mono. Audio multi-saluran tidak mendukung diarization pembicara.Saat diaktifkan, hasil pengenalan menyertakan bidang speaker_id yang membedakan pembicara yang berbeda.Saat diarization pembicara diaktifkan, pertahankan durasi audio dalam 2 jam. Jika tidak, pengenalan mungkin gagal atau habis waktu. speaker_id, lihat Deskripsi hasil pengenalan. |
nls_config.speaker_count | integer | Tidak | Nilai referensi untuk jumlah pembicara. Rentang yang valid adalah bilangan bulat dari 2 hingga 100 (inklusif).Secara default, jumlah pembicara dideteksi secara otomatis. Jika Anda mengatur nilai ini, ini hanya memandu algoritme untuk menghasilkan jumlah yang ditentukan jika memungkinkan dan tidak menjamin jumlah yang tepat tersebut.Tidak ada nilai default. |
nls_config.vocabulary_id | string | Tidak | ID dari daftar hotword yang telah dikompilasi sebelumnya.Hasilkan ID ini terlebih dahulu dengan memanggil API buat daftar hotword. Teruskan ID selama pengenalan untuk menggunakan hotword dalam daftar.Cocok untuk skenario di mana kosakata diketahui dan relatif stabil, dan di mana Anda perlu menggunakan kembali daftar kata yang sama di berbagai permintaan.Untuk detail penggunaan, lihat Hotword yang telah dikompilasi sebelumnya. |
nls_config.input_context | array | Tidak | Daftar pesan yang berisi konteks percakapan opsional untuk meningkatkan akurasi pengenalan. |
nls_config.instant_vocabulary | object | Tidak | Hotword instan, diteruskan sebagai pasangan kunci-nilai. Setiap kunci adalah teks hotword (string), dan setiap nilai adalah bobotnya (integer). Tidak diperlukan daftar hotword yang telah dikompilasi sebelumnya. Gunakan parameter ini untuk hotword sementara tingkat sesi.Bobot yang valid adalah bilangan bulat dari 1 hingga 5, atau 50. Bobot yang lebih tinggi dari 1 hingga 5 membuat model lebih mungkin menghasilkan hotword. Bobot 50 mendefinisikan super hotword dan secara signifikan meningkatkan recall. Anda dapat menentukan hingga 50 super hotword.Jika Anda juga mengonfigurasi hotword yang telah dikompilasi sebelumnya, kedua set akan digabungkan. Jika set yang digabungkan melebihi 2000 hotword, 2000 akan dipilih secara acak. Untuk penggunaan, lihat Hotword instan. |
nls_config.language_hints | array[string] | Tidak | Kode bahasa yang akan dikenali. Jika Anda tidak dapat menentukan bahasa terlebih dahulu, biarkan tidak diatur dan model akan mendeteksi bahasa secara otomatis.Anda dapat menetapkan hingga 4 nilai. Jika lebih, hanya 4 nilai pertama yang berlaku.
Klik untuk melihat kode bahasa yang didukung
|
Antarmuka utama
NeoNui
nui_initialize
Menginisialisasi instance SDK pengenalan ucapan. SDK ini adalah singleton. Jangan menginisialisasinya lagi sebelum Anda memanggil nui_release.
Signature metode
| Parameter | Tipe | Deskripsi |
|---|---|---|
parameters | char* | String JSON yang berisi parameter autentikasi, koneksi, dan debugging. Lihat Parameter koneksi dan kontrol. |
level | NuiSdkLogLevel | Mengontrol tingkat pencetakan log SDK itu sendiri. |
save_log | BOOL | Apakah akan menyimpan log secara lokal. Jika diatur ke YES, Anda harus menentukan jalur melalui debug_path di Parameter koneksi dan kontrol, dan Anda dapat mengatur ukuran file melalui max_log_file_size. |
nui_set_params
Gunakan antarmuka ini untuk mengatur atau memperbarui parameter nls_config secara independen. Jika Anda menyediakan semua parameter sekaligus di nui_file_trans_start, Anda tidak perlu memanggil metode ini.
Signature metode
| Parameter | Tipe | Deskripsi |
|---|---|---|
params | char* | Parameter nls_config di Parameter efek pengenalan ucapan. Parameter selain nls_config tidak dapat diatur melalui metode ini.Contoh: |
nui_file_trans_start
Memulai pengenalan.
Signature metode
| Parameter | Tipe | Deskripsi |
|---|---|---|
params | char* | Parameter efek pengenalan suara.Contoh: |
task_id | char* | ID tugas. SDK menghasilkan string acak secara internal dan mengembalikan task_id ketika antarmuka ini berhasil dipanggil. |
nui_file_trans_query
Gunakan antarmuka ini untuk secara aktif mengkueri status dan hasil saat ini dari tugas asinkron. Setelah panggilan berhasil, hasil dikembalikan melalui event EVENT_FILE_TRANS_QUERY_RESULT di callback onFileTransEventCallback.
Dapatkan
task_id yang diteruskan ke metode ini dari event EVENT_FILE_TRANS_UPLOADED.| Parameter | Tipe | Deskripsi |
|---|---|---|
task_id | char* | ID tugas yang akan dikueri, diperoleh dari event EVENT_FILE_TRANS_UPLOADED. |
nui_file_trans_cancel
Membatalkan tugas saat ini secara langsung.
Signature metode
| Parameter | Tipe | Deskripsi |
|---|---|---|
task_id | char* | ID tugas yang akan dibatalkan, diperoleh dari event EVENT_FILE_TRANS_UPLOADED. |
nui_release
Melepaskan semua sumber daya internal SDK dan menghentikan paksa semua tugas yang sedang berlangsung. Setelah Anda memanggil metode ini, instance SDK menjadi tidak tersedia. Untuk menggunakannya lagi, Anda harus memanggil nui_initialize lagi untuk menginisialisasinya.
Signature metode
nui_get_version
Mendapatkan informasi versi SDK saat ini.
Signature metode
NeoNuiSdkDelegate: pantau callback
onFileTransEventCallback: pantau event dan hasil pengenalan suara
Signature metode
| Parameter | Tipe | Deskripsi |
|---|---|---|
nuiEvent | NuiCallbackEvent | Event callback. |
asr_result | char* | Hasil pengenalan ucapan. |
task_id | char* | ID tugas. |
finish | BOOL | Menunjukkan apakah putaran pengenalan ini telah selesai. |
code | int | Hanya valid saat event EVENT_ASR_ERROR terjadi. |
onFileTransLogTrackCallback: pantau log pelacakan
Gunakan callback ini untuk menerima log internal SDK yang terperinci untuk pemecahan masalah dan debugging.
NuiCallbackEvent: tipe event
| Event | Deskripsi |
|---|---|
EVENT_FILE_TRANS_CONNECTED | Berhasil terhubung ke layanan. |
EVENT_FILE_TRANS_UPLOADED | File audio yang akan dikenali berhasil diunggah. Anda sekarang dapat memperoleh task_id dari tugas saat ini. |
EVENT_FILE_TRANS_QUERY_RESULT | Hasil tugas kueri. |
EVENT_FILE_TRANS_RESULT | Hasil pengenalan akhir. |
EVENT_ASR_ERROR | Terjadi error selama pengenalan ucapan. |