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". Другие API могут задавать только те параметры, которые не указаны в URI конечной точки. Примечание. Чтобы использовать маркер авторизации с 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". Пример применяется только в том случае, если сочетание конечной точки и сценария поддерживает язык в качестве параметра запроса. Другие API могут задавать только те параметры, которые не указаны в URI конечной точки. Примечание. Если конечной точке требуется ключ подписки для проверки подлинности, используйте 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" является необязательным.

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

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