Clase SpeechConfig

Clase que define configuraciones para el reconocimiento de voz/intención o síntesis de voz.

Miembros

EmbeddedSpeechConfig

Sintaxis: public friend EmbeddedSpeechConfig;

HybridSpeechConfig

Sintaxis: public friend HybridSpeechConfig;

operador SPXSPEECHCONFIGHANDLE

Sintaxis: public inline explicit operator SPXSPEECHCONFIGHANDLE ( ) const;

Operador interno usado para obtener el valor de identificador subyacente.

Devoluciones

Un identificador.

SetSpeechRecognitionLanguage

Sintaxis: public inline void SetSpeechRecognitionLanguage ( const std::string & lang );

Establezca el idioma de entrada en el reconocedor de voz.

Parámetros

  • lang Especifica el nombre del idioma hablado que se va a reconocer en formato BCP-47.

GetSpeechRecognitionLanguage

Sintaxis: public inline std::string GetSpeechRecognitionLanguage ( ) const;

Obtiene el idioma de entrada para el reconocimiento de voz. El idioma se especifica en formato BCP-47.

Devoluciones

Idioma de reconocimiento de voz.

SetSpeechSynthesisLanguage

Sintaxis: public inline void SetSpeechSynthesisLanguage ( const std::string & lang );

Establece el idioma del sintetizador de voz. Se agregó en la versión 1.4.0.

Parámetros

  • lang Especifica el nombre del idioma (por ejemplo, en-US)

GetSpeechSynthesisLanguage

Sintaxis: public inline std::string GetSpeechSynthesisLanguage ( ) const;

Obtiene el idioma del sintetizador de voz. Se agregó en la versión 1.4.0.

Devoluciones

Lenguaje de síntesis de voz.

SetSpeechSynthesisVoiceName

Sintaxis: public inline void SetSpeechSynthesisVoiceName ( const std::string & voiceName );

Establezca la voz del sintetizador de voz. Se agregó en la versión 1.4.0.

Parámetros

  • voiceName Especifica el nombre de voz.

GetSpeechSynthesisVoiceName

Sintaxis: public inline std::string GetSpeechSynthesisVoiceName ( ) const;

Obtiene la voz del sintetizador de voz. Se agregó en la versión 1.4.0.

Devoluciones

Nombre de voz de síntesis de voz.

SetSpeechSynthesisOutputFormat

Sintaxis: public inline void SetSpeechSynthesisOutputFormat ( SpeechSynthesisOutputFormat formatId );

Establece el formato de salida de síntesis de voz (por ejemplo, Riff16Khz16BitMonoPcm). Se agregó en la versión 1.4.0.

Parámetros

  • formatId Especifica el identificador de formato de salida.

GetSpeechSynthesisOutputFormat

Sintaxis: public inline std::string GetSpeechSynthesisOutputFormat ( ) const;

Obtiene el formato de salida de síntesis de voz. Se agregó en la versión 1.4.0.

Devoluciones

Formato de salida de síntesis de voz.

SetEndpointId

Sintaxis: public inline void SetEndpointId ( const std::string & endpointId );

Establece el identificador de punto de conexión de Custom Speech o Custom Voice.

Parámetros

  • endpointId Id. de punto de conexión.

GetEndpointId

Sintaxis: public inline std::string GetEndpointId ( ) const;

Obtiene el identificador de punto de conexión de Custom Speech o Custom Voice.

Devoluciones

Identificador del punto de conexión.

SetAuthorizationToken

Sintaxis: public inline void SetAuthorizationToken ( const std::string & token );

Establece el token de autorización para conectarse al servicio. Nota: El autor de la llamada debe asegurarse de que el token de autorización es válido. Antes de que expire el token de autorización, el autor de la llamada debe actualizarlo llamando a este establecedor con un nuevo token válido. Como los valores de configuración se copian al crear un nuevo reconocedor, el nuevo valor de token no se aplicará a los reconocedores que ya se han creado. Para los reconocedores que se han creado antes, debe establecer el token de autorización del reconocedor correspondiente para actualizar el token. De lo contrario, los reconocedores encontrarán errores durante el reconocimiento.

Parámetros

  • token Token de autorización.

GetAuthorizationToken

Sintaxis: public inline std::string GetAuthorizationToken ( ) const;

Obtiene el token de autorización para conectarse al servicio.

Devoluciones

Token de autorización.

GetSubscriptionKey

Sintaxis: public inline std::string GetSubscriptionKey ( ) const;

Obtiene la clave de suscripción que se usa para crear Speech Recognizer o Intent Recognizer o Translation Recognizer o Speech Synthesizer.

Devoluciones

Clave de suscripción.

GetRegion

Sintaxis: public inline std::string GetRegion ( ) const;

Obtiene la clave de región que se usa para crear Speech Recognizer o Intent Recognizer o Translation Recognizer o sintetizador de voz.

Devoluciones

Región.

GetOutputFormat

Sintaxis: public inline OutputFormat GetOutputFormat ( ) const;

Obtiene el formato de salida del reconocimiento de voz (simple o detallado). Nota: Este formato de salida es para el resultado del reconocimiento de voz, use SpeechConfig::GetSpeechSynthesisOutputFormat para obtener el formato de salida de audio sintetizado.

Devoluciones

Formato de salida del reconocimiento de voz.

SetOutputFormat

Sintaxis: public inline void SetOutputFormat ( OutputFormat format );

Establece el formato de salida del reconocimiento de voz (simple o detallado). Nota: Este formato de salida es para el resultado del reconocimiento de voz, use SpeechConfig::SetSpeechSynthesisOutputFormat para establecer el formato de salida de audio sintetizado.

Parámetros

  • format Formato de salida del reconocimiento de voz

SetProfanity

Sintaxis: public inline void SetProfanity ( ProfanityOption profanity );

Establece la opción soeces. Se agregó en la versión 1.5.0.

Parámetros

  • profanity Valor de la opción Soece.

EnableAudioLogging

Sintaxis: public inline void EnableAudioLogging ( );

Habilita el registro de audio en el servicio. Se agregó en la versión 1.5.0.

Los registros de audio y contenido se almacenan en el almacenamiento propiedad de Microsoft o en su propia cuenta de almacenamiento vinculada a la suscripción de Cognitive Services (Bring Your Own Storage [BYOS]) habilitado para el recurso de voz).

RequestWordLevelTimestamps

Sintaxis: public inline void RequestWordLevelTimestamps ( );

Incluye marcas de tiempo de nivel de palabra en el resultado de la respuesta. Se agregó en la versión 1.5.0.

EnableDictation

Sintaxis: public inline void EnableDictation ( );

Habilita el modo de dictado. Solo se admite en el reconocimiento continuo de voz. Se agregó en la versión 1.5.0.

SetProxy

Sintaxis: public inline void SetProxy ( const std::string & proxyHostName , uint32_t proxyPort , const std::string & proxyUserName , const std::string & proxyPassword );

Establece la configuración de proxy agregada en la versión 1.1.0.

Nota: La funcionalidad de proxy no está disponible en macOS. Esta función no tendrá ningún efecto en esta plataforma.

Parámetros

  • proxyHostName Nombre de host del servidor proxy, sin el esquema de protocolo ([http://](http://))

  • proxyPort Número de puerto del servidor proxy

  • proxyUserName Nombre de usuario del servidor proxy

  • proxyPassword La contraseña del servidor proxy

SetProperty

Sintaxis: public inline void SetProperty ( const std::string & name , const std::string & value );

Establece un valor de propiedad por nombre.

Parámetros

  • name Nombre de la propiedad.

  • value Valor de propiedad.

GetProperty

Sintaxis: public inline std::string GetProperty ( const std::string & name ) const;

Obtiene un valor de propiedad por nombre.

Parámetros

  • name Nombre del parámetro.

Devoluciones

Valor de propiedad.

GetProperty

Sintaxis: public inline std::string GetProperty ( PropertyId id ) const;

Obtiene un valor de propiedad por identificador.

Parámetros

  • id Identificador del parámetro.

Devoluciones

Valor de propiedad.

SetProperty

Sintaxis: public inline void SetProperty ( PropertyId id , const std::string & value );

Establece un valor de propiedad por identificador.

Parámetros

  • id Identificador de propiedad.

  • value Valor de propiedad.

SetServiceProperty

Sintaxis: public inline void SetServiceProperty ( const std::string & name , const std::string & value , ServicePropertyChannel channel );

Establece un valor de propiedad que se pasará al servicio mediante el canal especificado. Se agregó en la versión 1.5.0.

Parámetros

  • name Nombre de la propiedad.

  • value Valor de propiedad.

  • channel Canal utilizado para pasar la propiedad especificada al servicio.

~SpeechConfig

Sintaxis: public inline virtual ~SpeechConfig ( );

Destruye el objeto.

FromSubscription

Sintaxis: public inline static std::shared_ptr< SpeechConfig > FromSubscription ( const std::string & subscription , const std::string & region );

Crea una instancia de la configuración de voz con la clave de suscripción y la región especificadas.

Parámetros

  • subscription Clave de suscripción.

  • region El nombre de la región (consulte la página región).

Devoluciones

Puntero compartido a la nueva instancia de configuración de voz.

FromAuthorizationToken

Sintaxis: public inline static std::shared_ptr< SpeechConfig > FromAuthorizationToken ( const std::string & authToken , const std::string & region );

Crea una instancia de la configuración de voz con el token de autorización y la región especificados. Nota: El autor de la llamada debe asegurarse de que el token de autorización es válido. Antes de que expire el token de autorización, el autor de la llamada debe actualizarlo llamando a este establecedor con un nuevo token válido. Como los valores de configuración se copian al crear un nuevo reconocedor, el nuevo valor de token no se aplicará a los reconocedores que ya se han creado. Para los reconocedores que se han creado antes, debe establecer el token de autorización del reconocedor correspondiente para actualizar el token. De lo contrario, los reconocedores encontrarán errores durante el reconocimiento.

Parámetros

  • authToken Token de autorización.

  • region El nombre de la región (consulte la página región).

Devoluciones

Puntero compartido a la nueva instancia de configuración de voz.

FromEndpoint

Sintaxis: public inline static std::shared_ptr< SpeechConfig > FromEndpoint ( const std::string & endpoint , const std::string & subscription );

Crea una instancia de la configuración de voz con el punto de conexión y la suscripción especificados. Este método está pensado solo para los usuarios que usan un punto de conexión de servicio no estándar. Nota: Los parámetros de consulta especificados en el URI del punto de conexión no se cambian, incluso si se establecen mediante otras API. Por ejemplo, si el idioma de reconocimiento se define en URI como parámetro de consulta "language=de-DE" y también se establece en SetSpeechRecognitionLanguage("en-US"), la configuración de idioma en URI tiene prioridad y el idioma efectivo es "de-DE". Otras API solo pueden establecer los parámetros que no se especifiquen en el URI del punto de conexión. Nota: Para usar un token de autorización con FromEndpoint, use FromEndpoint(const SPXSTRING&) y, a continuación, llame a SetAuthorizationToken() en la instancia de SpeechConfig creada.

Parámetros

  • endpoint Punto de conexión de servicio al que se va a conectar.

  • subscription Clave de suscripción.

Devoluciones

Puntero compartido a la nueva instancia de configuración de voz.

FromEndpoint

Sintaxis: public inline static std::shared_ptr< SpeechConfig > FromEndpoint ( const std::string & endpoint );

Crea una instancia de SpeechConfig con el punto de conexión especificado. Este método está pensado solo para los usuarios que usan un punto de conexión de servicio no estándar. Nota: Los parámetros de consulta especificados en el URI del punto de conexión no se cambian, incluso si se establecen mediante otras API. Si se admite o no un parámetro de consulta específico, depende del punto de conexión y el escenario. Por ejemplo, si el idioma de reconocimiento se define en URI como parámetro de consulta "language=de-DE" y también se establece en SetSpeechRecognitionLanguage("en-US"), la configuración de idioma en URI tiene prioridad y el idioma efectivo es "de-DE". El ejemplo solo se aplica cuando la combinación de punto de conexión y escenario admite lenguaje como parámetro de consulta. Otras API solo pueden establecer los parámetros que no se especifiquen en el URI del punto de conexión. Nota: Si el punto de conexión requiere una clave de suscripción para la autenticación, use FromEndpoint(const SPXSTRING&, const SPXSTRING&) para pasar la clave de suscripción como parámetro. Para usar un token de autorización con FromEndpoint, use este método para crear una instancia de SpeechConfig y, a continuación, llame a SetAuthorizationToken() en la instancia de SpeechConfig creada. Nota: Se ha agregado en la versión 1.5.0.

Parámetros

  • endpoint URI del punto de conexión de servicio al que conectarse.

Devoluciones

Puntero compartido a la nueva instancia de configuración de voz.

FromHost

Sintaxis: public inline static std::shared_ptr< SpeechConfig > FromHost ( const std::string & host , const std::string & subscription );

Crea una instancia de la configuración de voz con el host y la suscripción especificados. Este método está pensado solo para los usuarios que usan un host de servicio no predeterminado. Se presupone la ruta de acceso del recurso estándar. En el caso de los servicios con una ruta de acceso de recursos no estándar o ninguna ruta de acceso, use FromEndpoint en su lugar. Nota: Los parámetros de consulta no se permiten en el URI del host y deben establecerse mediante otras API. Nota: Para usar un token de autorización con FromHost, use FromHost(const SPXSTRING&) y, a continuación, llame a SetAuthorizationToken() en la instancia de SpeechConfig creada. Nota: Se ha agregado en la versión 1.8.0.

Parámetros

  • host Host de servicio al que se va a conectar. El formato es "protocol://host:port", donde ":p ort" es opcional.

  • subscription Clave de suscripción.

Devoluciones

Puntero compartido a la nueva instancia de configuración de voz.

FromHost

Sintaxis: public inline static std::shared_ptr< SpeechConfig > FromHost ( const std::string & host );

Crea una instancia de SpeechConfig con el host especificado. Este método está pensado solo para los usuarios que usan un host de servicio no predeterminado. Se presupone la ruta de acceso del recurso estándar. En el caso de los servicios con una ruta de acceso de recursos no estándar o ninguna ruta de acceso, use FromEndpoint en su lugar. Nota: Los parámetros de consulta no se permiten en el URI del host y deben establecerse mediante otras API. Nota: Si el host requiere una clave de suscripción para la autenticación, use FromHost(const SPXSTRING&, const SPXSTRING&) para pasar la clave de suscripción como parámetro. Para usar un token de autorización con FromHost, use este método para crear una instancia de SpeechConfig y, a continuación, llame a SetAuthorizationToken() en la instancia de SpeechConfig creada. Nota: Se ha agregado en la versión 1.8.0.

Parámetros

  • host URI del host de servicio al que se va a conectar. El formato es "protocol://host:port", donde ":p ort" es opcional.

Devoluciones

Puntero compartido a la nueva instancia de configuración de voz.