SpeechConfig class

Paket:

microsoft-cognitiveservices-speech-sdk

Konfigurasi ucapan.

Properti

authorizationToken	Mendapatkan token otorisasi.
endpointId	Mendapatkan ID titik akhir dari model ucapan yang disesuaikan yang digunakan untuk pengenalan ucapan.
outputFormat	Mendapatkan format output pengenalan ucapan (sederhana atau terperinci). Catatan: Format output ini adalah untuk hasil pengenalan ucapan, gunakan [SpeechConfig.speechSynthesisOutputFormat] untuk mendapatkan format output audio yang disintesis.
region
speechRecognitionLanguage	Mengembalikan bahasa yang dikonfigurasi.
speechSynthesisLanguage	Mendapatkan bahasa penyintesis ucapan. Ditambahkan dalam versi 1.11.0.
speechSynthesisOutputFormat	Mendapatkan format output sintesis ucapan. Ditambahkan dalam versi 1.11.0.
speechSynthesisVoiceName	Mendapatkan suara penyintesis ucapan. Ditambahkan dalam versi 1.11.0.
subscriptionKey
tokenCredential	Mendapatkan instans TokenCredential jika dikonfigurasi. Hanya tersedia jika menggunakan autentikasi berbasis AAD melalui TokenCredential.

Metode

close()	Menutup konfigurasi.
enableAudioLogging()	Aktifkan pengelogan audio dalam layanan. Log audio dan konten disimpan baik di penyimpanan milik Microsoft, atau di akun penyimpanan Anda sendiri yang ditautkan ke langganan Cognitive Services Anda (Bring Your Own Storage (BYOS) diaktifkan sumber daya Ucapan). Log akan dihapus setelah 30 hari. Ditambahkan dalam versi 1.7.0.
enableDictation()	Aktifkan dikte. Hanya didukung dalam pengenalan berkelanjutan ucapan. Ditambahkan dalam versi 1.7.0.
fromAuthorizationToken(string, string)	Membuat instans pabrik ucapan dengan token dan wilayah otorisasi awal yang ditentukan. Catatan: Pemanggil perlu memastikan bahwa token otorisasi valid. Sebelum token otorisasi kedaluwarsa, pemanggil perlu merefreshnya dengan memanggil setter ini dengan token valid baru. Catatan: Karena nilai konfigurasi disalin saat membuat pengenal baru, nilai token baru tidak akan berlaku untuk pengenal yang telah dibuat. Untuk pengenal yang telah dibuat sebelumnya, Anda perlu mengatur token otorisasi pengenal yang sesuai untuk me-refresh token. Jika tidak, pengenal akan mengalami kesalahan selama pengenalan.
fromEndpoint(URL, KeyCredential | TokenCredential)	Membuat instans SpeechConfig dengan titik akhir kustom dan kredensial. Parameter kueri yang ditentukan dalam URI titik akhir tidak diubah, meskipun diatur oleh panggilan API lainnya. Misalnya, jika bahasa pengenalan ditentukan dalam parameter kueri URI sebagai "language=de-DE", dan properti SpeechRecognitionLanguage diatur ke "en-US", bahasa yang ditetapkan dalam URI diutamakan, dan "de-DE" tetap menjadi bahasa yang diharapkan. Karena parameter yang disertakan dalam URI titik akhir diprioritaskan, hanya parameter yang tidak ditentukan dalam URI titik akhir yang dapat diatur oleh API lain. Jenis kredensial yang didukung: KeyCredential: Untuk autentikasi berbasis kunci API. TokenCredential: Untuk autentikasi berbasis Azure Active Directory. Catatan: Untuk menggunakan token otorisasi dengan fromEndpoint, teruskan string kosong ke subscriptionKey dalam metode fromEndpoint, lalu atur authorizationToken="token" pada instans SpeechConfig yang dibuat untuk menggunakan token otorisasi.
fromEndpoint(URL, string)	Membuat instans konfigurasi ucapan dengan titik akhir dan kunci langganan yang ditentukan. Metode ini hanya ditujukan untuk pengguna yang menggunakan titik akhir atau parameter layanan non-standar. Catatan: Parameter kueri yang ditentukan dalam URL titik akhir tidak diubah, meskipun diatur oleh API lain. Misalnya, jika bahasa didefinisikan dalam uri sebagai parameter kueri "language=de-DE", dan juga diatur oleh SpeechConfig.speechRecognitionLanguage = "en-US", pengaturan bahasa dalam uri lebih diutamakan, dan bahasa yang efektif adalah "de-DE". Hanya parameter yang tidak ditentukan dalam URL titik akhir yang dapat diatur oleh API lain. Catatan: Untuk menggunakan token otorisasi dengan fromEndpoint, teruskan string kosong ke subscriptionKey dalam metode fromEndpoint, lalu atur authorizationToken="token" pada instans SpeechConfig yang dibuat untuk menggunakan token otorisasi.
fromHost(URL, string)	Membuat instans konfigurasi ucapan dengan host dan kunci langganan tertentu. Metode ini hanya ditujukan untuk pengguna yang menggunakan host layanan non-default. Jalur sumber daya standar akan diasumsikan. Untuk layanan dengan jalur sumber daya non-standar atau tidak ada jalur, gunakan fromEndpoint sebagai gantinya. Catatan: Parameter kueri tidak diizinkan di URI host dan harus diatur oleh API lain. Catatan: Untuk menggunakan token otorisasi dengan fromHost, gunakan fromHost(URL), lalu atur properti AuthorizationToken pada instans SpeechConfig yang dibuat. Catatan: Ditambahkan dalam versi 1.9.0.
fromSubscription(string, string)	Instans statis SpeechConfig dikembalikan dengan meneruskan subscriptionKey dan wilayah layanan.
getProperty(string, string)	Mengembalikan nilai properti arbitrer saat ini.
requestWordLevelTimestamps()	Menyertakan tanda waktu tingkat kata. Ditambahkan dalam versi 1.7.0.
setProfanity(ProfanityOption)	Mengatur opsi kata-kata kosakata. Ditambahkan dalam versi 1.7.0.
setProperty(string | PropertyId, string)	Mengatur properti arbitrer.
setProxy(string, number)	Mengatur konfigurasi proksi. Hanya relevan di lingkungan Node.js. Ditambahkan dalam versi 1.4.0.
setProxy(string, number, string, string)	Mengatur konfigurasi proksi. Hanya relevan di lingkungan Node.js. Ditambahkan dalam versi 1.4.0.
setServiceProperty(string, string, UriQueryParameter)	Mengatur nilai properti yang akan diteruskan ke layanan menggunakan saluran yang ditentukan. Ditambahkan dalam versi 1.7.0.

Detail Properti

authorizationToken

Mendapatkan token otorisasi.

string authorizationToken

Nilai Properti

string

endpointId

Mendapatkan ID titik akhir dari model ucapan yang disesuaikan yang digunakan untuk pengenalan ucapan.

string endpointId

Nilai Properti

string

ID titik akhir

outputFormat

Mendapatkan format output pengenalan ucapan (sederhana atau terperinci). Catatan: Format output ini adalah untuk hasil pengenalan ucapan, gunakan [SpeechConfig.speechSynthesisOutputFormat] untuk mendapatkan format output audio yang disintesis.

OutputFormat outputFormat

Nilai Properti

OutputFormat

Mengembalikan format output.

region

string region

Nilai Properti

string

Wilayah yang diatur pada konfigurasi.

speechRecognitionLanguage

Mengembalikan bahasa yang dikonfigurasi.

string speechRecognitionLanguage

Nilai Properti

string

speechSynthesisLanguage

Mendapatkan bahasa penyintesis ucapan. Ditambahkan dalam versi 1.11.0.

string speechSynthesisLanguage

Nilai Properti

string

Mengembalikan bahasa sintesis ucapan.

speechSynthesisOutputFormat

Mendapatkan format output sintesis ucapan. Ditambahkan dalam versi 1.11.0.

SpeechSynthesisOutputFormat speechSynthesisOutputFormat

Nilai Properti

SpeechSynthesisOutputFormat

Mengembalikan format output sintesis ucapan

speechSynthesisVoiceName

Mendapatkan suara penyintesis ucapan. Ditambahkan dalam versi 1.11.0.

string speechSynthesisVoiceName

Nilai Properti

string

Mengembalikan suara sintesis ucapan.

subscriptionKey

string subscriptionKey

Nilai Properti

string

Kunci langganan diatur pada konfigurasi.

tokenCredential

Mendapatkan instans TokenCredential jika dikonfigurasi. Hanya tersedia jika menggunakan autentikasi berbasis AAD melalui TokenCredential.

undefined | TokenCredential tokenCredential

Nilai Properti

undefined | TokenCredential

Detail Metode

close()

Menutup konfigurasi.

function close()

enableAudioLogging()

Aktifkan pengelogan audio dalam layanan. Log audio dan konten disimpan baik di penyimpanan milik Microsoft, atau di akun penyimpanan Anda sendiri yang ditautkan ke langganan Cognitive Services Anda (Bring Your Own Storage (BYOS) diaktifkan sumber daya Ucapan). Log akan dihapus setelah 30 hari. Ditambahkan dalam versi 1.7.0.

function enableAudioLogging()

enableDictation()

Aktifkan dikte. Hanya didukung dalam pengenalan berkelanjutan ucapan. Ditambahkan dalam versi 1.7.0.

function enableDictation()

fromAuthorizationToken(string, string)

Membuat instans pabrik ucapan dengan token dan wilayah otorisasi awal yang ditentukan. Catatan: Pemanggil perlu memastikan bahwa token otorisasi valid. Sebelum token otorisasi kedaluwarsa, pemanggil perlu merefreshnya dengan memanggil setter ini dengan token valid baru. Catatan: Karena nilai konfigurasi disalin saat membuat pengenal baru, nilai token baru tidak akan berlaku untuk pengenal yang telah dibuat. Untuk pengenal yang telah dibuat sebelumnya, Anda perlu mengatur token otorisasi pengenal yang sesuai untuk me-refresh token. Jika tidak, pengenal akan mengalami kesalahan selama pengenalan.

static function fromAuthorizationToken(authorizationToken: string, region: string): SpeechConfig

Parameter

authorizationToken

string

Token otorisasi awal.

region

string

Nama wilayah (lihat halaman wilayah).

Mengembalikan

SpeechConfig

Instans pabrik ucapan.

fromEndpoint(URL, KeyCredential | TokenCredential)

Membuat instans SpeechConfig dengan titik akhir kustom dan kredensial. Parameter kueri yang ditentukan dalam URI titik akhir tidak diubah, meskipun diatur oleh panggilan API lainnya. Misalnya, jika bahasa pengenalan ditentukan dalam parameter kueri URI sebagai "language=de-DE", dan properti SpeechRecognitionLanguage diatur ke "en-US", bahasa yang ditetapkan dalam URI diutamakan, dan "de-DE" tetap menjadi bahasa yang diharapkan. Karena parameter yang disertakan dalam URI titik akhir diprioritaskan, hanya parameter yang tidak ditentukan dalam URI titik akhir yang dapat diatur oleh API lain. Jenis kredensial yang didukung:

• KeyCredential: Untuk autentikasi berbasis kunci API.
• TokenCredential: Untuk autentikasi berbasis Azure Active Directory. Catatan: Untuk menggunakan token otorisasi dengan fromEndpoint, teruskan string kosong ke subscriptionKey dalam metode fromEndpoint, lalu atur authorizationToken="token" pada instans SpeechConfig yang dibuat untuk menggunakan token otorisasi.

static function fromEndpoint(endpoint: URL, credential: KeyCredential | TokenCredential): SpeechConfig

Parameter

endpoint

URL

Titik akhir layanan yang akan disambungkan.

credential

KeyCredential | TokenCredential

Kredensial yang digunakan untuk autentikasi.

Mengembalikan

SpeechConfig

Instans pabrik ucapan.

fromEndpoint(URL, string)

Membuat instans konfigurasi ucapan dengan titik akhir dan kunci langganan yang ditentukan. Metode ini hanya ditujukan untuk pengguna yang menggunakan titik akhir atau parameter layanan non-standar. Catatan: Parameter kueri yang ditentukan dalam URL titik akhir tidak diubah, meskipun diatur oleh API lain. Misalnya, jika bahasa didefinisikan dalam uri sebagai parameter kueri "language=de-DE", dan juga diatur oleh SpeechConfig.speechRecognitionLanguage = "en-US", pengaturan bahasa dalam uri lebih diutamakan, dan bahasa yang efektif adalah "de-DE". Hanya parameter yang tidak ditentukan dalam URL titik akhir yang dapat diatur oleh API lain. Catatan: Untuk menggunakan token otorisasi dengan fromEndpoint, teruskan string kosong ke subscriptionKey dalam metode fromEndpoint, lalu atur authorizationToken="token" pada instans SpeechConfig yang dibuat untuk menggunakan token otorisasi.

static function fromEndpoint(endpoint: URL, subscriptionKey?: string): SpeechConfig

Parameter

endpoint

URL

Titik akhir layanan yang akan disambungkan.

subscriptionKey

string

Kunci langganan. Jika kunci langganan tidak ditentukan, token otorisasi harus diatur.

Mengembalikan

SpeechConfig

Instans pabrik ucapan.

fromHost(URL, string)

Membuat instans konfigurasi ucapan dengan host dan kunci langganan tertentu. Metode ini hanya ditujukan untuk pengguna yang menggunakan host layanan non-default. Jalur sumber daya standar akan diasumsikan. Untuk layanan dengan jalur sumber daya non-standar atau tidak ada jalur, gunakan fromEndpoint sebagai gantinya. Catatan: Parameter kueri tidak diizinkan di URI host dan harus diatur oleh API lain. Catatan: Untuk menggunakan token otorisasi dengan fromHost, gunakan fromHost(URL), lalu atur properti AuthorizationToken pada instans SpeechConfig yang dibuat. Catatan: Ditambahkan dalam versi 1.9.0.

static function fromHost(hostName: URL, subscriptionKey?: string): SpeechConfig

Parameter

hostName

URL

subscriptionKey

string

Kunci langganan. Jika kunci langganan tidak ditentukan, token otorisasi harus diatur.

Mengembalikan

SpeechConfig

Instans pabrik ucapan.

fromSubscription(string, string)

Instans statis SpeechConfig dikembalikan dengan meneruskan subscriptionKey dan wilayah layanan.

static function fromSubscription(subscriptionKey: string, region: string): SpeechConfig

Parameter

subscriptionKey

string

Kunci langganan.

region

string

Nama wilayah (lihat halaman wilayah).

Mengembalikan

SpeechConfig

Pabrik ucapan

getProperty(string, string)

Mengembalikan nilai properti arbitrer saat ini.

function getProperty(name: string, def?: string): string

Parameter

name

string

Nama properti yang akan dikueri.

def

string

Nilai yang akan dikembalikan jika properti tidak diketahui.

Mengembalikan

string

Nilai saat ini, atau default yang disediakan, dari properti yang diberikan.

requestWordLevelTimestamps()

Menyertakan tanda waktu tingkat kata. Ditambahkan dalam versi 1.7.0.

function requestWordLevelTimestamps()

setProfanity(ProfanityOption)

Mengatur opsi kata-kata kosakata. Ditambahkan dalam versi 1.7.0.

function setProfanity(profanity: ProfanityOption)

Parameter

profanity

ProfanityOption

setProperty(string | PropertyId, string)

Mengatur properti arbitrer.

function setProperty(name: string | PropertyId, value: string)

Parameter

name

string | PropertyId

Nama properti yang akan diatur.

value

string

Nilai baru properti.

setProxy(string, number)

Mengatur konfigurasi proksi. Hanya relevan di lingkungan Node.js. Ditambahkan dalam versi 1.4.0.

function setProxy(proxyHostName: string, proxyPort: number)

Parameter

proxyHostName

string

Nama host server proksi.

proxyPort

number

Nomor port server proksi.

setProxy(string, number, string, string)

Mengatur konfigurasi proksi. Hanya relevan di lingkungan Node.js. Ditambahkan dalam versi 1.4.0.

function setProxy(proxyHostName: string, proxyPort: number, proxyUserName: string, proxyPassword: string)

Parameter

proxyHostName

string

Nama host server proksi, tanpa skema protokol (http://)

proxyPort

number

Nomor port server proksi.

proxyUserName

string

Nama pengguna server proksi.

proxyPassword

string

Kata sandi server proksi.

setServiceProperty(string, string, UriQueryParameter)

Mengatur nilai properti yang akan diteruskan ke layanan menggunakan saluran yang ditentukan. Ditambahkan dalam versi 1.7.0.

function setServiceProperty(name: string, value: string, channel: UriQueryParameter)

Parameter

name

string

value

string

channel

UriQueryParameter