BotFrameworkConfig class

Paket:

microsoft-cognitiveservices-speech-sdk

Bot Framework arka ucu kullanmak için iletişim kutusu hizmeti bağlayıcı nesnesi yapılandırmalarını tanımlayan sınıf. BotFrameworkConfig

Extends

DialogServiceConfigImpl

Oluşturucular

BotFrameworkConfig()

BotFrameworkConfig örneği oluşturur.

Özellikler

applicationId	Karşılık gelen arka uç uygulama tanımlayıcısını ayarlar.
DialogTypes
outputFormat
properties	Özel özelliklere erişim sağlar.
speechRecognitionLanguage	Konuşma tanıma dilini alır.

Yöntemler

fromAuthorizationToken(string, string, string)	Belirtilen yetkilendirme belirteci ve bölgesi için bir bot çerçevesi yapılandırma örneği oluşturur. Not: Çağıranın yetkilendirme belirtecinin geçerli olduğundan emin olması gerekir. Yetkilendirme belirtecinin süresi dolmadan önce, çağıranın bu yapılandırmayla oluşturulan ilgili DialogServiceConnector örneğinde authorizationToken özelliğini ayarlayarak bu belirteci yenilemesi gerekir. Bağlayıcılar oluşturulduğunda yapılandırma nesnelerinin içeriği kopyalanır, bu nedenle dialogServiceConnector'da authorizationToken ayarı özgün yapılandırmanın yetkilendirme belirtecini güncelleştirmez. Yeni bir yapılandırma örneği oluşturun veya daha fazla DialogServiceConnector oluşturmak için kullanılacaksa mevcut örneği güncelleştirmek için SpeechServiceAuthorization_Token özelliğini ayarlayın.
fromEndpoint(URL, string)	BotFrameworkConfig örneğini oluşturur. Bu yöntem yalnızca standart olmayan bir hizmet uç noktası veya parametre kullanan kullanıcılara yöneliktir. Not: Uç nokta URL'sinde belirtilen sorgu parametreleri, diğer API'ler tarafından ayarlansa bile değiştirilmez. Not: Yetkilendirme belirtecini fromEndpoint ile kullanmak için fromEndpoint yönteminde subscriptionKey'e boş bir dize geçirin ve ardından yetkilendirme belirtecini kullanmak için oluşturulan BotFrameworkConfig örneğinde authorizationToken="token" değerini ayarlayın. Not: Sürüm 1.15.0'a eklendi.
fromHost(string | URL, string, string)	BotFrameworkConfig örneğini oluşturur. Bu yöntem yalnızca varsayılan olmayan bir hizmet konağı kullanan kullanıcılara yöneliktir. Standart kaynak yolu varsayılır. Standart olmayan kaynak yolu olan veya hiç yol içermeyen hizmetler için bunun yerine fromEndpoint kullanın. Not: Konak URI'sinde sorgu parametrelerine izin verilmez ve diğer API'ler tarafından ayarlanmalıdır. Not: fromHost ile yetkilendirme belirteci kullanmak için fromHost(URL) kullanın ve ardından oluşturulan BotFrameworkConfig örneğinde AuthorizationToken özelliğini ayarlayın. Not: Sürüm 1.15.0'a eklendi.
fromSubscription(string, string, string)	Sağlanan abonelik bilgileriyle bir bot çerçevesi yapılandırma örneği oluşturur.

Devralınan Yöntemler

close()	İlişkili kaynakları at.
getProperty(string | PropertyId, string)	Adlandırılmış özelliği değer olarak ayarlar
setProperty(string | PropertyId, string)	Adlandırılmış özelliği değer olarak ayarlar
setProxy(string, number, string, string)	Ara sunucu yapılandırmasını ayarlar. Yalnızca Node.js ortamlarda geçerlidir. Sürüm 1.4.0'a eklendi.
setServiceProperty(string, string, UriQueryParameter)

Oluşturucu Ayrıntıları

BotFrameworkConfig()

BotFrameworkConfig örneği oluşturur.

new BotFrameworkConfig()

Özellik Ayrıntıları

applicationId

Karşılık gelen arka uç uygulama tanımlayıcısını ayarlar.

void applicationId

Özellik Değeri

void

DialogTypes

static { BotFramework: string, CustomCommands: string } DialogTypes

Özellik Değeri

{ BotFramework: string, CustomCommands: string }

outputFormat

OutputFormat outputFormat

Özellik Değeri

OutputFormat

properties

Özel özelliklere erişim sağlar.

PropertyCollection properties

Özellik Değeri

PropertyCollection

Özellikleri.

speechRecognitionLanguage

Konuşma tanıma dilini alır.

string speechRecognitionLanguage

Özellik Değeri

string

Yöntem Ayrıntıları

fromAuthorizationToken(string, string, string)

Belirtilen yetkilendirme belirteci ve bölgesi için bir bot çerçevesi yapılandırma örneği oluşturur. Not: Çağıranın yetkilendirme belirtecinin geçerli olduğundan emin olması gerekir. Yetkilendirme belirtecinin süresi dolmadan önce, çağıranın bu yapılandırmayla oluşturulan ilgili DialogServiceConnector örneğinde authorizationToken özelliğini ayarlayarak bu belirteci yenilemesi gerekir. Bağlayıcılar oluşturulduğunda yapılandırma nesnelerinin içeriği kopyalanır, bu nedenle dialogServiceConnector'da authorizationToken ayarı özgün yapılandırmanın yetkilendirme belirtecini güncelleştirmez. Yeni bir yapılandırma örneği oluşturun veya daha fazla DialogServiceConnector oluşturmak için kullanılacaksa mevcut örneği güncelleştirmek için SpeechServiceAuthorization_Token özelliğini ayarlayın.

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

Parametreler

authorizationToken

string

Botla ilişkilendirilmiş yetkilendirme belirteci

region

string

Bölge adı (bölge sayfasına bakın).

botId

string

Opsiyonel. Azure kaynak grubu içinde belirli bir botu kullanmaya yönelik tanımlayıcı. Kaynak adına eşdeğerdir.

Döndürülenler

BotFrameworkConfig

Yeni bir bot çerçevesi yapılandırma örneği.

fromEndpoint(URL, string)

BotFrameworkConfig örneğini oluşturur. Bu yöntem yalnızca standart olmayan bir hizmet uç noktası veya parametre kullanan kullanıcılara yöneliktir. Not: Uç nokta URL'sinde belirtilen sorgu parametreleri, diğer API'ler tarafından ayarlansa bile değiştirilmez. Not: Yetkilendirme belirtecini fromEndpoint ile kullanmak için fromEndpoint yönteminde subscriptionKey'e boş bir dize geçirin ve ardından yetkilendirme belirtecini kullanmak için oluşturulan BotFrameworkConfig örneğinde authorizationToken="token" değerini ayarlayın. Not: Sürüm 1.15.0'a eklendi.

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

Parametreler

endpoint

URL

Bağlanacak hizmet uç noktası.

subscriptionKey

string

Abonelik anahtarı. Abonelik anahtarı belirtilmezse yetkilendirme belirteci ayarlanmalıdır.

Döndürülenler

BotFrameworkConfig

• Sağlanan uç noktayı kullanan yeni bir bot çerçevesi yapılandırma örneği.

fromHost(string | URL, string, string)

BotFrameworkConfig örneğini oluşturur. Bu yöntem yalnızca varsayılan olmayan bir hizmet konağı kullanan kullanıcılara yöneliktir. Standart kaynak yolu varsayılır. Standart olmayan kaynak yolu olan veya hiç yol içermeyen hizmetler için bunun yerine fromEndpoint kullanın. Not: Konak URI'sinde sorgu parametrelerine izin verilmez ve diğer API'ler tarafından ayarlanmalıdır. Not: fromHost ile yetkilendirme belirteci kullanmak için fromHost(URL) kullanın ve ardından oluşturulan BotFrameworkConfig örneğinde AuthorizationToken özelliğini ayarlayın. Not: Sürüm 1.15.0'a eklendi.

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

Parametreler

host

string | URL

BIR URL sağlanırsa, protokole sahip tam konak (örneğin wss://your.host.com:1234) kullanılır. Bir dize sağlanırsa, wss://{host}.convai.speech.azure.us eklenir.

subscriptionKey

string

Abonelik anahtarı. Abonelik anahtarı belirtilmezse yetkilendirme belirteci ayarlanmalıdır.

botId

string

Opsiyonel. Azure kaynak grubu içinde belirli bir botu kullanmaya yönelik tanımlayıcı. Kaynak adına eşdeğerdir.

Döndürülenler

BotFrameworkConfig

Yeni bir bot çerçevesi yapılandırma örneği.

fromSubscription(string, string, string)

Sağlanan abonelik bilgileriyle bir bot çerçevesi yapılandırma örneği oluşturur.

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

Parametreler

subscription

string

Botla ilişkili abonelik anahtarı

region

string

Bölge adı (bölge sayfasına bakın).

botId

string

Opsiyonel. Azure kaynak grubu içinde belirli bir botu kullanmaya yönelik tanımlayıcı. Kaynak adına eşdeğerdir.

Döndürülenler

BotFrameworkConfig

Yeni bir bot çerçevesi yapılandırma örneği.

Devralınan Yöntemin Ayrıntıları

close()

İlişkili kaynakları at.

function close()

DialogServiceConfigImpl.close Devralındı

getProperty(string | PropertyId, string)

Adlandırılmış özelliği değer olarak ayarlar

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

Parametreler

name

string | PropertyId

Alınacak özellik.

def

string

Özelliğin bilinmemesi durumunda döndürülecek varsayılan değer.

Döndürülenler

string

Verilen özelliğin geçerli değeri veya sağlanan varsayılan değeri.

DialogServiceConfigImpl.getProperty'den Devralınan

setProperty(string | PropertyId, string)

Adlandırılmış özelliği değer olarak ayarlar

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

Parametreler

name

string | PropertyId

Ayarlanacağı özellik.

value

string

Değer.

DialogServiceConfigImpl.setProperty'den Devralınan

setProxy(string, number, string, string)

Ara sunucu yapılandırmasını ayarlar. Yalnızca Node.js ortamlarda geçerlidir. Sürüm 1.4.0'a eklendi.

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

Parametreler

proxyHostName

string

Protokol şeması olmadan ara sunucunun ana bilgisayar adı (http://)

proxyPort

number

Ara sunucunun bağlantı noktası numarası.

proxyUserName

string

Ara sunucunun kullanıcı adı.

proxyPassword

string

Proxy sunucusunun parolası.

DialogServiceConfigImpl.setProxy'den Devralınmış

setServiceProperty(string, string, UriQueryParameter)

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

Parametreler

name

string

value

string

channel

UriQueryParameter

DialogServiceConfigImpl.setServiceProperty'den Devralınmış