SpeechTranslationConfig class
Конфигурация перевода речи.
- Extends
Свойства
| authorization |
Возвращает или задает маркер авторизации. Примечание. Вызывающий объект должен убедиться, что маркер авторизации действителен. Прежде чем срок действия маркера авторизации истекает, вызывающий объект должен обновить его, вызвав этот метод задания с новым допустимым маркером. |
| endpoint |
Возвращает идентификатор конечной точки настраиваемой модели речи, которая используется для распознавания речи. |
| output |
Получает формат вывода распознавания речи (простой или подробный). Примечание. Этот формат выходных данных предназначен для результата распознавания речи, используйте [SpeechConfig.speechSynthesisOutputFormat], чтобы получить синтезированный формат вывода звука. |
| region | |
| speech |
Возвращает или задает язык распознавания речи. |
| speech |
Получает язык синтезатора речи. Добавлено в версию 1.11.0. |
| speech |
Возвращает формат выходных данных синтеза речи. Добавлено в версию 1.11.0. |
| speech |
Получает голос синтезатора речи. Добавлено в версию 1.11.0. |
| subscription |
|
| target |
Получает целевой язык (текст) для перевода. |
| token |
Получает экземпляр TokenCredential, если он настроен. Доступно только при использовании аутентификации на основе AAD через TokenCredential. |
| voice |
Возвращает выбранное имя голоса. |
Методы
| add |
Добавьте (текст) целевой язык для перевода. |
| close() | Удаление связанных ресурсов. |
| from |
Статический экземпляр SpeechTranslationConfig, возвращаемый путем передачи маркера авторизации и региона службы. Примечание. Вызывающий объект должен убедиться, что маркер авторизации действителен. Перед истечением срока действия маркера авторизации вызывающий объект должен обновить его, задав авторизацию свойстваToken новым допустимым маркером. В противном случае все распознаватели, созданные этим экземпляром SpeechTranslationConfig, будут сталкиваться с ошибками во время распознавания. Так как значения конфигурации копируются при создании распознавателя, новое значение маркера не будет применяться к распознавателям, которые уже созданы. Для распознавателей, созданных ранее, необходимо задать маркер авторизации соответствующего распознавателя для обновления маркера. В противном случае распознаватели будут сталкиваться с ошибками во время распознавания. |
| from |
Создает экземпляр конфигурации перевода речи с пользовательской конечной точкой и учетными данными. Параметры запроса, указанные в URI конечной точки, не изменяются, даже если они задаются любым другим вызовом API. Например, если язык распознавания определен в параметре запроса URI как "language=de-DE", а свойство SpeechRecognitionLanguage установлено на "en-US", язык, установленный в URI, имеет приоритет, а "de-DE" остается ожидаемым языком. Так как параметры, включенные в URI конечной точки, имеют приоритет, другие API могут задавать только те параметры, которые не указаны в URI конечной точки. Поддерживаемые типы учетных данных:
|
| from |
Создает экземпляр конфигурации перевода речи с указанным ключом конечной точки и подписки. Этот метод предназначен только для пользователей, использующих нестандартную конечную точку службы или параметризаторы. Примечание. Свойства запроса, указанные в URL-адресе конечной точки, не изменяются, даже если они задаются любыми другими API. Например, если язык определен в URI в качестве параметра запроса "language=de-DE", а также задан свойством speechRecognitionLanguage, параметр языка в URI имеет приоритет, а эффективный язык — "de-DE". Можно задать только свойства, не указанные в URL-адресе конечной точки, другими API. Примечание. Чтобы использовать маркер авторизации с помощью FromEndpoint, передайте пустую строку в subscriptionKey в методе fromEndpoint, а затем задайте authorizationToken="token" в созданном экземпляре SpeechConfig для использования маркера авторизации. |
| from |
Создает экземпляр конфигурации речи с указанным ключом узла и подписки. Этот метод предназначен только для пользователей, использующих узел службы, отличный от по умолчанию. Предполагается стандартный путь к ресурсу. Для служб с нестандартным путем к ресурсу или без пути вообще используйте fromEndpoint. Примечание. Параметры запроса не допускаются в URI узла и должны быть заданы другими API. Примечание. Чтобы использовать маркер авторизации с fromHost, используйте fromHost(URL), а затем задайте свойство AuthorizationToken в созданном экземпляре SpeechConfig. Примечание. Добавлено в версию 1.9.0. |
| from |
Статический экземпляр SpeechTranslationConfig, возвращенный путем передачи ключа подписки и региона службы. |
| set |
Задает именованное свойство в качестве значения |
Наследуемые методы
| enable |
Включение ведения журнала звука в службе. Журналы звука и содержимого хранятся в хранилище майкрософт или в собственной учетной записи хранения, связанной с подпиской Cognitive Services (перенос ресурса службы "Речь" с поддержкой byOS). Журналы будут удалены через 30 дней. Добавлено в версию 1.7.0. |
| enable |
Включите диктовку. Поддерживается только в непрерывном распознавании речи. Добавлено в версию 1.7.0. |
| get |
Возвращает текущее значение произвольного свойства. |
| request |
Включает метки времени на уровне слова. Добавлено в версию 1.7.0. |
| set |
Задает параметр ненормативной лексики. Добавлено в версию 1.7.0. |
| set |
Задает конфигурацию прокси-сервера. Применимо только в средах Node.js. Добавлено в версию 1.4.0. |
| set |
Задает конфигурацию прокси-сервера. Применимо только в средах Node.js. Добавлено в версию 1.4.0. |
| set |
Задает значение свойства, которое будет передано в службу с помощью указанного канала. Добавлено в версию 1.7.0. |
Сведения о свойстве
authorizationToken
Возвращает или задает маркер авторизации. Примечание. Вызывающий объект должен убедиться, что маркер авторизации действителен. Прежде чем срок действия маркера авторизации истекает, вызывающий объект должен обновить его, вызвав этот метод задания с новым допустимым маркером.
void authorizationToken
Значение свойства
void
endpointId
Возвращает идентификатор конечной точки настраиваемой модели речи, которая используется для распознавания речи.
string endpointId
Значение свойства
string
Идентификатор конечной точки
outputFormat
Получает формат вывода распознавания речи (простой или подробный). Примечание. Этот формат выходных данных предназначен для результата распознавания речи, используйте [SpeechConfig.speechSynthesisOutputFormat], чтобы получить синтезированный формат вывода звука.
OutputFormat outputFormat
Значение свойства
Возвращает выходной формат.
region
string region
Значение свойства
string
Регион, заданный в конфигурации.
speechRecognitionLanguage
Возвращает или задает язык распознавания речи.
void speechRecognitionLanguage
Значение свойства
void
speechSynthesisLanguage
Получает язык синтезатора речи. Добавлено в версию 1.11.0.
string speechSynthesisLanguage
Значение свойства
string
Возвращает язык синтеза речи.
speechSynthesisOutputFormat
Возвращает формат выходных данных синтеза речи. Добавлено в версию 1.11.0.
SpeechSynthesisOutputFormat speechSynthesisOutputFormat
Значение свойства
Возвращает формат выходных данных синтеза речи
speechSynthesisVoiceName
Получает голос синтезатора речи. Добавлено в версию 1.11.0.
string speechSynthesisVoiceName
Значение свойства
string
Возвращает голос синтеза речи.
subscriptionKey
string subscriptionKey
Значение свойства
string
Ключ подписки, заданный в конфигурации.
targetLanguages
Получает целевой язык (текст) для перевода.
string[] targetLanguages
Значение свойства
string[]
tokenCredential
Получает экземпляр TokenCredential, если он настроен. Доступно только при использовании аутентификации на основе AAD через TokenCredential.
any tokenCredential
Значение свойства
any
voiceName
Возвращает выбранное имя голоса.
string voiceName
Значение свойства
string
Имя голоса.
Сведения о методе
addTargetLanguage(string)
Добавьте (текст) целевой язык для перевода.
function addTargetLanguage(value: string)
Параметры
- value
-
string
Язык, например de-DE
close()
Удаление связанных ресурсов.
function close()
fromAuthorizationToken(string, string)
Статический экземпляр SpeechTranslationConfig, возвращаемый путем передачи маркера авторизации и региона службы. Примечание. Вызывающий объект должен убедиться, что маркер авторизации действителен. Перед истечением срока действия маркера авторизации вызывающий объект должен обновить его, задав авторизацию свойстваToken новым допустимым маркером. В противном случае все распознаватели, созданные этим экземпляром SpeechTranslationConfig, будут сталкиваться с ошибками во время распознавания. Так как значения конфигурации копируются при создании распознавателя, новое значение маркера не будет применяться к распознавателям, которые уже созданы. Для распознавателей, созданных ранее, необходимо задать маркер авторизации соответствующего распознавателя для обновления маркера. В противном случае распознаватели будут сталкиваться с ошибками во время распознавания.
static function fromAuthorizationToken(authorizationToken: string, region: string): SpeechTranslationConfig
Параметры
- authorizationToken
-
string
Маркер авторизации.
- region
-
string
Название региона (см. страницу региона).
Возвращаемое значение
Конфигурация перевода речи.
fromEndpoint(URL, any)
Создает экземпляр конфигурации перевода речи с пользовательской конечной точкой и учетными данными. Параметры запроса, указанные в URI конечной точки, не изменяются, даже если они задаются любым другим вызовом API. Например, если язык распознавания определен в параметре запроса URI как "language=de-DE", а свойство SpeechRecognitionLanguage установлено на "en-US", язык, установленный в URI, имеет приоритет, а "de-DE" остается ожидаемым языком. Так как параметры, включенные в URI конечной точки, имеют приоритет, другие API могут задавать только те параметры, которые не указаны в URI конечной точки. Поддерживаемые типы учетных данных:
- KeyCredential: для аутентификации на основе ключа API.
- TokenCredential: для проверки подлинности на основе Azure AD. Примечание. Чтобы использовать маркер авторизации с помощью FromEndpoint, передайте пустую строку в subscriptionKey в методе fromEndpoint, а затем задайте authorizationToken="token" в созданном экземпляре SpeechConfig для использования маркера авторизации.
static function fromEndpoint(endpoint: URL, credential: any): SpeechTranslationConfig
Параметры
- endpoint
-
URL
Конечная точка службы для подключения.
- credential
-
any
Учетные данные, используемые для аутентификации.
Возвращаемое значение
Экземпляр фабрики речи.
fromEndpoint(URL, string)
Создает экземпляр конфигурации перевода речи с указанным ключом конечной точки и подписки. Этот метод предназначен только для пользователей, использующих нестандартную конечную точку службы или параметризаторы. Примечание. Свойства запроса, указанные в URL-адресе конечной точки, не изменяются, даже если они задаются любыми другими API. Например, если язык определен в URI в качестве параметра запроса "language=de-DE", а также задан свойством speechRecognitionLanguage, параметр языка в URI имеет приоритет, а эффективный язык — "de-DE". Можно задать только свойства, не указанные в URL-адресе конечной точки, другими API. Примечание. Чтобы использовать маркер авторизации с помощью FromEndpoint, передайте пустую строку в subscriptionKey в методе fromEndpoint, а затем задайте authorizationToken="token" в созданном экземпляре SpeechConfig для использования маркера авторизации.
static function fromEndpoint(endpoint: URL, subscriptionKey?: string): SpeechTranslationConfig
Параметры
- endpoint
-
URL
Конечная точка службы для подключения.
- subscriptionKey
-
string
Ключ подписки.
Возвращаемое значение
Экземпляр конфигурации перевода речи.
fromHost(URL, string)
Создает экземпляр конфигурации речи с указанным ключом узла и подписки. Этот метод предназначен только для пользователей, использующих узел службы, отличный от по умолчанию. Предполагается стандартный путь к ресурсу. Для служб с нестандартным путем к ресурсу или без пути вообще используйте fromEndpoint. Примечание. Параметры запроса не допускаются в URI узла и должны быть заданы другими API. Примечание. Чтобы использовать маркер авторизации с fromHost, используйте fromHost(URL), а затем задайте свойство AuthorizationToken в созданном экземпляре SpeechConfig. Примечание. Добавлено в версию 1.9.0.
static function fromHost(hostName: URL, subscriptionKey?: string): SpeechTranslationConfig
Параметры
- hostName
-
URL
- subscriptionKey
-
string
Ключ подписки. Если ключ подписки не указан, необходимо задать маркер авторизации.
Возвращаемое значение
Экземпляр фабрики речи.
fromSubscription(string, string)
Статический экземпляр SpeechTranslationConfig, возвращенный путем передачи ключа подписки и региона службы.
static function fromSubscription(subscriptionKey: string, region: string): SpeechTranslationConfig
Параметры
- subscriptionKey
-
string
Ключ подписки.
- region
-
string
Название региона (см. страницу региона).
Возвращаемое значение
Конфигурация перевода речи.
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