BotFrameworkConfig class

  • Referensi
Paket:
microsoft-cognitiveservices-speech-sdk

Kelas yang menentukan konfigurasi untuk objek konektor layanan dialog untuk menggunakan backend Bot Framework.

Extends

DialogServiceConfigImpl

Konstruktor

BotFrameworkConfig()

Membuat instans BotFrameworkConfig.

Properti

applicationId

Mengatur pengidentifikasi aplikasi backend yang sesuai.
DialogTypes
outputFormat
properties

Menyediakan akses ke properti kustom.
speechRecognitionLanguage

Mendapatkan bahasa pengenalan ucapan.

Metode

fromAuthorizationToken(string, string, string)

Membuat instans konfigurasi kerangka kerja bot untuk token dan wilayah otorisasi yang ditentukan. Catatan: Pemanggil harus memastikan bahwa token otorisasi valid. Sebelum token otorisasi kedaluwarsa, pemanggil harus merefreshnya dengan mengatur properti authorizationToken pada instans DialogServiceConnector yang sesuai yang dibuat dengan konfigurasi ini. Konten objek konfigurasi disalin saat konektor dibuat, sehingga mengatur authorizationToken pada DialogServiceConnector tidak akan memperbarui token otorisasi konfigurasi asli. Buat instans konfigurasi baru atau atur properti SpeechServiceAuthorization_Token untuk memperbarui instans yang ada jika akan digunakan untuk membuat DialogServiceConnectors lebih lanjut.
fromEndpoint(URL, string)

Membuat instans BotFrameworkConfig. 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. Catatan: Untuk menggunakan token otorisasi dengan fromEndpoint, teruskan string kosong ke subscriptionKey dalam metode fromEndpoint, lalu atur authorizationToken="token" pada instans BotFrameworkConfig yang dibuat untuk menggunakan token otorisasi. Catatan: Ditambahkan dalam versi 1.15.0.
fromHost(string | URL, string, string)

Membuat instans BotFrameworkConfig. 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 sama sekali, 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 BotFrameworkConfig yang dibuat. Catatan: Ditambahkan dalam versi 1.15.0.
fromSubscription(string, string, string)

Membuat instans konfigurasi kerangka kerja bot dengan informasi langganan yang disediakan.

Metode yang Diwarisi

close()

Buang sumber daya terkait.
getProperty(string | PropertyId, string)

Mengatur properti bernama sebagai nilai
setProperty(string | PropertyId, string)

Mengatur properti bernama sebagai nilai
setProxy(string, number, string, string)

Mengatur konfigurasi proksi. Hanya relevan di lingkungan Node.js. Ditambahkan dalam versi 1.4.0.
setServiceProperty(string, string, UriQueryParameter)

Detail Konstruktor

BotFrameworkConfig()

Membuat instans BotFrameworkConfig.

new BotFrameworkConfig()

Detail Properti

applicationId

Mengatur pengidentifikasi aplikasi backend yang sesuai.

void applicationId

Nilai Properti

void

DialogTypes 

static { BotFramework: string, CustomCommands: string } DialogTypes

Nilai Properti

{ BotFramework: string, CustomCommands: string }

outputFormat 

OutputFormat outputFormat

Nilai Properti

OutputFormat

properties

Menyediakan akses ke properti kustom.

PropertyCollection properties

Nilai Properti

PropertyCollection

Properti.

speechRecognitionLanguage

Mendapatkan bahasa pengenalan ucapan.

string speechRecognitionLanguage

Nilai Properti

string

Detail Metode

fromAuthorizationToken(string, string, string)

Membuat instans konfigurasi kerangka kerja bot untuk token dan wilayah otorisasi yang ditentukan. Catatan: Pemanggil harus memastikan bahwa token otorisasi valid. Sebelum token otorisasi kedaluwarsa, pemanggil harus merefreshnya dengan mengatur properti authorizationToken pada instans DialogServiceConnector yang sesuai yang dibuat dengan konfigurasi ini. Konten objek konfigurasi disalin saat konektor dibuat, sehingga mengatur authorizationToken pada DialogServiceConnector tidak akan memperbarui token otorisasi konfigurasi asli. Buat instans konfigurasi baru atau atur properti SpeechServiceAuthorization_Token untuk memperbarui instans yang ada jika akan digunakan untuk membuat DialogServiceConnectors lebih lanjut.

static function fromAuthorizationToken(authorizationToken: string, region: string, botId?: string): BotFrameworkConfig

Parameter

authorizationToken

string

Token otorisasi yang terkait dengan bot

region

string

Nama wilayah (lihat halaman wilayah).

botId

string

Pilihan. Pengidentifikasi untuk menggunakan bot tertentu dalam grup sumber daya Azure. Setara dengan nama sumber daya.

Mengembalikan

BotFrameworkConfig

Instans konfigurasi kerangka kerja bot baru.

fromEndpoint(URL, string)

Membuat instans BotFrameworkConfig. 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. Catatan: Untuk menggunakan token otorisasi dengan fromEndpoint, teruskan string kosong ke subscriptionKey dalam metode fromEndpoint, lalu atur authorizationToken="token" pada instans BotFrameworkConfig yang dibuat untuk menggunakan token otorisasi. Catatan: Ditambahkan dalam versi 1.15.0.

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

Parameter

endpoint

URL

Titik akhir layanan yang akan disambungkan.

subscriptionKey

string

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

Mengembalikan

BotFrameworkConfig
  • Instans konfigurasi kerangka kerja bot baru menggunakan titik akhir yang disediakan.

fromHost(string | URL, string, string)

Membuat instans BotFrameworkConfig. 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 sama sekali, 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 BotFrameworkConfig yang dibuat. Catatan: Ditambahkan dalam versi 1.15.0.

static function fromHost(host: string | URL, subscriptionKey?: string, botId?: string): BotFrameworkConfig

Parameter

host

string | URL

Jika URL disediakan, host yang sepenuhnya memenuhi syarat dengan protokol (misalnya wss://your.host.com:1234) akan digunakan. Jika string disediakan, string akan disematkan di wss://{host}.convai.speech.azure.us.

subscriptionKey

string

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

botId

string

Pilihan. Pengidentifikasi untuk menggunakan bot tertentu dalam grup sumber daya Azure. Setara dengan nama sumber daya.

Mengembalikan

BotFrameworkConfig

Instans konfigurasi kerangka kerja bot baru.

fromSubscription(string, string, string)

Membuat instans konfigurasi kerangka kerja bot dengan informasi langganan yang disediakan.

static function fromSubscription(subscription: string, region: string, botId?: string): BotFrameworkConfig

Parameter

subscription

string

Kunci langganan yang terkait dengan bot

region

string

Nama wilayah (lihat halaman wilayah).

botId

string

Pilihan. Pengidentifikasi untuk menggunakan bot tertentu dalam grup sumber daya Azure. Setara dengan nama sumber daya.

Mengembalikan

BotFrameworkConfig

Instans konfigurasi kerangka kerja bot baru.

Detail Metode yang Diwarisi

close()

Buang sumber daya terkait.

function close()

Diwarisi Dari DialogServiceConfigImpl.close

getProperty(string | PropertyId, string)

Mengatur properti bernama sebagai nilai

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

Parameter

name

string | PropertyId

Properti untuk didapatkan.

def

string

Nilai default yang akan dikembalikan jika properti tidak diketahui.

Mengembalikan

string

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

Diwarisi Dari DialogServiceConfigImpl.getProperty

setProperty(string | PropertyId, string)

Mengatur properti bernama sebagai nilai

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

Parameter

name

string | PropertyId

Properti yang akan diatur.

value

string

Nilainya.

Diwarisi Dari DialogServiceConfigImpl.setProperty

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.

Diwarisi Dari DialogServiceConfigImpl.setProxy

setServiceProperty(string, string, UriQueryParameter) 

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

Parameter

name

string

value

string

channel
UriQueryParameter

Diwarisi Dari DialogServiceConfigImpl.setServiceProperty