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

class SpeechConfig

  • Статья

Класс, определяющий конфигурации для распознавания речи или намерения или синтеза речи.

Члены

EmbeddedSpeechConfig

Синтаксис: public friend EmbeddedSpeechConfig;

HybridSpeechConfig

Синтаксис: public friend HybridSpeechConfig;

оператор SPXSPEECHCONFIGHANDLE

Синтаксис: public inline explicit operator SPXSPEECHCONFIGHANDLE ( ) const;

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

Возвраты

Дескриптор.

SetSpeechRecognitionLanguage

Синтаксис: public inline void SetSpeechRecognitionLanguage ( const std::string & lang );

Задайте язык ввода распознаватель речи.

Параметры

  • lang Указывает имя языка, распознаваемого в формате BCP-47.

GetSpeechRecognitionLanguage

Синтаксис: public inline std::string GetSpeechRecognitionLanguage ( ) const;

Возвращает язык ввода для распознавания речи. Язык указан в формате BCP-47.

Возвраты

Язык распознавания речи.

SetSpeechSynthesisLanguage

Синтаксис: public inline void SetSpeechSynthesisLanguage ( const std::string & lang );

Задает язык синтезатора речи. Добавлено в версию 1.4.0.

Параметры

  • lang Указывает имя языка (например, en-US)

GetSpeechSynthesisLanguage

Синтаксис: public inline std::string GetSpeechSynthesisLanguage ( ) const;

Получает язык синтезатора речи. Добавлено в версию 1.4.0.

Возвраты

Язык синтеза речи.

SetSpeechSynthesisVoiceName

Синтаксис: public inline void SetSpeechSynthesisVoiceName ( const std::string & voiceName );

Задайте голос синтезатора речи. Добавлено в версию 1.4.0.

Параметры

  • voiceName Указывает имя голоса

GetSpeechSynthesisVoiceName

Синтаксис: public inline std::string GetSpeechSynthesisVoiceName ( ) const;

Получает голос синтезатора речи. Добавлено в версию 1.4.0.

Возвраты

Имя голоса синтеза речи.

SetSpeechSynthesisOutputFormat

Синтаксис: public inline void SetSpeechSynthesisOutputFormat ( SpeechSynthesisOutputFormat formatId );

Задает формат выходных данных синтеза речи (например, Riff16Khz16BitMonoPcm). Добавлено в версию 1.4.0.

Параметры

  • formatId Указывает идентификатор выходного формата

GetSpeechSynthesisOutputFormat

Синтаксис: public inline std::string GetSpeechSynthesisOutputFormat ( ) const;

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

Возвраты

Формат выходных данных синтеза речи.

SetEndpointId

Синтаксис: public inline void SetEndpointId ( const std::string & endpointId );

Задает идентификатор конечной точки пользовательской речи или пользовательского голоса.

Параметры

  • endpointId идентификатор конечной точки.

GetEndpointId

Синтаксис: public inline std::string GetEndpointId ( ) const;

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

Возвраты

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

SetAuthorizationToken

Синтаксис: public inline void SetAuthorizationToken ( const std::string & token );

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

Параметры

  • token маркер авторизации.

GetAuthorizationToken

Синтаксис: public inline std::string GetAuthorizationToken ( ) const;

Возвращает маркер авторизации для подключения к службе.

Возвраты

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

GetSubscriptionKey

Синтаксис: public inline std::string GetSubscriptionKey ( ) const;

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

Возвраты

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

GetRegion

Синтаксис: public inline std::string GetRegion ( ) const;

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

Возвраты

Область.

GetOutputFormat

Синтаксис: public inline OutputFormat GetOutputFormat ( ) const;

Получает формат вывода распознавания речи (простой или подробный). Примечание. Этот формат выходных данных предназначен для результата распознавания речи, используйте SpeechConfig::GetSpeechSynthesisOutputFormat для получения синтезированного формата вывода звука.

Возвраты

Формат выходных данных распознавания речи.

SetOutputFormat

Синтаксис: public inline void SetOutputFormat ( OutputFormat format );

Задает формат вывода распознавания речи (простой или подробный). Примечание. Этот формат выходных данных предназначен для результата распознавания речи, используйте SpeechConfig::SetSpeechSynthesisOutputFormat для задания синтезированного формата вывода звука.

Параметры

  • формат вывода распознавания речи format

SetProfanity

Синтаксис: public inline void SetProfanity ( ProfanityOption profanity );

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

Параметры

  • значение параметра profanity ненормативной лексики.

EnableAudioLogging

Синтаксис: public inline void EnableAudioLogging ( );

Включает ведение журнала звука в службе. Добавлено в версию 1.5.0.

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

RequestWordLevelTimestamps

Синтаксис: public inline void RequestWordLevelTimestamps ( );

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

EnableDictation

Синтаксис: public inline void EnableDictation ( );

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

SetProxy

Синтаксис: public inline void SetProxy ( const std::string & proxyHostName , uint32_t proxyPort , const std::string & proxyUserName , const std::string & proxyPassword );

Задает конфигурацию прокси-сервера, добавленную в версию 1.1.0.

Примечание. Функции прокси-сервера недоступны в macOS. Эта функция не будет влиять на эту платформу.

Параметры

  • proxyHostName Имя узла прокси-сервера без схемы протокола ([http://](http://))

  • proxyPort номер порта прокси-сервера

  • proxyUserName Имя пользователя прокси-сервера

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

SetProperty

Синтаксис: public inline void SetProperty ( const std::string & name , const std::string & value );

Задает значение свойства по имени.

Параметры

  • name Имя свойства.

  • value Значение свойства.

GetProperty

Синтаксис: public inline std::string GetProperty ( const std::string & name ) const;

Возвращает значение свойства по имени.

Параметры

  • name Имя параметра.

Возвраты

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

GetProperty

Синтаксис: public inline std::string GetProperty ( PropertyId id ) const;

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

Параметры

  • id Идентификатор параметра.

Возвраты

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

SetProperty

Синтаксис: public inline void SetProperty ( PropertyId id , const std::string & value );

Задает значение свойства по идентификатору.

Параметры

  • id Идентификатор свойства.

  • value Значение свойства.

SetServiceProperty

Синтаксис: public inline void SetServiceProperty ( const std::string & name , const std::string & value , ServicePropertyChannel channel );

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

Параметры

  • name Имя свойства.

  • value Значение свойства.

  • channel Канал, используемый для передачи указанного свойства в службу.

~SpeechConfig

Синтаксис: public inline virtual ~SpeechConfig ( );

Деструкция объекта.

FromSubscription

Синтаксис: public inline static std::shared_ptr< SpeechConfig > FromSubscription ( const std::string & subscription , const std::string & region );

Создает экземпляр конфигурации речи с указанным ключом подписки и регионом.

Параметры

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

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

Возвраты

Общий указатель на новый экземпляр конфигурации речи.

FromAuthorizationToken

Синтаксис: public inline static std::shared_ptr< SpeechConfig > FromAuthorizationToken ( const std::string & authToken , const std::string & region );

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

Параметры

  • authToken маркер авторизации.

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

Возвраты

Общий указатель на новый экземпляр конфигурации речи.

FromEndpoint

Синтаксис: public inline static std::shared_ptr< SpeechConfig > FromEndpoint ( const std::string & endpoint , const std::string & subscription );

Создает экземпляр конфигурации речи с указанной конечной точкой и подпиской. Этот метод предназначен только для пользователей, использующих нестандартную конечную точку службы. Примечание. Параметры запроса, указанные в URI конечной точки, не изменяются, даже если они задаются другими API. Например, если язык распознавания определен в URI в качестве параметра запроса "language=de-DE", а также задан параметром SetSpeechRecognitionLanguage("en-US"), параметр языка в URI имеет приоритет, а эффективный язык — "de-DE". Можно задать только параметры, не указанные в URI конечной точки, другими API. Примечание. Чтобы использовать маркер авторизации с FromEndpoint, используйте FromEndpoint(const SPXSTRING&), а затем вызовите SetAuthorizationToken() в созданном экземпляре SpeechConfig.

Параметры

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

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

Возвраты

Общий указатель на новый экземпляр конфигурации речи.

FromEndpoint

Синтаксис: public inline static std::shared_ptr< SpeechConfig > FromEndpoint ( const std::string & endpoint );

Создает экземпляр SpeechConfig с указанной конечной точкой. Этот метод предназначен только для пользователей, использующих нестандартную конечную точку службы. Примечание. Параметры запроса, указанные в URI конечной точки, не изменяются, даже если они задаются другими API. Независимо от того, поддерживается ли конкретный параметр запроса, зависит от конечной точки и сценария. Например, если язык распознавания определен в URI в качестве параметра запроса "language=de-DE", а также задан параметром SetSpeechRecognitionLanguage("en-US"), параметр языка в URI имеет приоритет, а эффективный язык — "de-DE". Пример применяется только в том случае, если сочетание конечных точек и сценариев поддерживает язык в качестве параметра запроса. Можно задать только параметры, не указанные в URI конечной точки, другими API. Примечание. Если для конечной точки требуется ключ подписки для проверки подлинности, используйте FromEndpoint(const SPXSTRING&, const SPXSTRING&) для передачи ключа подписки в качестве параметра. Чтобы использовать маркер авторизации с FromEndpoint, используйте этот метод для создания экземпляра SpeechConfig, а затем вызовите SetAuthorizationToken() в созданном экземпляре SpeechConfig. Примечание. Добавлено в версию 1.5.0.

Параметры

  • endpoint URI конечной точки службы для подключения.

Возвраты

Общий указатель на новый экземпляр конфигурации речи.

FromHost

Синтаксис: public inline static std::shared_ptr< SpeechConfig > FromHost ( const std::string & host , const std::string & subscription );

Создает экземпляр конфигурации речи с указанным узлом и подпиской. Этот метод предназначен только для пользователей, использующих узел службы, отличный от по умолчанию. Предполагается стандартный путь к ресурсу. Для служб с нестандартным путем к ресурсу или без пути вообще используйте FromEndpoint. Примечание. Параметры запроса не допускаются в URI узла и должны быть заданы другими API. Примечание. Чтобы использовать маркер авторизации с FromHost, используйте FromHost(const SPXSTRING&), а затем вызовите SetAuthorizationToken() в созданном экземпляре SpeechConfig. Примечание. Добавлено в версию 1.8.0.

Параметры

  • host узел службы для подключения. Формат — protocol://host:port, где ":p ort" является необязательным.

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

Возвраты

Общий указатель на новый экземпляр конфигурации речи.

FromHost

Синтаксис: public inline static std::shared_ptr< SpeechConfig > FromHost ( const std::string & host );

Создает экземпляр SpeechConfig с указанным узлом. Этот метод предназначен только для пользователей, использующих узел службы, отличный от по умолчанию. Предполагается стандартный путь к ресурсу. Для служб с нестандартным путем к ресурсу или без пути вообще используйте FromEndpoint. Примечание. Параметры запроса не допускаются в URI узла и должны быть заданы другими API. Примечание. Если для узла требуется ключ подписки для проверки подлинности, используйте FromHost(const SPXSTRING&, const SPXSTRING&) для передачи ключа подписки в качестве параметра. Чтобы использовать маркер авторизации с FromHost, используйте этот метод для создания экземпляра SpeechConfig, а затем вызовите SetAuthorizationToken() в созданном экземпляре SpeechConfig. Примечание. Добавлено в версию 1.8.0.

Параметры

  • host URI узла службы для подключения. Формат — protocol://host:port, где ":p ort" является необязательным.

Возвраты

Общий указатель на новый экземпляр конфигурации речи.