SpeakAndGetDigits - Amazon Chime SDK
Utilisation de l'SpeakAndGetDigitsactionGestion des ACTION_SUCCESSFUL événementsGestion des ACTION_FAILED événementsUtilisation du rôle lié au service Amazon Chime SDK Voice Connector

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

SpeakAndGetDigits

Écoutez la parole en fournissant du texte et collectez les chiffres à double tonalité et multifréquence (DTMF) de l'utilisateur. Le texte peut être du texte brut ou du texte amélioré en langage SSML (Speech Synthesis Markup Language) afin de mieux contrôler la manière dont le SDK Amazon Chime génère la parole en ajoutant des pauses, en soulignant certains mots ou en modifiant le style de parole, entre autres fonctionnalités SSML prises en charge. En cas d'échec, par exemple si l'utilisateur ne saisit pas le nombre correct de chiffres DTMF, l'action joue le discours d'échec, puis rejoue le discours principal jusqu'à ce que l'application multimédia SIP ait épuisé le nombre de tentatives défini dans le paramètre. Repeat

Le SDK Amazon Chime utilise Amazon Polly, un service cloud qui convertit le texte en discours réaliste. Amazon Polly fournit à la fois un moteur standard et un moteur neuronal pour une meilleure qualité vocale, plus de 20 langues prises en charge et 60 voix. Amazon Polly fournit des fonctionnalités vocales gratuitement, mais vous payez pour utiliser Amazon Polly. Consultez la page de tarification d'Amazon Polly ou votre tableau de bord de facturation pour obtenir des informations sur les prix.

Important

L'utilisation d'Amazon Polly est soumise aux conditions de AWS service, y compris les conditions spécifiques aux services de AWS Machine Learning et d'intelligence artificielle.

Utilisation de l'SpeakAndGetDigitsaction

L'exemple suivant illustre une utilisation typique de l'SpeakAndGetDigitsaction :

{
    "SchemaVersion": "1.0",
    "Actions":[
        {
            "Type": "SpeakAndGetDigits",
            "Parameters": {
                "CallId": "call-id-1",          // required
                "InputDigitsRegex": "^\d{2}#$", // optional
                "SpeechParameters": {
                    "Text": "Hello World",      // required
                    "Engine": "neural",         // optional. Defaults to standard
                    "LanguageCode": "en-US",    // optional
                    "TextType": "text",         // optional
                    "VoiceId": "Joanna"         // optional. Defaults to Joanna
                },
                "FailureSpeechParameters": {
                    "Text": "Hello World",      // required
                    "Engine": "neural",         // optional. Defaults to the Engine value in SpeechParameters
                    "LanguageCode": "en-US",    // optional. Defaults to the LanguageCode value in SpeechParameters
                    "TextType": "text",         // optional. Defaults to the TextType value in SpeechParameters
                    "VoiceId": "Joanna"         // optional. Defaults to the VoiceId value in SpeechParameters
                },
                "MinNumberOfDigits": 3,         // optional
                "MaxNumberOfDigits": 5,         // optional
                "TerminatorDigits": ["#"],      // optional
                "InBetweenDigitsDurationInMilliseconds": 5000,  // optional
                "Repeat": 3,                    // optional
                "RepeatDurationInMilliseconds": 10000           // required
            }
        }
    ]
}
CallId

Description — Le nom CallId du participant à l' CallDetails invocation de la fonction Lambda.

Valeurs autorisées : A valide callID

Obligatoire — Oui

Valeur par défaut — Non

InputDigitsRegex

Description : modèle d'expression régulière permettant de garantir que les utilisateurs saisissent les bons chiffres et lettres.

Valeurs autorisées : modèle d'expression régulière valide

Obligatoire — Non

Valeur par défaut – Aucune

SpeechParameters.Engine

Description — Spécifie le moteur (standard ou neuronal) à utiliser lors du traitement de texte pour la synthèse vocale.

Valeurs autorisées — standard | neural

Obligatoire — Non

Valeur par défaut — Standard

SpeechParameters.LanguageCode

Description — Spécifie le code de langue. Cela n'est nécessaire que si vous utilisez une voix bilingue. Si une voix bilingue est utilisée et qu'aucun code de langue n'est spécifié, la langue par défaut de la voix bilingue est utilisée.

Valeurs autorisées — Codes de langue Amazon Polly

Obligatoire — Non

Valeur par défaut – Aucune

SpeechParameters.Text

Description — Spécifie le texte saisi. Si vous spécifiez ssml commeSpeechParameters.TextType, vous devez suivre le format SSML pour le texte d'entrée. Pour plus d'informations sur le protocole SSML, consultez la section Génération de discours à partir de documents SSML dans le manuel Amazon Polly Developer Guide.

Valeurs autorisées — Chaîne

Obligatoire — Oui

Valeur par défaut – Aucune

SpeechParameters.TextType

Description — Spécifie le format de texte pourSpeechParameters.Text. S'il n'est pas spécifié, text il est utilisé par défaut. Pour plus d'informations sur le protocole SSML, consultez la section Génération de discours à partir de documents SSML dans le manuel Amazon Polly Developer Guide.

Valeurs autorisées — ssml | text

Obligatoire — Non

Valeur par défaut — text

SpeechParameters.VoiceId

Description — L'identifiant de la voix Amazon Polly utilisée pour prononcer le texte. SpeechParameters.Text

Valeurs autorisées — Identifiants vocaux Amazon Polly

Obligatoire — Non

Valeur par défaut — Joanna

FailureSpeechParameters.Engine

Description — Spécifie le moteur (standard ou neuronal) à utiliser lors du traitement du message d'échec utilisé lorsque le client saisit une réponse non valide pour la synthèse vocale.

Valeurs autorisées — standard | neural

Obligatoire — Non

Valeur par défaut — La SpeechParameters.Engine valeur

FailureSpeechParameters.LanguageCode

Description — Spécifie le code de langue utilisé lorsque le client saisit une réponse non valide. Nécessaire uniquement si vous utilisez une voix bilingue. Si vous utilisez une voix bilingue sans spécifier de code de langue, la langue par défaut de la voix bilingue est utilisée.

Valeurs autorisées — Codes de langue Amazon Polly

Obligatoire — Non

Valeur par défaut : SpeechParameters.LanguageCode valeur.

FailureSpeechParameters.Text

Description — Spécifie le texte d'entrée prononcé lorsque le client saisit une réponse non valide. Si vous spécifiez ssml commeFailureSpeechParameters.TextType, vous devez suivre le format SSML pour le texte d'entrée.

Valeurs autorisées — Chaîne

Obligatoire — Oui

Valeur par défaut – Aucune

FailureSpeechParameters.TextType

Description — Spécifie si le texte d'entrée spécifié dans FailureSpeechParameters.Text est du texte brut ou du SSML. La valeur par défaut est le texte brut. Pour plus d'informations, consultez la section Génération de discours à partir de documents SSML dans le manuel Amazon Polly Developer Guide.

Valeurs autorisées — ssml | text

Obligatoire — Non

Valeur par défaut — La SpeechParameters.Text valeur

FailureSpeechParameters.VoiceId

Description — Identifiant de la voix utilisée pour prononcer la chaîneFailureSpeechParameters.Text.

Valeurs autorisées — Identifiants vocaux Amazon Polly

Obligatoire — Oui

Valeur par défaut — La SpeechParameters.VoiceId valeur

MinNumberOfDigits

Description — Le nombre minimum de chiffres à saisir avant l'expiration du délai imparti ou avant la lecture du message « échec de l'appel ».

Valeurs autorisées : supérieures ou égales à zéro

Obligatoire — Non

Valeur par défaut — 0

MaxNumberOfDigits

Description — Le nombre maximum de chiffres à capturer avant l'arrêt sans un chiffre final.

Valeurs autorisées : supérieures à MinNumberOfDigits

Obligatoire — Non

Valeur par défaut : 128

TerminatorDigits

Description — Chiffre utilisé pour terminer la saisie si l'utilisateur saisit moins que MaxNumberOfDigits

Valeurs autorisées — N'importe laquelle des valeurs suivantes : 0 1 2 3 4 5 6 7 8 9 # ou *

Obligatoire — Non

Valeur par défaut — #

InBetweenDigitsDurationInMilliseconds

Description — Le temps d'attente en millisecondes entre les entrées numériques avant de lire le discours d'échec.

Valeurs autorisées : supérieures à zéro

Obligatoire — Non

Valeur par défaut — Si elle n'est pas spécifiée, la RepeatDurationInMilliseconds valeur par défaut est

Repeat

Description — Nombre total de tentatives pour obtenir des chiffres. Si vous omettez ce paramètre, la valeur par défaut est une tentative de collecte de chiffres.

Valeurs autorisées : supérieures à zéro

Obligatoire — Non

Valeur par défaut — 1

RepeatDurationInMilliseconds

Description — Délai d'expiration en millisecondes pour chaque tentative d'obtention de chiffres.

Valeurs autorisées : supérieures à zéro

Obligatoire — Oui

Valeur par défaut – Aucune

Gestion des ACTION_SUCCESSFUL événements

L'exemple suivant illustre un ACTION_SUCCESSFUL événement typique.

{
    "SchemaVersion": "1.0",
    "Sequence": 3,
    "InvocationEventType": "ACTION_SUCCESSFUL",
    "ActionData": {
            "Type":  "SpeakAndGetDigits",
            "Parameters": {
                "CallId": "call-id-1",          
                "InputDigitsRegex":  "^\d{2}#$", 
                "SpeechParameters": {
                    "Engine":  "neural",         
                    "LanguageCode": "en-US",    
                    "Text":  "Hello World",           
                    "TextType":  "text",         
                    "VoiceId": "Joanna"         
                },
                "FailureSpeechParameters": {
                    "Engine":  "neural",         
                    "LanguageCode":  "en-US",    
                    "Text":  "Hello World",           
                    "TextType": "text",         
                    "VoiceId": "Joanna"         
                },
                "MinNumberOfDigits": 3,         
                "MaxNumberOfDigits": 5,         
                "TerminatorDigits": ["#"],      
                "InBetweenDigitsDurationInMilliseconds": 5000,  
                "Repeat": 3,                    
                "RepeatDurationInMilliseconds": 10000           
            },
            "ReceivedDigits": "1234"
    },
    "CallDetails":{       
       ...
    }
}

Gestion des ACTION_FAILED événements

L'exemple suivant illustre un ACTION_FAILED événement typique.

{
    "SchemaVersion": "1.0",
    "Sequence":2,
    "InvocationEventType": "ACTION_FAILED",
    "ActionData":{
            "Type":  "SpeakAndGetDigits",
            "Parameters": {
                "CallId": "call-id-1",          
                "InputDigitsRegex":  "^\d{2}#$", 
                "SpeechParameters": {
                    "Engine":  "neural",         
                    "LanguageCode": "en-US",    
                    "Text":  "Hello World",           
                    "TextType":  "text",         
                    "VoiceId": "Joanna"         
                },
                "FailureSpeechParameters": {
                    "Engine":  "neural",         
                    "LanguageCode":  "en-US",    
                    "Text":  "Hello World",          
                    "TextType": "text",        
                    "VoiceId": "Joanna"        
                },
                "MinNumberOfDigits": 3,      
                "MaxNumberOfDigits": 5,        
                "TerminatorDigits": ["#"],      
                "InBetweenDigitsDurationInMilliseconds": 5000,  
                "Repeat": 3,                    
                "RepeatDurationInMilliseconds": 10000         
            },
            "ErrorType":  "SystemException",
            "ErrorMessage":  "System error while running action"
    },
    "CallDetails":{       
       ...
    }
}
Gestion des erreurs

Ce tableau répertorie et décrit les messages d'erreur générés par l'Speakaction.

Erreur Message Raison

AccessDenied

Le AWSServiceRoleForAmazonChimeVoiceConnector rôle n'est pas configuré correctement.

Le rôle utilisé pour envoyer des demandes à Amazon Polly n'existe pas ou ne dispose pas d'autorisations. Pour résoudre le problème, consultez les étapes décrites dans la Utilisation du rôle lié au service Amazon Chime SDK Voice Connector section

InvalidActionParameter

 

Une erreur s'est produite lors de la validation des paramètres de l'action. Pour consulter les paramètres disponibles pour cette action et leurs options, consultez SynthesizeSpeechle manuel Amazon Polly Developer Guide.

MissingRequiredActionParameter

Textest un paramètre obligatoire.

Les paramètres de l'action doivent avoir une Text valeur

MissingRequiredActionParameter

Textest limité à 1 000 caractères

Le texte a dépassé la limite de caractères.

SystemException

Erreur système lors de l'exécution de l'action.

Une erreur système s'est produite lors de l'exécution de l'action.

Utilisation du rôle lié au service Amazon Chime SDK Voice Connector

Il n'est pas nécessaire de créer manuellement un rôle lié à un service pour les actions Speak orSpeakAndGetDigits. Lorsque vous créez ou mettez à jour une application multimédia SIP dans la console Amazon Chime SDK, ou dans l' AWS API AWS Command Line Interface, le SDK Amazon Chime crée le rôle lié au service pour vous.

Pour plus d'informations, consultez la section Utilisation du rôle lié au service Amazon Chime dans le guide de l'administrateur du SDK Amazon Chime.