Поделиться через

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

Методы

close()

Закрывает конфигурацию.
enableAudioLogging()

Включение ведения журнала звука в службе. Журналы звука и содержимого хранятся в хранилище майкрософт или в собственной учетной записи хранения, связанной с подпиской Cognitive Services (перенос ресурса службы "Речь" с поддержкой byOS). Журналы будут удалены через 30 дней. Добавлено в версию 1.7.0.
enableDictation()

Включите диктовку. Поддерживается только в непрерывном распознавании речи. Добавлено в версию 1.7.0.
fromAuthorizationToken(string, string)

Создает экземпляр фабрики речи с указанным начальным маркером авторизации и регионом. Примечание. Вызывающий объект должен убедиться, что маркер авторизации действителен. Прежде чем срок действия маркера авторизации истекает, вызывающий объект должен обновить его, вызвав этот метод задания с новым допустимым маркером. Примечание. Используйте маркер, производный от ключа подписки LanguageUnderstanding, если вы хотите использовать распознаватель намерений. Так как значения конфигурации копируются при создании распознавателя, новое значение маркера не будет применяться к распознавателям, которые уже созданы. Для распознавателей, созданных ранее, необходимо задать маркер авторизации соответствующего распознавателя для обновления маркера. В противном случае распознаватели будут сталкиваться с ошибками во время распознавания.
fromEndpoint(URL, string)

Создает экземпляр конфигурации речи с указанной конечной точкой и ключом подписки. Этот метод предназначен только для пользователей, использующих нестандартную конечную точку или параметры службы. Примечание. Используйте ключ подписки LanguageUnderstanding, если вы хотите использовать распознаватель намерений. Примечание. Параметры запроса, указанные в URL-адресе конечной точки, не изменяются, даже если они задаются другими API. Например, если язык определен в URI в качестве параметра запроса "language=de-DE", а также задан speechConfig.speechRecognitionLanguage = "en-US", параметр языка в URI имеет приоритет, а эффективный язык — "de-DE". Можно задать только параметры, не указанные в URL-адресе конечной точки, другими API. Примечание. Чтобы использовать маркер авторизации с помощью FromEndpoint, передайте пустую строку в subscriptionKey в методе fromEndpoint, а затем задайте authorizationToken="token" в созданном экземпляре SpeechConfig для использования маркера авторизации.
fromHost(URL, string)

Создает экземпляр конфигурации речи с указанным ключом узла и подписки. Этот метод предназначен только для пользователей, использующих узел службы, отличный от по умолчанию. Предполагается стандартный путь к ресурсу. Для служб с нестандартным путем к ресурсу или без пути вообще используйте fromEndpoint. Примечание. Параметры запроса не допускаются в URI узла и должны быть заданы другими API. Примечание. Чтобы использовать маркер авторизации с fromHost, используйте fromHost(URL), а затем задайте свойство AuthorizationToken в созданном экземпляре SpeechConfig. Примечание. Добавлено в версию 1.9.0.
fromSubscription(string, string)

Статический экземпляр SpeechConfig, возвращаемый путем передачи subscriptionKey и региона службы. Примечание. Используйте ключ подписки LanguageUnderstanding, если вы хотите использовать распознаватель намерений.
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

Ключ подписки, заданный в конфигурации.

Сведения о методе

close()

Закрывает конфигурацию.

function close()

enableAudioLogging()

Включение ведения журнала звука в службе. Журналы звука и содержимого хранятся в хранилище майкрософт или в собственной учетной записи хранения, связанной с подпиской Cognitive Services (перенос ресурса службы "Речь" с поддержкой byOS). Журналы будут удалены через 30 дней. Добавлено в версию 1.7.0.

function enableAudioLogging()

enableDictation()

Включите диктовку. Поддерживается только в непрерывном распознавании речи. Добавлено в версию 1.7.0.

function enableDictation()

fromAuthorizationToken(string, string)

Создает экземпляр фабрики речи с указанным начальным маркером авторизации и регионом. Примечание. Вызывающий объект должен убедиться, что маркер авторизации действителен. Прежде чем срок действия маркера авторизации истекает, вызывающий объект должен обновить его, вызвав этот метод задания с новым допустимым маркером. Примечание. Используйте маркер, производный от ключа подписки LanguageUnderstanding, если вы хотите использовать распознаватель намерений. Так как значения конфигурации копируются при создании распознавателя, новое значение маркера не будет применяться к распознавателям, которые уже созданы. Для распознавателей, созданных ранее, необходимо задать маркер авторизации соответствующего распознавателя для обновления маркера. В противном случае распознаватели будут сталкиваться с ошибками во время распознавания.

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

Параметры

authorizationToken

string

Начальный маркер авторизации.

region

string

Имя региона (см. страницу региона).

Возвращаемое значение

SpeechConfig

Экземпляр фабрики речи.

fromEndpoint(URL, string)

Создает экземпляр конфигурации речи с указанной конечной точкой и ключом подписки. Этот метод предназначен только для пользователей, использующих нестандартную конечную точку или параметры службы. Примечание. Используйте ключ подписки LanguageUnderstanding, если вы хотите использовать распознаватель намерений. Примечание. Параметры запроса, указанные в URL-адресе конечной точки, не изменяются, даже если они задаются другими API. Например, если язык определен в URI в качестве параметра запроса "language=de-DE", а также задан speechConfig.speechRecognitionLanguage = "en-US", параметр языка в URI имеет приоритет, а эффективный язык — "de-DE". Можно задать только параметры, не указанные в URL-адресе конечной точки, другими API. Примечание. Чтобы использовать маркер авторизации с помощью FromEndpoint, передайте пустую строку в subscriptionKey в методе fromEndpoint, а затем задайте authorizationToken="token" в созданном экземпляре SpeechConfig для использования маркера авторизации.

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

Параметры

endpoint

URL

Конечная точка службы для подключения.

subscriptionKey

string

Ключ подписки. Если ключ подписки не указан, необходимо задать маркер авторизации.

Возвращаемое значение

SpeechConfig

Экземпляр фабрики речи.

fromHost(URL, string)

Создает экземпляр конфигурации речи с указанным ключом узла и подписки. Этот метод предназначен только для пользователей, использующих узел службы, отличный от по умолчанию. Предполагается стандартный путь к ресурсу. Для служб с нестандартным путем к ресурсу или без пути вообще используйте fromEndpoint. Примечание. Параметры запроса не допускаются в URI узла и должны быть заданы другими API. Примечание. Чтобы использовать маркер авторизации с 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 и региона службы. Примечание. Используйте ключ подписки LanguageUnderstanding, если вы хотите использовать распознаватель намерений.

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