BotFrameworkConfig class

الحزمة:

microsoft-cognitiveservices-speech-sdk

الفئة التي تحدد تكوينات كائن موصل خدمة مربع الحوار لاستخدام الواجهة الخلفية ل Bot Framework.

يمتد

DialogServiceConfigImpl

المنشئون

BotFrameworkConfig()

إنشاء مثيل BotFrameworkConfig.

الخصائص

applicationId	تعيين معرف تطبيق الواجهة الخلفية المقابل.
DialogTypes
outputFormat
properties	يوفر الوصول إلى الخصائص المخصصة.
speechRecognitionLanguage	الحصول على لغة التعرف على الكلام.

الأساليب

fromAuthorizationToken(string, string, string)	إنشاء مثيل تكوين إطار عمل روبوت للرمز المميز للتخويل المحدد والمنطقة. ملاحظة: يجب على المتصل التأكد من صحة رمز التخويل المميز. قبل انتهاء صلاحية رمز التخويل المميز، يجب على المتصل تحديثه عن طريق تعيين الخاصية authorizationToken على مثيل DialogServiceConnector المطابق الذي تم إنشاؤه باستخدام هذا التكوين. يتم نسخ محتويات كائنات التكوين عند إنشاء الموصلات، لذلك لن يؤدي تعيين authorizationToken على DialogServiceConnector إلى تحديث رمز التخويل المميز للتكوين الأصلي. إنشاء مثيل تكوين جديد أو تعيين الخاصية SpeechServiceAuthorization_Token لتحديث مثيل موجود إذا كان سيتم استخدامه لإنشاء DialogServiceConnectors إضافية.
fromEndpoint(URL, string)	إنشاء مثيل BotFrameworkConfig. هذا الأسلوب مخصص فقط للمستخدمين الذين يستخدمون نقطة نهاية خدمة غير قياسية أو معلمات. ملاحظة: لا يتم تغيير معلمات الاستعلام المحددة في عنوان URL لنقطة النهاية، حتى إذا تم تعيينها بواسطة أي واجهات برمجة تطبيقات أخرى. ملاحظة: لاستخدام رمز التخويل المميز مع fromEndpoint، مرر سلسلة فارغة إلى subscriptionKey في أسلوب fromEndpoint، ثم قم بتعيين authorizationToken="token" على مثيل BotFrameworkConfig الذي تم إنشاؤه لاستخدام رمز التخويل المميز. ملاحظة: تمت إضافته في الإصدار 1.15.0.
fromHost(string | URL, string, string)	إنشاء مثيل BotFrameworkConfig. هذا الأسلوب مخصص فقط للمستخدمين الذين يستخدمون مضيف خدمة غير افتراضي. سيتم افتراض مسار المورد القياسي. بالنسبة للخدمات ذات مسار مورد غير قياسي أو لا يوجد مسار على الإطلاق، استخدم منEndpoint بدلا من ذلك. ملاحظة: معلمات الاستعلام غير مسموح بها في URI المضيف ويجب تعيينها بواسطة واجهات برمجة التطبيقات الأخرى. ملاحظة: لاستخدام رمز تخويل مميز مع fromHost، استخدم fromHost(URL) ثم قم بتعيين الخاصية AuthorizationToken على مثيل BotFrameworkConfig الذي تم إنشاؤه. ملاحظة: تمت إضافته في الإصدار 1.15.0.
fromSubscription(string, string, string)	إنشاء مثيل تكوين إطار عمل روبوت مع معلومات الاشتراك المقدمة.

الأساليب المتوارثة

close()	التخلص من الموارد المقترنة.
getProperty(string | PropertyId, string)	تعيين خاصية مسماة كقيمة
setProperty(string | PropertyId, string)	تعيين خاصية مسماة كقيمة
setProxy(string, number, string, string)	تعيين تكوين الوكيل. ذات صلة فقط في بيئات Node.js. تمت الإضافة في الإصدار 1.4.0.
setServiceProperty(string, string, UriQueryParameter)

تفاصيل المنشئ

BotFrameworkConfig()

إنشاء مثيل BotFrameworkConfig.

new BotFrameworkConfig()

تفاصيل الخاصية

applicationId

تعيين معرف تطبيق الواجهة الخلفية المقابل.

void applicationId

قيمة الخاصية

void

DialogTypes

static { BotFramework: string, CustomCommands: string } DialogTypes

قيمة الخاصية

{ BotFramework: string, CustomCommands: string }

outputFormat

OutputFormat outputFormat

قيمة الخاصية

OutputFormat

properties

يوفر الوصول إلى الخصائص المخصصة.

PropertyCollection properties

قيمة الخاصية

PropertyCollection

الخصائص.

speechRecognitionLanguage

الحصول على لغة التعرف على الكلام.

string speechRecognitionLanguage

قيمة الخاصية

string

تفاصيل الأسلوب

fromAuthorizationToken(string, string, string)

إنشاء مثيل تكوين إطار عمل روبوت للرمز المميز للتخويل المحدد والمنطقة. ملاحظة: يجب على المتصل التأكد من صحة رمز التخويل المميز. قبل انتهاء صلاحية رمز التخويل المميز، يجب على المتصل تحديثه عن طريق تعيين الخاصية authorizationToken على مثيل DialogServiceConnector المطابق الذي تم إنشاؤه باستخدام هذا التكوين. يتم نسخ محتويات كائنات التكوين عند إنشاء الموصلات، لذلك لن يؤدي تعيين authorizationToken على DialogServiceConnector إلى تحديث رمز التخويل المميز للتكوين الأصلي. إنشاء مثيل تكوين جديد أو تعيين الخاصية SpeechServiceAuthorization_Token لتحديث مثيل موجود إذا كان سيتم استخدامه لإنشاء DialogServiceConnectors إضافية.

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

المعلمات

authorizationToken

string

رمز التخويل المقترن بالروبوت

region

string

اسم المنطقة (راجع صفحة المنطقة ).

botId

string

اختياري. معرف لاستخدام روبوت معين داخل مجموعة موارد Azure. مكافئ لاسم المورد.

المرتجعات

BotFrameworkConfig

مثيل تكوين إطار عمل روبوت جديد.

fromEndpoint(URL, string)

إنشاء مثيل BotFrameworkConfig. هذا الأسلوب مخصص فقط للمستخدمين الذين يستخدمون نقطة نهاية خدمة غير قياسية أو معلمات. ملاحظة: لا يتم تغيير معلمات الاستعلام المحددة في عنوان URL لنقطة النهاية، حتى إذا تم تعيينها بواسطة أي واجهات برمجة تطبيقات أخرى. ملاحظة: لاستخدام رمز التخويل المميز مع fromEndpoint، مرر سلسلة فارغة إلى subscriptionKey في أسلوب fromEndpoint، ثم قم بتعيين authorizationToken="token" على مثيل BotFrameworkConfig الذي تم إنشاؤه لاستخدام رمز التخويل المميز. ملاحظة: تمت إضافته في الإصدار 1.15.0.

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

المعلمات

endpoint

URL

نقطة نهاية الخدمة للاتصال بها.

subscriptionKey

string

مفتاح الاشتراك. إذا لم يتم تحديد مفتاح اشتراك، يجب تعيين رمز مميز للتخويل.

المرتجعات

BotFrameworkConfig

• مثيل تكوين إطار عمل روبوت جديد باستخدام نقطة النهاية المتوفرة.

fromHost(string | URL, string, string)

إنشاء مثيل BotFrameworkConfig. هذا الأسلوب مخصص فقط للمستخدمين الذين يستخدمون مضيف خدمة غير افتراضي. سيتم افتراض مسار المورد القياسي. بالنسبة للخدمات ذات مسار مورد غير قياسي أو لا يوجد مسار على الإطلاق، استخدم منEndpoint بدلا من ذلك. ملاحظة: معلمات الاستعلام غير مسموح بها في URI المضيف ويجب تعيينها بواسطة واجهات برمجة التطبيقات الأخرى. ملاحظة: لاستخدام رمز تخويل مميز مع fromHost، استخدم fromHost(URL) ثم قم بتعيين الخاصية AuthorizationToken على مثيل BotFrameworkConfig الذي تم إنشاؤه. ملاحظة: تمت إضافته في الإصدار 1.15.0.

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

المعلمات

host

string | URL

إذا تم توفير عنوان URL، استخدام المضيف المؤهل بالكامل مع البروتوكول (على سبيل المثال، wss://your.host.com:1234). إذا تم توفير سلسلة، تضمينها في wss://{host}.convai.speech.azure.us.

subscriptionKey

string

مفتاح الاشتراك. إذا لم يتم تحديد مفتاح اشتراك، يجب تعيين رمز مميز للتخويل.

botId

string

اختياري. معرف لاستخدام روبوت معين داخل مجموعة موارد Azure. مكافئ لاسم المورد.

المرتجعات

BotFrameworkConfig

مثيل تكوين إطار عمل روبوت جديد.

fromSubscription(string, string, string)

إنشاء مثيل تكوين إطار عمل روبوت مع معلومات الاشتراك المقدمة.

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

المعلمات

subscription

string

مفتاح الاشتراك المرتبط بالروبوت

region

string

اسم المنطقة (راجع صفحة المنطقة ).

botId

string

اختياري. معرف لاستخدام روبوت معين داخل مجموعة موارد Azure. مكافئ لاسم المورد.

المرتجعات

BotFrameworkConfig

مثيل تكوين إطار عمل روبوت جديد.

تفاصيل الأساليب المتوارثة

close()

التخلص من الموارد المقترنة.

function close()

موروث من DialogServiceConfigImpl.close

getProperty(string | PropertyId, string)

تعيين خاصية مسماة كقيمة

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

المعلمات

name

string | PropertyId

الخاصية التي يجب الحصول عليها.

def

string

القيمة الافتراضية التي سيتم إرجاعها في حالة عدم معرفة الخاصية.

المرتجعات

string

القيمة الحالية أو الافتراضية المقدمة للخاصية المحددة.

موروث من DialogServiceConfigImpl.getProperty

setProperty(string | PropertyId, string)

تعيين خاصية مسماة كقيمة

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

المعلمات

name

string | PropertyId

الخاصية المراد تعيينها.

value

string

القيمة.

موروث من DialogServiceConfigImpl.setProperty

setProxy(string, number, string, string)

تعيين تكوين الوكيل. ذات صلة فقط في بيئات Node.js. تمت الإضافة في الإصدار 1.4.0.

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

المعلمات

proxyHostName

string

اسم المضيف للخادم الوكيل، دون نظام البروتوكول (http://)

proxyPort

number

رقم المنفذ للخادم الوكيل.

proxyUserName

string

اسم المستخدم للخادم الوكيل.

proxyPassword

string

كلمة مرور الخادم الوكيل.

موروث من DialogServiceConfigImpl.setProxy

setServiceProperty(string, string, UriQueryParameter)

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

المعلمات

name

string

value

string

channel

UriQueryParameter

موروث من DialogServiceConfigImpl.setServiceProperty