classe SpeechConfig

  • Article

Classe qui définit des configurations pour la reconnaissance vocale/intention, ou la synthèse vocale.

Membres

EmbeddedSpeechConfig

Syntaxe : public friend EmbeddedSpeechConfig;

HybridSpeechConfig

Syntaxe : public friend HybridSpeechConfig;

opérateur SPXSPEECHCONFIGHANDLE

Syntaxe : public inline explicit operator SPXSPEECHCONFIGHANDLE ( ) const;

Opérateur interne utilisé pour obtenir la valeur de handle sous-jacente.

Retours

Handle.

SetSpeechRecognitionLanguage

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

Définissez la langue d’entrée sur le module de reconnaissance vocale.

Paramètres

  • lang Spécifie le nom de la langue parlée à reconnaître au format BCP-47.

GetSpeechRecognitionLanguage

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

Obtient la langue d’entrée de la reconnaissance vocale. La langue est spécifiée au format BCP-47.

Retours

Langue de reconnaissance vocale.

SetSpeechSynthesisLanguage

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

Définit la langue du synthétiseur vocal. Ajouté dans la version 1.4.0.

Paramètres

  • lang Spécifie le nom de la langue (par exemple, en-US)

GetSpeechSynthesisLanguage

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

Obtient la langue du synthétiseur vocal. Ajouté dans la version 1.4.0.

Retours

Langage de synthèse vocale.

SetSpeechSynthesisVoiceName

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

Définissez la voix du synthétiseur vocal. Ajouté dans la version 1.4.0.

Paramètres

  • voiceName Spécifie le nom de la voix

GetSpeechSynthesisVoiceName

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

Obtient la voix du synthétiseur vocal. Ajouté dans la version 1.4.0.

Retours

Nom de la voix de synthèse vocale.

SetSpeechSynthesisOutputFormat

Syntaxe : public inline void SetSpeechSynthesisOutputFormat ( SpeechSynthesisOutputFormat formatId );

Définit le format de sortie de synthèse vocale (par exemple, Riff16Khz16BitMonoPcm). Ajouté dans la version 1.4.0.

Paramètres

  • formatId Spécifie l’ID de format de sortie

GetSpeechSynthesisOutputFormat

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

Obtient le format de sortie de synthèse vocale. Ajouté dans la version 1.4.0.

Retours

Format de sortie de synthèse vocale.

SetEndpointId

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

Définit l’ID de point de terminaison de Custom Speech ou Custom Voice.

Paramètres

  • endpointId ID de point de terminaison.

GetEndpointId

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

Obtient l’ID de point de terminaison de Custom Speech ou Custom Voice.

Retours

ID du point de terminaison.

SetAuthorizationToken

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

Définit le jeton d’autorisation pour se connecter au service. Remarque : l’appelant doit s’assurer que le jeton d’autorisation est valide. Avant que le jeton d’autorisation expire, l’appelant doit l’actualiser en appelant cet méthode setter avec un nouveau jeton valide. Comme les valeurs de configuration sont copiées lors de la création d’un module de reconnaissance, la nouvelle valeur de jeton ne s’applique pas aux modules de reconnaissance qui ont déjà été créés. Pour les modules de reconnaissance qui ont été créés précédemment, vous devez définir le jeton d’autorisation du module de reconnaissance correspondant pour actualiser le jeton. Sinon, les modules de reconnaissance rencontrent des erreurs lors de la reconnaissance.

Paramètres

  • token Jeton d’autorisation.

GetAuthorizationToken

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

Obtient le jeton d’autorisation pour se connecter au service.

Retours

Jeton d’autorisation.

GetSubscriptionKey

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

Obtient la clé d’abonnement utilisée pour créer Speech Recognizer ou Intent Recognizer, Translation Recognizer ou Speech Synthétiseur.

Retours

Clé d’abonnement.

GetRegion

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

Obtient la clé de région utilisée pour créer Speech Recognizer, Intent Recognizer, Translation Recognizer ou Speech Synthétiseur.

Retours

Région.

GetOutputFormat

Syntaxe : public inline OutputFormat GetOutputFormat ( ) const;

Obtient le format de sortie de la reconnaissance vocale (simple ou détaillé). Remarque : Ce format de sortie est destiné au résultat de la reconnaissance vocale, utilisez SpeechConfig ::GetSpeechSynthesisOutputFormat pour obtenir le format de sortie audio synthétisé.

Retours

Format de sortie de la reconnaissance vocale.

SetOutputFormat

Syntaxe : public inline void SetOutputFormat ( OutputFormat format );

Définit le format de sortie de la reconnaissance vocale (simple ou détaillé). Remarque : Ce format de sortie est destiné au résultat de la reconnaissance vocale, utilisez SpeechConfig ::SetSpeechSynthesisOutputFormat pour définir le format de sortie audio synthétisé.

Paramètres

  • format Format de sortie de la reconnaissance vocale

SetProfanity

Syntaxe : public inline void SetProfanity ( ProfanityOption profanity );

Définit l’option de grossièreté. Ajouté dans la version 1.5.0.

Paramètres

  • profanity Valeur de l’option blasphème.

EnableAudioLogging

Syntaxe : public inline void EnableAudioLogging ( );

Active la journalisation audio dans le service. Ajouté dans la version 1.5.0.

Les journaux d’activité audio et de contenu sont stockés soit dans un stockage appartenant à Microsoft, soit dans votre propre compte de stockage lié à votre abonnement Cognitive Services (ressource Speech byOS (Bring Your Own Storage) activée).

RequestWordLevelTimestamps

Syntaxe : public inline void RequestWordLevelTimestamps ( );

Inclut les horodatages au niveau du mot dans le résultat de la réponse. Ajouté dans la version 1.5.0.

EnableDictation

Syntaxe : public inline void EnableDictation ( );

Active le mode de dictée. Prise en charge uniquement dans la reconnaissance vocale continue. Ajouté dans la version 1.5.0.

SetProxy

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

Définit la configuration du proxy Ajoutée dans la version 1.1.0.

Remarque : La fonctionnalité de proxy n’est pas disponible sur macOS. Cette fonction n’aura aucun effet sur cette plateforme.

Paramètres

  • proxyHostName Nom d’hôte du serveur proxy, sans le schéma de protocole ([http://](http://))

  • proxyPort Numéro de port du serveur proxy

  • proxyUserName Nom d’utilisateur du serveur proxy

  • proxyPassword Mot de passe du serveur proxy

SetProperty

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

Définit une valeur de propriété par nom.

Paramètres

  • name Nom de la propriété.

  • value Valeur de propriété.

GetProperty

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

Obtient une valeur de propriété par nom.

Paramètres

  • name Nom du paramètre.

Retours

Valeur de la propriété.

GetProperty

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

Obtient une valeur de propriété par ID.

Paramètres

  • id ID de paramètre.

Retours

Valeur de la propriété.

SetProperty

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

Définit une valeur de propriété par ID.

Paramètres

  • id ID de propriété.

  • value Valeur de propriété.

SetServiceProperty

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

Définit une valeur de propriété qui sera passée au service à l’aide du canal spécifié. Ajouté dans la version 1.5.0.

Paramètres

  • name Nom de la propriété.

  • value Valeur de propriété.

  • channel Canal utilisé pour passer la propriété spécifiée au service.

~SpeechConfig

Syntaxe : public inline virtual ~SpeechConfig ( );

Détruit l’objet .

FromSubscription

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

Crée une instance de la configuration vocale avec la clé d’abonnement et la région spécifiées.

Paramètres

  • subscription Clé d’abonnement.

  • region Nom de la région (voir la page région).

Retours

Pointeur partagé vers la nouvelle configuration vocale instance.

FromAuthorizationToken

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

Crée une instance de la configuration vocale avec le jeton d’autorisation et la région spécifiés. Remarque : l’appelant doit s’assurer que le jeton d’autorisation est valide. Avant que le jeton d’autorisation expire, l’appelant doit l’actualiser en appelant cet méthode setter avec un nouveau jeton valide. Comme les valeurs de configuration sont copiées lors de la création d’un module de reconnaissance, la nouvelle valeur de jeton ne s’applique pas aux modules de reconnaissance qui ont déjà été créés. Pour les modules de reconnaissance qui ont été créés précédemment, vous devez définir le jeton d’autorisation du module de reconnaissance correspondant pour actualiser le jeton. Sinon, les modules de reconnaissance rencontrent des erreurs lors de la reconnaissance.

Paramètres

  • authToken Jeton d’autorisation.

  • region Nom de la région (voir la page région).

Retours

Pointeur partagé vers la nouvelle configuration vocale instance.

FromEndpoint

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

Crée un instance de la configuration vocale avec le point de terminaison et l’abonnement spécifiés. Cette méthode est destinée uniquement aux utilisateurs qui utilisent un point de terminaison de service non standard. Remarque : Les paramètres de requête spécifiés dans l’URI du point de terminaison ne sont pas modifiés, même s’ils sont définis par d’autres API. Par exemple, si la langue de reconnaissance est définie dans l’URI en tant que paramètre de requête « language=de-DE », et également définie par SetSpeechRecognitionLanguage(« en-US »), le paramètre de langue dans URI est prioritaire et la langue effective est « de-DE ». Seuls les paramètres non spécifiés dans l’URI de point de terminaison peuvent être définis par d’autres API. Remarque : Pour utiliser un jeton d’autorisation avec FromEndpoint, utilisez FromEndpoint(const SPXSTRING&), puis appelez SetAuthorizationToken() sur le instance SpeechConfig créé.

Paramètres

  • endpoint Point de terminaison de service auquel se connecter.

  • subscription Clé d’abonnement.

Retours

Pointeur partagé vers la nouvelle configuration vocale instance.

FromEndpoint

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

Crée une instance de SpeechConfig avec le point de terminaison spécifié. Cette méthode est destinée uniquement aux utilisateurs qui utilisent un point de terminaison de service non standard. Remarque : Les paramètres de requête spécifiés dans l’URI du point de terminaison ne sont pas modifiés, même s’ils sont définis par d’autres API. Le fait qu’un paramètre de requête spécifique soit pris en charge ou non dépend du point de terminaison et du scénario. Par exemple, si la langue de reconnaissance est définie dans l’URI en tant que paramètre de requête « language=de-DE », et également définie par SetSpeechRecognitionLanguage(« en-US »), le paramètre de langue dans URI est prioritaire et la langue effective est « de-DE ». L’exemple s’applique uniquement lorsque la combinaison de point de terminaison et de scénario prend en charge la langue en tant que paramètre de requête. Seuls les paramètres non spécifiés dans l’URI de point de terminaison peuvent être définis par d’autres API. Remarque : Si le point de terminaison nécessite une clé d’abonnement pour l’authentification, utilisez FromEndpoint(const SPXSTRING&, const SPXSTRING&) pour passer la clé d’abonnement en tant que paramètre. Pour utiliser un jeton d’autorisation avec FromEndpoint, utilisez cette méthode pour créer un instance SpeechConfig, puis appelez SetAuthorizationToken() sur le instance SpeechConfig créé. Remarque : Ajouté dans la version 1.5.0.

Paramètres

  • endpoint URI du point de terminaison de service auquel se connecter.

Retours

Pointeur partagé vers la nouvelle configuration vocale instance.

FromHost

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

Crée une instance de la configuration vocale avec l’hôte et l’abonnement spécifiés. Cette méthode est destinée uniquement aux utilisateurs qui utilisent un hôte de service autre que celui par défaut. Le chemin d’accès aux ressources standard est supposé. Pour les services avec un chemin de ressource non standard ou aucun chemin d’accès, utilisez plutôt FromEndpoint. Remarque : les paramètres de requête ne sont pas autorisés dans l’URI hôte et doivent être définis par d’autres API. Remarque : Pour utiliser un jeton d’autorisation avec FromHost, utilisez FromHost(const SPXSTRING&), puis appelez SetAuthorizationToken() sur le instance SpeechConfig créé. Remarque : Ajouté dans la version 1.8.0.

Paramètres

  • host Hôte de service auquel se connecter. Le format est « protocol ://host :port » où « :p ort » est facultatif.

  • subscription Clé d’abonnement.

Retours

Pointeur partagé vers la nouvelle configuration vocale instance.

FromHost

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

Crée une instance de SpeechConfig avec l’hôte spécifié. Cette méthode est destinée uniquement aux utilisateurs qui utilisent un hôte de service autre que celui par défaut. Le chemin d’accès aux ressources standard est supposé. Pour les services avec un chemin de ressource non standard ou aucun chemin d’accès, utilisez plutôt FromEndpoint. Remarque : les paramètres de requête ne sont pas autorisés dans l’URI hôte et doivent être définis par d’autres API. Remarque : Si l’hôte nécessite une clé d’abonnement pour l’authentification, utilisez FromHost(const SPXSTRING&, const SPXSTRING&) pour passer la clé d’abonnement en tant que paramètre. Pour utiliser un jeton d’autorisation avec FromHost, utilisez cette méthode pour créer un instance SpeechConfig, puis appelez SetAuthorizationToken() sur le instance SpeechConfig créé. Remarque : Ajouté dans la version 1.8.0.

Paramètres

  • host URI de l’hôte de service auquel se connecter. Le format est « protocol ://host :port » où « :p ort » est facultatif.

Retours

Pointeur partagé vers la nouvelle configuration vocale instance.