SpeechTranslationConfig class

  • Ссылка
Пакет:
microsoft-cognitiveservices-speech-sdk

Конфигурация перевода речи.

Extends
SpeechConfig

Свойства

authorizationToken

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

Возвращает идентификатор конечной точки настраиваемой модели речи, используемой для распознавания речи.
outputFormat

Возвращает формат выходных данных распознавания речи (простой или подробный). Примечание. Этот формат выходных данных предназначен для результатов распознавания речи. Используйте [SpeechConfig.speechSynthesisOutputFormat], чтобы получить формат синтезированного аудиовыхода.
region
speechRecognitionLanguage

Возвращает или задает язык распознавания речи.
speechSynthesisLanguage

Возвращает язык синтезатора речи. Добавлено в версии 1.11.0.
speechSynthesisOutputFormat

Возвращает формат выходных данных синтеза речи. Добавлено в версии 1.11.0.
speechSynthesisVoiceName

Возвращает голос синтезатора речи. Добавлено в версии 1.11.0.
subscriptionKey
targetLanguages

Возвращает целевой язык (текст) для перевода.
voiceName

Возвращает выбранное имя голоса.

Методы

addTargetLanguage(string)

Добавьте целевой язык (текст) для перевода.
close()

Удалите связанные ресурсы.
fromAuthorizationToken(string, string)

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

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

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

Статический экземпляр SpeechTranslationConfig, возвращаемый путем передачи ключа подписки и региона службы.
setProperty(string | PropertyId, string)

Задает именованное свойство в качестве значения

Наследуемые методы

enableAudioLogging()

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

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

Возвращает текущее значение произвольного свойства.
requestWordLevelTimestamps()

Включает метки времени на уровне слов. Добавлено в версии 1.7.0.
setProfanity(ProfanityOption)

Задает параметр ненормативной лексики. Добавлено в версии 1.7.0.
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

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

void authorizationToken

Значение свойства

void

endpointId

Возвращает идентификатор конечной точки настраиваемой модели речи, используемой для распознавания речи.

string endpointId

Значение свойства

string

Идентификатор конечной точки

outputFormat

Возвращает формат выходных данных распознавания речи (простой или подробный). Примечание. Этот формат выходных данных предназначен для результатов распознавания речи. Используйте [SpeechConfig.speechSynthesisOutputFormat], чтобы получить формат синтезированного аудиовыхода.

OutputFormat outputFormat

Значение свойства

OutputFormat

Возвращает формат выходных данных.

region 

string region

Значение свойства

string

Регион, заданный в конфигурации.

speechRecognitionLanguage

Возвращает или задает язык распознавания речи.

void speechRecognitionLanguage

Значение свойства

void

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

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

targetLanguages

Возвращает целевой язык (текст) для перевода.

string[] targetLanguages

Значение свойства

string[]

voiceName

Возвращает выбранное имя голоса.

string voiceName

Значение свойства

string

Имя голоса.

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

addTargetLanguage(string)

Добавьте целевой язык (текст) для перевода.

function addTargetLanguage(value: string)

Параметры

value

string

Язык, например de-DE

close()

Удалите связанные ресурсы.

function close()

fromAuthorizationToken(string, string)

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

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

Параметры

authorizationToken

string

Маркер авторизации.

region

string

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

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

SpeechTranslationConfig

Конфигурация перевода речи.

fromEndpoint(URL, string)

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

static function fromEndpoint(endpoint: URL, subscriptionKey: string): SpeechTranslationConfig

Параметры

endpoint

URL

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

subscriptionKey

string

Ключ подписки.

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

SpeechTranslationConfig

Экземпляр конфигурации речи.

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)

Статический экземпляр SpeechTranslationConfig, возвращаемый путем передачи ключа подписки и региона службы.

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

Параметры

subscriptionKey

string

Ключ подписки.

region

string

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

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

SpeechTranslationConfig

Конфигурация перевода речи.

setProperty(string | PropertyId, string)

Задает именованное свойство в качестве значения

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

Параметры

name

string | PropertyId

Имя задаваемого свойства.

value

string

Новое значение свойства.

Сведения о наследуемом методе

enableAudioLogging()

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

function enableAudioLogging()

Наследуется отSpeechConfig.enableAudioLogging

enableDictation()

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

function enableDictation()

Наследуется отSpeechConfig.enableDictation

getProperty(string, string)

Возвращает текущее значение произвольного свойства.

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

Параметры

name

string

Имя свойства для запроса.

def

string

Значение, возвращаемое в случае, если свойство неизвестно.

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

string

Текущее значение (по умолчанию) заданного свойства.

Наследуется отSpeechConfig.getProperty

requestWordLevelTimestamps()

Включает метки времени на уровне слов. Добавлено в версии 1.7.0.

function requestWordLevelTimestamps()

Наследуется отSpeechConfig.requestWordLevelTimestamps

setProfanity(ProfanityOption)

Задает параметр ненормативной лексики. Добавлено в версии 1.7.0.

function setProfanity(profanity: ProfanityOption)

Параметры

profanity
ProfanityOption

Наследуется отSpeechConfig.setProfanity

setProxy(string, number)

Задает конфигурацию прокси-сервера. Применимо только в Node.js средах. Добавлено в версии 1.4.0.

function setProxy(proxyHostName: string, proxyPort: number)

Параметры

proxyHostName

string

Имя узла прокси-сервера.

proxyPort

number

Номер порта прокси-сервера.

Наследуется отSpeechConfig.setProxy

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

Пароль прокси-сервера.

Наследуется отSpeechConfig.setProxy

setServiceProperty(string, string, UriQueryParameter)

Задает значение свойства, которое будет передано службе по указанному каналу. Добавлено в версии 1.7.0.

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

Параметры

name

string

value

string

channel
UriQueryParameter

Наследуется отSpeechConfig.setServiceProperty