SpeechConfig class

الحزمة:

microsoft-cognitiveservices-speech-sdk

تكوين الكلام.

الخصائص

authorizationToken	الحصول على رمز التخويل المميز.
endpointId	يحصل على معرف نقطة النهاية لنموذج كلام مخصص يستخدم للتعرف على الكلام.
outputFormat	الحصول على تنسيق إخراج التعرف على الكلام (بسيط أو مفصل). ملاحظة: تنسيق الإخراج هذا مخصص لنتيجة التعرف على الكلام، استخدم [SpeechConfig.speechSynthesisOutputFormat] للحصول على تنسيق إخراج الصوت المركب.
region
speechRecognitionLanguage	إرجاع اللغة المكونة.
speechSynthesisLanguage	الحصول على لغة مزج الكلام. تمت الإضافة في الإصدار 1.11.0.
speechSynthesisOutputFormat	الحصول على تنسيق إخراج تركيب الكلام. تمت الإضافة في الإصدار 1.11.0.
speechSynthesisVoiceName	الحصول على صوت توليف الكلام. تمت الإضافة في الإصدار 1.11.0.
subscriptionKey
tokenCredential	يحصل على مثيل TokenCredential إذا تم تكوينه. متاح فقط في حالة استخدام المصادقة المستندة إلى AAD عبر TokenCredential.

الأساليب

close()	إغلاق التكوين.
enableAudioLogging()	تمكين تسجيل الصوت في الخدمة. يتم تخزين سجلات الصوت والمحتوى إما في التخزين المملوك ل Microsoft، أو في حساب التخزين الخاص بك المرتبط باشتراك الخدمات المعرفية (إنشاء مورد الكلام الممكن للتخزين الخاص بك (BYOS). ستتم إزالة السجلات بعد 30 يوما. تمت الإضافة في الإصدار 1.7.0.
enableDictation()	تمكين الإملاء. معتمد فقط في التعرف المستمر على الكلام. تمت الإضافة في الإصدار 1.7.0.
fromAuthorizationToken(string, string)	إنشاء مثيل لمصنع الكلام مع رمز تخويل أولي محدد والمنطقة. ملاحظة: يحتاج المتصل إلى التأكد من أن رمز التخويل المميز صالح. قبل انتهاء صلاحية الرمز المميز للتخويل، يحتاج المتصل إلى تحديثه عن طريق استدعاء هذا setter برمز مميز صالح جديد. ملاحظة: نظرا لأنه يتم نسخ قيم التكوين عند إنشاء أداة تعرف جديدة، فلن تنطبق قيمة الرمز المميز الجديدة على أدوات التعرف التي تم إنشاؤها بالفعل. بالنسبة إلى أدوات التعرف التي تم إنشاؤها من قبل، تحتاج إلى تعيين رمز التخويل المميز لأداة التعرف المقابلة لتحديث الرمز المميز. وإلا، ستواجه أدوات التعرف أخطاء أثناء التعرف.
fromEndpoint(URL, KeyCredential | TokenCredential)	ينشئ مثيل SpeechConfig مع نقطة نهاية مخصصة وبيانات اعتماد. لا يتم تغيير معلمات الاستعلام المحددة في عنوان URI لنقطة النهاية، حتى إذا تم تعيينها بواسطة أي استدعاء واجهة برمجة تطبيقات آخر. على سبيل المثال، إذا تم تعريف لغة التعرف في معلمة استعلام URI على أنها "language=de-DE"، وتم تعيين الخاصية SpeechRecognitionLanguage إلى "en-US"، فإن اللغة المعينة في URI لها الأسبقية، وتظل "de-DE" هي اللغة المتوقعة. نظرا لأن المعلمات المضمنة في عنوان URI لنقطة النهاية لها الأولوية، يمكن تعيين المعلمات التي لم يتم تحديدها في عنوان URI لنقطة النهاية فقط بواسطة واجهات برمجة التطبيقات الأخرى. أنواع بيانات الاعتماد المدعومة: KeyCredential: للمصادقة المستندة إلى مفتاح واجهة برمجة التطبيقات. TokenCredential: للمصادقة المستندة إلى Microsoft Azure Active Directory. ملاحظة: لاستخدام رمز التخويل المميز مع fromEndpoint، مرر سلسلة فارغة إلى subscriptionKey في أسلوب fromEndpoint، ثم قم بتعيين authorizationToken="token" على مثيل SpeechConfig الذي تم إنشاؤه لاستخدام رمز التخويل المميز.
fromEndpoint(URL, string)	إنشاء مثيل لتكوين الكلام بنقطة نهاية محددة ومفتاح اشتراك. هذا الأسلوب مخصص فقط للمستخدمين الذين يستخدمون نقطة نهاية خدمة غير قياسية أو معلمات. ملاحظة: لا يتم تغيير معلمات الاستعلام المحددة في عنوان URL لنقطة النهاية، حتى إذا تم تعيينها بواسطة أي واجهات برمجة تطبيقات أخرى. على سبيل المثال، إذا تم تعريف اللغة في uri كمعلمة استعلام "language=de-DE"، وتم تعيينها أيضا بواسطة SpeechConfig.speechRecognitionLanguage = "en-US"، فإن إعداد اللغة في uri له الأسبقية، واللغة الفعالة هي "de-DE". يمكن تعيين المعلمات غير المحددة في عنوان URL لنقطة النهاية فقط بواسطة واجهات برمجة التطبيقات الأخرى. ملاحظة: لاستخدام رمز التخويل المميز مع fromEndpoint، مرر سلسلة فارغة إلى subscriptionKey في أسلوب fromEndpoint، ثم قم بتعيين authorizationToken="token" على مثيل SpeechConfig الذي تم إنشاؤه لاستخدام رمز التخويل المميز.
fromHost(URL, string)	إنشاء مثيل لتكوين الكلام مع المضيف المحدد ومفتاح الاشتراك. هذا الأسلوب مخصص فقط للمستخدمين الذين يستخدمون مضيف خدمة غير افتراضي. سيتم افتراض مسار المورد القياسي. بالنسبة للخدمات ذات مسار مورد غير قياسي أو لا يوجد مسار على الإطلاق، استخدم منEndpoint بدلا من ذلك. ملاحظة: معلمات الاستعلام غير مسموح بها في URI المضيف ويجب تعيينها بواسطة واجهات برمجة التطبيقات الأخرى. ملاحظة: لاستخدام رمز تخويل مميز مع fromHost، استخدم fromHost(URL)، ثم قم بتعيين الخاصية AuthorizationToken على مثيل SpeechConfig الذي تم إنشاؤه. ملاحظة: تمت إضافته في الإصدار 1.9.0.
fromSubscription(string, string)	تم إرجاع مثيل ثابت من SpeechConfig عن طريق تمرير subscriptionKey ومنطقة الخدمة.
getProperty(string, string)	إرجاع القيمة الحالية لخاصية عشوائية.
requestWordLevelTimestamps()	يتضمن طوابع زمنية على مستوى الكلمات. تمت الإضافة في الإصدار 1.7.0.
setProfanity(ProfanityOption)	تعيين خيار الألفاظ النابية. تمت الإضافة في الإصدار 1.7.0.
setProperty(string | PropertyId, string)	تعيين خاصية عشوائية.
setProxy(string, number)	تعيين تكوين الوكيل. ذات صلة فقط في بيئات Node.js. تمت الإضافة في الإصدار 1.4.0.
setProxy(string, number, string, string)	تعيين تكوين الوكيل. ذات صلة فقط في بيئات Node.js. تمت الإضافة في الإصدار 1.4.0.
setServiceProperty(string, string, UriQueryParameter)	تعيين قيمة خاصية سيتم تمريرها إلى الخدمة باستخدام القناة المحددة. تمت الإضافة في الإصدار 1.7.0.

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

authorizationToken

الحصول على رمز التخويل المميز.

string authorizationToken

قيمة الخاصية

string

endpointId

يحصل على معرف نقطة النهاية لنموذج كلام مخصص يستخدم للتعرف على الكلام.

string endpointId

قيمة الخاصية

string

معرف نقطة النهاية

outputFormat

الحصول على تنسيق إخراج التعرف على الكلام (بسيط أو مفصل). ملاحظة: تنسيق الإخراج هذا مخصص لنتيجة التعرف على الكلام، استخدم [SpeechConfig.speechSynthesisOutputFormat] للحصول على تنسيق إخراج الصوت المركب.

OutputFormat outputFormat

قيمة الخاصية

OutputFormat

إرجاع تنسيق الإخراج.

region

string region

قيمة الخاصية

string

المنطقة المعينة على التكوين.

speechRecognitionLanguage

إرجاع اللغة المكونة.

string speechRecognitionLanguage

قيمة الخاصية

string

speechSynthesisLanguage

الحصول على لغة مزج الكلام. تمت الإضافة في الإصدار 1.11.0.

string speechSynthesisLanguage

قيمة الخاصية

string

إرجاع لغة تركيب الكلام.

speechSynthesisOutputFormat

الحصول على تنسيق إخراج تركيب الكلام. تمت الإضافة في الإصدار 1.11.0.

SpeechSynthesisOutputFormat speechSynthesisOutputFormat

قيمة الخاصية

SpeechSynthesisOutputFormat

إرجاع تنسيق إخراج تركيب الكلام

speechSynthesisVoiceName

الحصول على صوت توليف الكلام. تمت الإضافة في الإصدار 1.11.0.

string speechSynthesisVoiceName

قيمة الخاصية

string

إرجاع صوت تركيب الكلام.

subscriptionKey

string subscriptionKey

قيمة الخاصية

string

تم تعيين مفتاح الاشتراك على التكوين.

tokenCredential

يحصل على مثيل TokenCredential إذا تم تكوينه. متاح فقط في حالة استخدام المصادقة المستندة إلى AAD عبر TokenCredential.

undefined | TokenCredential tokenCredential

قيمة الخاصية

undefined | TokenCredential

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

close()

إغلاق التكوين.

function close()

enableAudioLogging()

تمكين تسجيل الصوت في الخدمة. يتم تخزين سجلات الصوت والمحتوى إما في التخزين المملوك ل Microsoft، أو في حساب التخزين الخاص بك المرتبط باشتراك الخدمات المعرفية (إنشاء مورد الكلام الممكن للتخزين الخاص بك (BYOS). ستتم إزالة السجلات بعد 30 يوما. تمت الإضافة في الإصدار 1.7.0.

function enableAudioLogging()

enableDictation()

تمكين الإملاء. معتمد فقط في التعرف المستمر على الكلام. تمت الإضافة في الإصدار 1.7.0.

function enableDictation()

fromAuthorizationToken(string, string)

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

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

المعلمات

authorizationToken

string

رمز التخويل المميز الأولي.

region

string

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

المرتجعات

SpeechConfig

مثيل مصنع الكلام.

fromEndpoint(URL, KeyCredential | TokenCredential)

ينشئ مثيل SpeechConfig مع نقطة نهاية مخصصة وبيانات اعتماد. لا يتم تغيير معلمات الاستعلام المحددة في عنوان URI لنقطة النهاية، حتى إذا تم تعيينها بواسطة أي استدعاء واجهة برمجة تطبيقات آخر. على سبيل المثال، إذا تم تعريف لغة التعرف في معلمة استعلام URI على أنها "language=de-DE"، وتم تعيين الخاصية SpeechRecognitionLanguage إلى "en-US"، فإن اللغة المعينة في URI لها الأسبقية، وتظل "de-DE" هي اللغة المتوقعة. نظرا لأن المعلمات المضمنة في عنوان URI لنقطة النهاية لها الأولوية، يمكن تعيين المعلمات التي لم يتم تحديدها في عنوان URI لنقطة النهاية فقط بواسطة واجهات برمجة التطبيقات الأخرى. أنواع بيانات الاعتماد المدعومة:

• KeyCredential: للمصادقة المستندة إلى مفتاح واجهة برمجة التطبيقات.
• TokenCredential: للمصادقة المستندة إلى Microsoft Azure Active Directory. ملاحظة: لاستخدام رمز التخويل المميز مع fromEndpoint، مرر سلسلة فارغة إلى subscriptionKey في أسلوب fromEndpoint، ثم قم بتعيين authorizationToken="token" على مثيل SpeechConfig الذي تم إنشاؤه لاستخدام رمز التخويل المميز.

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

المعلمات

endpoint

URL

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

credential

KeyCredential | TokenCredential

بيانات الاعتماد المستخدمة للمصادقة.

المرتجعات

SpeechConfig

مثيل مصنع الكلام.

fromEndpoint(URL, string)

إنشاء مثيل لتكوين الكلام بنقطة نهاية محددة ومفتاح اشتراك. هذا الأسلوب مخصص فقط للمستخدمين الذين يستخدمون نقطة نهاية خدمة غير قياسية أو معلمات. ملاحظة: لا يتم تغيير معلمات الاستعلام المحددة في عنوان URL لنقطة النهاية، حتى إذا تم تعيينها بواسطة أي واجهات برمجة تطبيقات أخرى. على سبيل المثال، إذا تم تعريف اللغة في uri كمعلمة استعلام "language=de-DE"، وتم تعيينها أيضا بواسطة SpeechConfig.speechRecognitionLanguage = "en-US"، فإن إعداد اللغة في uri له الأسبقية، واللغة الفعالة هي "de-DE". يمكن تعيين المعلمات غير المحددة في عنوان URL لنقطة النهاية فقط بواسطة واجهات برمجة التطبيقات الأخرى. ملاحظة: لاستخدام رمز التخويل المميز مع fromEndpoint، مرر سلسلة فارغة إلى subscriptionKey في أسلوب fromEndpoint، ثم قم بتعيين authorizationToken="token" على مثيل SpeechConfig الذي تم إنشاؤه لاستخدام رمز التخويل المميز.

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

المعلمات

endpoint

URL

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

subscriptionKey

string

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

المرتجعات

SpeechConfig

مثيل مصنع الكلام.

fromHost(URL, string)

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

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

المعلمات

hostName

URL

subscriptionKey

string

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

المرتجعات

SpeechConfig

مثيل مصنع الكلام.

fromSubscription(string, string)

تم إرجاع مثيل ثابت من SpeechConfig عن طريق تمرير subscriptionKey ومنطقة الخدمة.

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

المعلمات

subscriptionKey

string

مفتاح الاشتراك.

region

string

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

المرتجعات

SpeechConfig

مصنع الكلام

getProperty(string, string)

إرجاع القيمة الحالية لخاصية عشوائية.

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

المعلمات

name

string

اسم الخاصية للاستعلام.

def

string

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

المرتجعات

string

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

requestWordLevelTimestamps()

يتضمن طوابع زمنية على مستوى الكلمات. تمت الإضافة في الإصدار 1.7.0.

function requestWordLevelTimestamps()

setProfanity(ProfanityOption)

تعيين خيار الألفاظ النابية. تمت الإضافة في الإصدار 1.7.0.

function setProfanity(profanity: ProfanityOption)

المعلمات

profanity

ProfanityOption

setProperty(string | PropertyId, string)

تعيين خاصية عشوائية.

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

المعلمات

name

string | PropertyId

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

value

string

القيمة الجديدة للخاصية .

setProxy(string, number)

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

function setProxy(proxyHostName: string, proxyPort: number)

المعلمات

proxyHostName

string

اسم المضيف للخادم الوكيل.

proxyPort

number

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

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

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

setServiceProperty(string, string, UriQueryParameter)

تعيين قيمة خاصية سيتم تمريرها إلى الخدمة باستخدام القناة المحددة. تمت الإضافة في الإصدار 1.7.0.

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

المعلمات

name

string

value

string

channel

UriQueryParameter