BotFrameworkConfig class

Paket:

microsoft-cognitiveservices-speech-sdk

Bot Framework arka ucu kullanmaya yönelik iletişim kutusu hizmeti bağlayıcı nesnesi yapılandırmalarını tanımlayan sınıf.

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 bir 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. Yapılandırma nesnelerinin içeriği bağlayıcılar oluşturulduğunda kopyalanır, bu nedenle DialogServiceConnector'da authorizationToken ayarı özgün yapılandırmanın yetkilendirme belirtecini güncelleştirmez. Daha fazla DialogServiceConnector oluşturmak için kullanılacaksa yeni bir yapılandırma örneği oluşturun veya 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 ayarlansalar bile değiştirilmez. Not: FromEndpoint ile yetkilendirme belirtecini kullanmak için fromEndpoint yönteminde subscriptionKey öğesine boş bir dize geçirin ve ardından oluşturulan BotFrameworkConfig örneğinde authorizationToken="token" değerini yetkilendirme belirtecini kullanacak şekilde ayarlayın. Not: Sürüm 1.15.0'da 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ç yolu olmayan 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'da 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'da 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 bir 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. Yapılandırma nesnelerinin içeriği bağlayıcılar oluşturulduğunda kopyalanır, bu nedenle DialogServiceConnector'da authorizationToken ayarı özgün yapılandırmanın yetkilendirme belirtecini güncelleştirmez. Daha fazla DialogServiceConnector oluşturmak için kullanılacaksa yeni bir yapılandırma örneği oluşturun veya 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şkili yetkilendirme belirteci

region

string

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

botId

string

İsteğe bağlı. 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 ayarlansalar bile değiştirilmez. Not: FromEndpoint ile yetkilendirme belirtecini kullanmak için fromEndpoint yönteminde subscriptionKey öğesine boş bir dize geçirin ve ardından oluşturulan BotFrameworkConfig örneğinde authorizationToken="token" değerini yetkilendirme belirtecini kullanacak şekilde ayarlayın. Not: Sürüm 1.15.0'da 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ç yolu olmayan 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'da 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 içine eklenir.

subscriptionKey

string

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

botId

string

İsteğe bağlı. 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

İsteğe bağlı. 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()

Devralınan DialogServiceConfigImpl.close

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.

Devralınan DialogServiceConfigImpl.getProperty

setProperty(string | PropertyId, string)

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

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

Parametreler

name

string | PropertyId

Ayarlanacak özellik.

value

string

Değer.

Devralınan DialogServiceConfigImpl.setProperty

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'da 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

Proxy sunucusunun kullanıcı adı.

proxyPassword

string

Proxy sunucusunun parolası.

Devralınan DialogServiceConfigImpl.setProxy

setServiceProperty(string, string, UriQueryParameter)

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

Parametreler

name

string

value

string

channel

UriQueryParameter

Devralınan DialogServiceConfigImpl.setServiceProperty