Langage de balisage de synthèse vocale (SSML)

En incluant le langage de balisage de synthèse vocale (SSML, Speech Synthesis Markup Language) dans votre requête Text-to-Speech, vous pouvez personnaliser davantage la réponse audio en fournissant des détails sur les pauses, ainsi que la mise en forme audio des acronymes, des dates, des heures, des abréviations ou du texte qui devrait être censuré. Consultez le tutoriel sur le langage SSML Text-to-Speech pour obtenir plus d'informations et des exemples de code.

Voici un exemple de balisage SSML et de synthèse de texte par Text-to-Speech :

<speak>
  Here are <say-as interpret-as="characters">SSML</say-as> samples.
  I can pause <break time="3s"/>.
  I can play a sound
  <audio src="https://www.example.com/MY_MP3_FILE.mp3">didn't get your MP3 audio file</audio>.
  I can speak in cardinals. Your number is <say-as interpret-as="cardinal">10</say-as>.
  Or I can speak in ordinals. You are <say-as interpret-as="ordinal">10</say-as> in line.
  Or I can even speak in digits. The digits for ten are <say-as interpret-as="characters">10</say-as>.
  I can also substitute phrases, like the <sub alias="World Wide Web Consortium">W3C</sub>.
  Finally, I can speak a paragraph with two sentences.
  <p><s>This is sentence one.</s><s>This is sentence two.</s></p>
</speak>

Voici le texte synthétisé pour l'exemple de document SSML :

Here are S S M L samples. I can pause [3 second pause]. I can play a sound [audio file plays].
I can speak in cardinals. Your number is ten.
Or I can speak in ordinals. You are tenth in line.
Or I can even speak in digits. The digits for ten are one oh.
I can also substitute phrases, like the World Wide Web Consortium.
Finally, I can speak a paragraph with two sentences. This is sentence one. This is sentence two.

Text-to-Speech accepte un sous-ensemble des tags SSML disponibles, qui sont décrits dans cet article.

Pour plus d'informations sur la création de données audio à partir d'une entrée SSML avec Text-to-Speech, consultez la page Créer des fichiers audio vocaux.

Conseils pour l'utilisation de SSML

En fonction de la mise en œuvre, vous devrez peut-être échapper des guillemets dans la charge utile SSML que vous envoyez à Text-to-Speech. L'exemple suivant montre comment formater une entrée SSML incluse dans un objet JSON.

"{
    'input':{
     'ssml':'<speak>The <say-as interpret-as=\"characters\">SSML</say-as>
          standard <break time=\"1s\"/>is defined by the
          <sub alias=\"World Wide Web Consortium\">W3C</sub>.</speak>'
    },
    'voice':{
      'languageCode':'en-us',
      'name':'en-US-Standard-B',
      'ssmlGender':'MALE'
    },
    'audioConfig':{
      'audioEncoding':'MP3'
    }
  }"

Caractères réservés

Évitez d'utiliser des caractères réservés SSML dans le texte à convertir au format audio. Lorsque vous devez utiliser un caractère réservé SSML, utilisez son code d'échappement pour en empêcher la lecture en tant que code. Le tableau suivant présente les caractères SSML réservés et leurs codes d'échappement respectifs.

Caractère	Code d'échappement
"	`"`
&	`&`
'	`'`
<	`<`
>	`>`

Sélectionner une voix

Vous pouvez définir la voix dans l'objet VoiceSelectionParams. Consultez le tutoriel Text-to-Speech sur SSML pour voir un exemple de code illustrant l'utilisation de l'objet VoiceSelectionParams.

Vous pouvez utiliser le tag <voice> pour lire le langage SSML dans plusieurs voix, mais vous devez définir le nom VoiceSelectionParams sur une voix compatible :

Type de voix demandé	Type de voix compatible avec le tag <voice>
Type de voix demandé	Neural2	Studio	Wavenet	Actualités	Standard
Neural2	✔	✔			✔
Studio	✔	✔			✔
Wavenet			✔	✔	✔
Standard	✔	✔			✔
Actualités			✔	✔	✔

Compatibilité des éléments SSML

Les sections qui suivent présentent les éléments et options SSML que vous pouvez utiliser dans vos actions.

`<speak>`

Élément racine de la réponse SSML.

Pour en savoir plus sur l'élément speak, consultez la spécification W3.

Exemple

<speak>
  my SSML content
</speak>

`<break>`

Élément vide qui contrôle les pauses ou d'autres limites prosodiques entre les mots. La spécification de <break> entre une paire de jetons est facultative. Si cet élément n'est pas présent entre les mots, la rupture est automatiquement déterminée en fonction du contexte linguistique.

Pour en savoir plus sur l'élément break, consultez la spécification W3.

Attributs

Attribut Description

Attribut	Description
`time`	Définit la durée de la rupture en secondes ou en millisecondes (par exemple, "3s" ou "250ms").
`strength`	Définit l'intensité de la rupture prosodique de la sortie en termes relatifs. Les valeurs valides sont : "x-weak", "weak", "medium", "strong" et "x-strong" (très faible, faible, moyenne, forte et très forte). La valeur "none" (aucune) indique qu'aucune limite de rupture prosodique ne doit être générée, ce qui peut permettre d'éviter une rupture que le processeur produirait sans cela. Les autres valeurs indiquent une intensité de rupture monotone non décroissante (augmentant de manière conceptuelle) entre les jetons. Les limites les plus fortes s'accompagnent généralement de pauses.

time

Définit la durée de la rupture en secondes ou en millisecondes (par exemple, "3s" ou "250ms").

strength

Définit l'intensité de la rupture prosodique de la sortie en termes relatifs. Les valeurs valides sont : "x-weak", "weak", "medium", "strong" et "x-strong" (très faible, faible, moyenne, forte et très forte). La valeur "none" (aucune) indique qu'aucune limite de rupture prosodique ne doit être générée, ce qui peut permettre d'éviter une rupture que le processeur produirait sans cela. Les autres valeurs indiquent une intensité de rupture monotone non décroissante (augmentant de manière conceptuelle) entre les jetons. Les limites les plus fortes s'accompagnent généralement de pauses.

Exemple

L'exemple suivant montre comment marquer une pause entre des étapes à l'aide de l'élément <break> :

<speak>
  Step 1, take a deep breath. <break time="200ms"/>
  Step 2, exhale.
  Step 3, take a deep breath again. <break strength="weak"/>
  Step 4, exhale.
</speak>

`<say‑as>`

Cet élément vous permet d'indiquer des informations sur le type de construction de texte qu'il contient. Il permet également de spécifier le niveau de détail pour le rendu du texte contenu.

L'élément <say‑as> possède l'attribut obligatoire interpret-as, qui détermine la façon dont la valeur est prononcée. Les attributs facultatifs format et detail peuvent être utilisés en fonction de la valeur interpret-as indiquée.

Exemples

L'attribut interpret-as accepte les valeurs suivantes :

currency
L'exemple suivant est prononcé "quarante deux dollars et un cent". Si l'attribut "language" est omis, les paramètres régionaux actuels sont utilisés.
```
<speak>
 <say-as interpret-as='currency' language='en-US'>$42.01</say-as>
</speak>
 
```
telephone
Reportez-vous à la description de interpret-as='telephone' dans la note du groupe de travail W3C sur les valeurs des attributs de l'élément say-as SSML 1.0.

L'exemple suivant est dit en anglais "one eight zero zero two zero two one two one two". Si l'attribut "google:style" est omis, "zero" est prononcé comme la lettre "o" en anglais.

L'attribut "google:style='zero-as-zero'" ne fonctionne actuellement que dans les paramètres régionaux EN.
```
 <speak>
 <say-as interpret-as='telephone' google:style='zero-as-zero'>1800-202-1212</say-as>
 </speak>
 
```
verbatim ou spell-out
L'exemple suivant est épelé une lettre à la fois :
```
<speak>
 <say-as interpret-as="verbatim">abcdefg</say-as>
</speak>
 
```
Votre navigateur n'est pas compatible avec l'élément audio HTML5.
date
L'attribut format est une séquence de codes de caractère de champ de date. Les codes de caractère de champ compatibles avec l'attribut format sont {y, m, d} pour l'année, le mois et le jour (du mois) respectivement. Si le code de champ apparaît une fois pour l'année, le mois ou le jour, le nombre attendu de chiffres est respectivement de 4, 2 et 2. Si le code de champ est répété, le nombre attendu de chiffres correspond au nombre de répétitions du code. Les champs du texte de date peuvent être séparés par des signes de ponctuation et/ou des espaces.

L'attribut detail contrôle la forme orale de la date. Pour detail='1', seuls les champs de jour et un champ de mois ou d'année sont requis, bien que les deux puissent être indiqués. Il s'agit du paramétrage par défaut lorsque les trois champs ne sont pas tous fournis. La forme orale est "The {nombre ordinal du jour} of {mois}, {année}".

L'exemple suivant est prononcé "The tenth of September, nineteen sixty" :
```
<speak>
 <say-as interpret-as="date" format="yyyymmdd" detail="1">
 1960-09-10
 </say-as>
</speak>
 
```
Votre navigateur n'est pas compatible avec l'élément audio HTML5.

L'exemple suivant est prononcé "The tenth of September" :
```
<speak>
 <say-as interpret-as="date" format="dm">10-9</say-as>
</speak>
 
```
Votre navigateur n'est pas compatible avec l'élément audio HTML5.

Pour detail='2', les champs de jour, de mois et d'année sont requis. Il s'agit du paramétrage par défaut lorsque les trois champs sont fournis. La forme orale est "{mois} {nombre ordinal du jour}, {année}".

L'exemple suivant est prononcé "September tenth, nineteen sixty" :
```
<speak>
 <say-as interpret-as="date" format="dmy" detail="2">
 10-9-1960
 </say-as>
</speak>
 
```
Votre navigateur n'est pas compatible avec l'élément audio HTML5.
characters
L'exemple suivant est prononcé "C A N" :
```
<speak>
 <say-as interpret-as="characters">can</say-as>
</speak>
 
```
Votre navigateur n'est pas compatible avec l'élément audio HTML5.
cardinal
L'exemple suivant est prononcé "Twelve thousand three hundred forty five" (pour l'anglais américain) ou "Twelve thousand three hundred and forty five" (pour l'anglais britannique) :
```
<speak>
 <say-as interpret-as="cardinal">12345</say-as>
</speak>
 
```
Votre navigateur n'est pas compatible avec l'élément audio HTML5.
ordinal
L'exemple suivant est prononcé "First" :
```
<speak>
 <say-as interpret-as="ordinal">1</say-as>
</speak>
 
```
Votre navigateur n'est pas compatible avec l'élément audio HTML5.
fraction
L'exemple suivant est prononcé "five and a half" :
```
<speak>
 <say-as interpret-as="fraction">5+1/2</say-as>
</speak>
 
```
Votre navigateur n'est pas compatible avec l'élément audio HTML5.
expletive ou bleep
L'exemple suivant émet un bip, comme si le texte avait été censuré :
```
<speak>
 <say-as interpret-as="expletive">censor this</say-as>
</speak>
 
```
Votre navigateur n'est pas compatible avec l'élément audio HTML5.
unit
Convertit les unités au singulier ou au pluriel selon le nombre indiqué. L'exemple suivant est prononcé "10 feet" :
```
<speak>
 <say-as interpret-as="unit">10 foot</say-as>
</speak>
 
```
Votre navigateur n'est pas compatible avec l'élément audio HTML5.
time
L'exemple suivant est prononcé "Two thirty P.M." :
```
<speak>
 <say-as interpret-as="time" format="hms12">2:30pm</say-as>
</speak>
 
```
Votre navigateur n'est pas compatible avec l'élément audio HTML5.

L'attribut format est une séquence de codes de caractères de champ d'heure. Les codes de caractère de champ compatibles avec l'attribut format sont {h, m, s, Z, 12, 24} pour l'heure, la minute (de l'heure), la seconde (de la minute), le fuseau horaire, le format 12 heures et le format 24 heures, respectivement. Si le code de champ apparaît une fois pour l'heure, la minute ou la seconde, le nombre attendu de chiffres est respectivement de 1, 2 et 2. Si le code de champ est répété, le nombre attendu de chiffres correspond au nombre de répétitions du code. Les champs du texte d'heure peuvent être séparés par des signes de ponctuation et/ou des espaces. Si l'heure, la minute ou la seconde ne sont pas spécifiées dans le format ou s'il n'y a pas de chiffres correspondants, le champ est traité comme une valeur nulle. La valeur par défaut de l'attribut format est "hms12".

L'attribut detail contrôle si l'heure prononcée est au format 12 heures ou 24 heures. Elle est au format 24 heures si detail='1', ou si detail est omis et que le format de l'heure est défini sur 24 heures. Elle est au format 12 heures si detail='2', ou si detail est omis et que le format de l'heure est défini sur 12 heures.

Pour en savoir plus sur l'élément say-as, consultez la spécification W3.

`<audio>`

Permet l'insertion de fichiers audio enregistrés et d'autres formats audio conjointement avec une sortie vocale synthétisée.

Attributs

Attribut	Obligatoire	Par défaut	Valeurs
`src`	oui	N/A	URI faisant référence à la source audio multimédia. Le protocole compatible est `https`.
`clipBegin`	non	0	TimeDesignation qui correspond au décalage entre le début de la source audio et le démarrage de la lecture. Si cette valeur est supérieure ou égale à la durée réelle de la source audio, aucun son n'est inséré.
`clipEnd`	non	infini	TimeDesignation qui correspond au décalage entre le début de la source audio et la fin de la lecture. Si la durée réelle de la source audio est inférieure à cette valeur, la lecture se termine à ce moment-là. Si la valeur de `clipBegin` est supérieure ou égale à `clipEnd`, aucun son n'est inséré.
`speed`	non	100 %	Ratio entre la vitesse de lecture de la sortie et la vitesse d'entrée normale, exprimé en pourcentage. Le format est un nombre réel positif suivi du symbole %. La plage actuellement acceptée est [50 % (lent – moitié de la vitesse) - 200 % (rapide – double de la vitesse)]. Les valeurs situées en dehors de cette plage peuvent être (ou non) ajustées afin d'y figurer.
`repeatCount`	non	1, ou 10 si `repeatDur` est défini	Nombre réel spécifiant le nombre d'insertions du contenu audio (après le découpage, le cas échéant, avec `clipBegin` et/ou avec `clipEnd`). Les répétitions fractionnaires ne sont pas acceptées. La valeur est donc arrondie à l'entier le plus proche. La valeur zéro n'est pas valide et est donc traitée comme si aucune valeur n'avait été spécifiée. La valeur par défaut est alors utilisée.
`repeatDur`	non	infini	TimeDesignation qui constitue une limite appliquée à la durée de l'audio inséré après le traitement de la source pour les attributs `clipBegin`, `clipEnd`, `repeatCount` et `speed` (plutôt qu'à la durée de lecture normale). Si la durée de l'audio traité est inférieure à cette valeur, la lecture se termine à ce moment-là.
`soundLevel`	non	+0 dB	Ajuste le niveau sonore de l'audio d'autant de décibels qu'indiqué par `soundLevel`. La plage maximale est de +/-40 dB, mais la plage réelle peut être inférieure en réalité, et la qualité de la sortie peut ne pas être bonne sur toute la plage.

Les paramètres audio actuellement acceptés sont les suivants :

Format : MP3 (MPEG v2)
- 24 000 échantillons par seconde
- 24 000 à 96 000 bits par seconde, taux fixe
Format : Opus en Ogg
- 24 000 échantillons par seconde (bande ultralarge)
- 24 000 à 96 000 bits par seconde, taux fixe
Format (obsolète) : WAV (RIFF)
- PCM signé 16 bits, little-endian
- 24 000 échantillons par seconde
Pour tous les formats :
- Un seul canal de préférence, mais la configuration stéréo est acceptable.
- Durée maximale de 240 secondes. Si vous souhaitez lire de l'audio d'une durée plus longue, envisagez de configurer une réponse multimédia.
- Taille de fichier limitée à 5 mégaoctets.
- L'URL source doit utiliser le protocole HTTPS.
- La valeur UserAgent lors de l'extraction de l'audio est "Google-Speech-Actions".

Le contenu de l'élément <audio> est facultatif et est utilisé si le fichier audio ne peut pas être lu ou si l'appareil de sortie n'est pas compatible avec l'audio. Ce contenu peut inclure un élément <desc>, auquel cas le contenu textuel de cet élément est utilisé pour l'affichage. Pour plus d'informations, consultez la section "Audio enregistré" de la checklist relative aux réponses.

L'URL src doit également être une URL https (Google Cloud Storage peut héberger les fichiers audio sur une URL https).

Pour en savoir plus sur les réponses multimédias, consultez la section Réponses multimédias du guide "Réponses".

Pour en savoir plus sur l'élément audio, consultez la spécification W3.

Exemple

<speak>
  <audio src="cat_purr_close.ogg">
    <desc>a cat purring</desc>
    PURR (sound didn't load)
  </audio>
</speak>

`,<s>`

Éléments de phrase et de paragraphe.

Pour en savoir plus sur les éléments p et s, consultez la spécification W3.

Exemple

<p><s>This is sentence one.</s><s>This is sentence two.</s></p>

Bonnes pratiques

Nous vous recommandons d'utiliser des tags <s>...</s> pour encapsuler des phrases entières, surtout lorsque celles-ci contiennent des éléments SSML qui modifient la prosodie (tels que <audio>, <break>, <emphasis>, <par>, <prosody>, <say-as>, <seq> et ).
Si l'énoncé comprend une rupture suffisamment longue pour qu'on puisse l'entendre, utilisez des tags <s>...</s> et insérez cette rupture entre les phrases.

``

Indique que le texte figurant dans la valeur de l'attribut alias remplace le texte contenu pour la prononciation.

Vous pouvez également utiliser l'élément sub pour fournir une prononciation plus simple d'un mot difficile à lire. Le dernier exemple ci-dessous illustre ce cas d'utilisation en japonais.

Pour en savoir plus sur l'élément sub, consultez la spécification W3.

Exemples

<sub alias="World Wide Web Consortium">W3C</sub>

<sub alias="にっぽんばし">日本橋</sub>

``

Élément vide qui insère un marqueur dans la séquence de texte ou de tags. Cet élément permet de faire référence à un emplacement spécifique dans la séquence ou d'insérer un marqueur dans un flux de sortie pour une notification asynchrone.

Remarque : Suivez les directives ci-dessous lorsque vous utilisez l'élément mark :

Utilisez les marques START et END au lieu d'ajouter des marques personnalisées vers le début ou la fin du document SSML.
N'ajoutez pas de marques consécutives dans votre document SSML. Les marques se succédant trop rapidement sont susceptibles de ne pas générer d'événements. En outre, si aucun contenu audio n'est présent entre les marques, aucun événement n'est généré. Voici un exemple à ne pas reproduire :
Sentence 1. Sentence 2.

Remarque : Par souci de simplicité, vous obtenez automatiquement les événements START et END dans vos réponses liées à Interactive Canvas. Ces marques ne sont pas incluses dans la spécification W3.

Pour en savoir plus sur l'élément mark, consultez la spécification W3.

Exemple

<speak>
Go from <mark name="here"/> here, to <mark name="there"/> there!
</speak>

`<prosody>`

Permet de personnaliser la hauteur vocale, la vitesse d'élocution et le volume de texte contenu par l'élément. Actuellement, les attributs rate, pitch et volume sont disponibles.

Les attributs rate et volume peuvent être définis conformément aux spécifications W3. Il existe trois options permettant de définir la valeur de l'attribut pitch :

Remarque : Les tags <prosody> ne doivent être utilisés que pour une phrase entière. S'ils n'entourent que quelques mots dans une phrase, des interruptions indésirables de la voix peuvent survenir.

Attribut	Description
`name`	ID de la chaîne pour chaque marque.

Option	Description
Proche	Spécifiez une valeur relative, par exemple, "low" (faible), "medium" (moyenne), "high" (élevée), etc., "medium" étant la hauteur vocale par défaut.
Demi-tons	Augmentez ou diminuez la hauteur vocale de "N" demi-tons en utilisant respectivement "+Nst" ou "-Nst". Notez que "+/-" et "st" sont requis.
Pourcentage	Augmentez ou diminuez la hauteur vocale de "N" % en utilisant respectivement "+N%" ou "-N%". Notez que "%" est requis, mais que "+/-" est facultatif.

Pour en savoir plus sur l'élément prosody, consultez la spécification W3.

Exemple

L'exemple suivant utilise l'élément <prosody> pour que le locuteur s'exprime lentement, deux demi-tons plus bas que la normale :

<prosody rate="slow" pitch="-2st">Can you hear me now?</prosody>

`<emphasis>`

Utilisé pour ajouter ou supprimer une emphase dans le texte contenu par l'élément. L'élément <emphasis> modifie la voix de la même manière que <prosody>, mais sans qu'il ne soit nécessaire de définir des attributs de parole individuels.

Remarque : Les tags <emphasis> ne doivent être utilisés que pour une phrase entière. S'ils n'entourent que quelques mots dans une phrase, des interruptions indésirables de la voix peuvent survenir.

Cet élément accepte un attribut "level" (niveau) facultatif avec les valeurs valides suivantes :

strong
moderate
none
reduced

Pour en savoir plus sur l'élément emphasis, consultez la spécification W3.

Exemple

L'exemple suivant utilise l'élément <emphasis> pour faire une annonce :

<emphasis level="moderate">This is an important announcement</emphasis>

`<par>`

Conteneur multimédia parallèle qui vous permet de lire plusieurs éléments multimédias simultanément. Le seul contenu autorisé est un ensemble d'un ou de plusieurs éléments <par>, <seq> et <media>. L'ordre des éléments <media> n'est pas important.

À moins qu'un élément enfant ne spécifie une heure de début différente, l'heure de début implicite de l'élément est identique à celle du conteneur <par>. Si un élément enfant a une valeur de décalage définie pour son attribut begin (début) ou end (fin), le décalage de l'élément est déterminé par rapport à l'heure de début du conteneur <par>. Pour l'élément <par> racine, l'attribut "begin" (début) est ignoré, et l'heure de début correspond au moment où le processus de synthèse vocale SSML commence à générer une sortie pour l'élément <par> racine (autrement dit, au temps "zéro").

Exemple

<speak>
  <par>
    <media xml:id="question" begin="0.5s">
      <speak>Who invented the Internet?</speak>
    </media>
    <media xml:id="answer" begin="question.end+2.0s">
      <speak>The Internet was invented by cats.</speak>
    </media>
    <media begin="answer.end-0.2s" soundLevel="-6dB">
      <audio
        src="https://actions.google.com/.../cartoon_boing.ogg"/>
    </media>
    <media repeatCount="3" soundLevel="+2.28dB"
      fadeInDur="2s" fadeOutDur="0.2s">
      <audio
        src="https://actions.google.com/.../cat_purr_close.ogg"/>
    </media>
  </par>
</speak>

`<seq>`

Conteneur multimédia séquentiel qui vous permet de lire les éléments multimédias les uns après les autres. Le seul contenu autorisé est un ensemble d'un ou de plusieurs éléments <seq>, <par> et <media>. L'ordre des éléments multimédias est celui dans lequel ils sont affichés.

Les attributs begin (début) et end (fin) des éléments enfants peuvent être définis sur des valeurs de décalage (consultez la section Spécification temporelle ci-dessous). Les valeurs de décalage de ces éléments enfants sont déterminées par rapport à la fin de l'élément précédent de la séquence ou, dans le cas du premier élément de la séquence, par rapport au début de son conteneur <seq>.

Exemple

<speak>
  <seq>
    <media begin="0.5s">
      <speak>Who invented the Internet?</speak>
    </media>
    <media begin="2.0s">
      <speak>The Internet was invented by cats.</speak>
    </media>
    <media soundLevel="-6dB">
      <audio
        src="https://actions.google.com/.../cartoon_boing.ogg"/>
    </media>
    <media repeatCount="3" soundLevel="+2.28dB"
      fadeInDur="2s" fadeOutDur="0.2s">
      <audio
        src="https://actions.google.com/.../cat_purr_close.ogg"/>
    </media>
  </seq>
</speak>

`<media>`

Représente une couche multimédia dans un élément <par> ou <seq>. Le contenu autorisé d'un élément <media> est un élément SSML <speak> ou <audio>. Le tableau suivant décrit les attributs valides pour un élément <media>.

Attributs

Attribut	Obligatoire	Par défaut	Valeurs
xml:id	non	Aucune valeur	Identifiant XML unique pour cet élément. Les entités encodées ne sont pas acceptées. Les valeurs d'identifiant autorisées correspondent à l'expression régulière `"([-_#]\|\p{L}\|\p{D})+"`. Pour en savoir plus, consultez la page XML-ID.
begin	non	0	Heure de début de ce conteneur multimédia. Ignoré s'il s'agit de l'élément racine du conteneur multimédia (traité de la même manière que la valeur par défaut "0"). Pour connaître les valeurs de chaîne valides, consultez la section Spécification temporelle ci-dessous.
end	non	Aucune valeur	Spécification pour l'heure de fin de ce conteneur multimédia. Pour connaître les valeurs de chaîne valides, consultez la section Spécification temporelle ci-dessous.
repeatCount	non	1	Nombre réel spécifiant le nombre d'insertions du contenu multimédia. Les répétitions fractionnaires ne sont pas acceptées. La valeur est donc arrondie à l'entier le plus proche. La valeur zéro n'est pas valide et est donc traitée comme si aucune valeur n'avait été spécifiée. La valeur par défaut est alors utilisée.
repeatDur	non	Aucune valeur	TimeDesignation qui constitue une limite appliquée à la durée du contenu multimédia inséré. Si la durée du contenu multimédia est inférieure à cette valeur, la lecture se termine à ce moment-là.
soundLevel	non	+0 dB	Ajuste le niveau sonore de l'audio d'autant de décibels qu'indiqué par `soundLevel`. La plage maximale est de +/-40 dB, mais la plage réelle peut être inférieure en réalité, et la qualité de la sortie peut ne pas être bonne sur toute la plage.
fadeInDur	non	0 s	TimeDesignation au cours de laquelle le contenu multimédia passe progressivement du mode silencieux à la valeur `soundLevel` spécifiée en option. Si la durée du contenu multimédia est inférieure à cette valeur, le fondu s'arrête à la fin de la lecture sans atteindre le niveau sonore spécifié.
fadeOutDur	non	0 s	TimeDesignation au cours de laquelle le contenu multimédia passe progressivement de la valeur `soundLevel` spécifiée en option au mode silencieux. Si la durée du contenu multimédia est inférieure à cette valeur, le niveau sonore est défini sur une valeur inférieure afin de garantir que le son est coupé à la fin de la lecture.

Spécification temporelle

Une spécification temporelle, utilisée pour la valeur des attributs "begin" (début) et "end" (fin) des éléments <media> et des conteneurs multimédias (éléments <par> et <seq>), est soit une valeur de décalage (par exemple, +2.5s), soit une valeur de base de synchronisation (par exemple, foo_id.end-250ms).

Valeur de décalage : la valeur de décalage temporel est une valeur de compte de temps SMIL qui autorise les valeurs correspondant à l'expression régulière : "\s\*(+|-)?\s\*(\d+)(\.\d+)?(h|min|s|ms)?\s\*"
La première chaîne de chiffres correspond à la partie entière du nombre décimal et la deuxième chaîne de chiffres à la partie décimale. Le signe par défaut (c'est-à-dire "(+|-)?") est "+". Les valeurs unitaires correspondent respectivement aux heures, aux minutes, aux secondes et aux millisecondes. La valeur par défaut pour les unités est "s" (secondes).
Valeur de base de synchronisation : il s'agit d'une valeur de base de synchronisation SMIL qui autorise les valeurs correspondant à l'expression régulière : "([-_#]|\p{L}|\p{D})+\.(begin|end)\s\*(+|-)\s\*(\d+)(\.\d+)?(h|min|s|ms)?\s\*"
Les chiffres et les unités sont interprétés de la même manière que pour une valeur de décalage.

`<phoneme>`

Vous pouvez utiliser le tag <phoneme> pour produire des prononciations personnalisées de mots intégrés. Text-to-Speech accepte les alphabets phonétiques IPA et X-SAMPA. Consultez la page des phonèmes pour obtenir la liste des langues et des phonèmes acceptés.

Chaque application du tag <phoneme> oriente la prononciation d'un seul mot :

  <phoneme alphabet="ipa" ph="ˌmænɪˈtoʊbə">manitoba</phoneme>
  <phoneme alphabet="x-sampa" ph='m@"hA:g@%ni:'>mahogany</phoneme>

Marqueurs de stress

Il existe trois niveaux de stress pouvant être placées dans une transcription :

Stress primaire : indiqué par /ˈ/ en IPA et /"/ en X-SAMPA.
Stress secondaire : indiqué par /ˌ/ en IPA et /%/ en X-SAMPA.
Sans stress : ce champ n'est pas représenté par un symbole (dans l'une ou l'autre notation).

Certaines langues peuvent avoir moins de trois niveaux ou ne pas indiquer de placement de stress. Consultez la page des phonèmes pour connaître les niveaux de stress disponibles pour votre langue. Des marqueurs de stress sont placés au début de chaque syllabe accentuée. Par exemple, en anglais américain :

Exemple de mot	IPA	X-SAMPA
water	ˈwɑːtɚ	"wA:t@`
underwater	ˌʌndɚˈwɑːtɚ	%Vnd@"wA:t@

Transcriptions larges et étroites

De manière générale, veillez à ce que vos transcriptions soient plus larges et phonémiques. Par exemple, en anglais américain, transcrivez le /t/ intervocalique (au lieu d'utiliser un tap) :

Exemple de mot	IPA	X-SAMPA
beurre	"bʌt" au lieu de "b"	"bVt@" au lieu de "bV4@"

Dans certains cas, l'utilisation de la représentation phonémique ne rend pas vos résultats de synthèse vocale anormales (par exemple, si la séquence de phonèmes est anatomiquement difficile à prononcer).

Par exemple, l'assimilation vocale pour /s/ en anglais. Dans ce cas, l'assimilation doit être reflétée dans la transcription :

Exemple de mot	IPA	X-SAMPA
chats	"kæts"	"k{ts"
chiens	"dɑːgz" au lieu de "dɑːgs"	"dA:gz" au lieu de "dA:gs"

Réduction

Chaque syllabe doit contenir une (et une seule) voyelle. Cela signifie que vous devez éviter les consonnes syllabiques et les transcrire par une voyelle réduite. Exemple :

Exemple de mot	IPA	X-SAMPA
kitten	ˈ"kɪtən" au lieu de ˈ"kɪtn"	"kIt@n" au lieu de "kitn"
kettle	"kɛtəl" au lieu de "kɛtl"	"kEt@l" au lieu de "kEtl"

Syllabification

Vous pouvez éventuellement spécifier des limites de syllabe à l'aide de /./. Chaque syllabe ne doit contenir qu'une voyelle. Exemple :

Exemple de mot	IPA	X-SAMPA
Lisibilité	ˌɹiː.də.ˈbɪ.lə.tiː	%r\i:.d@."bI.l@.ti:

Dictionnaire de prononciation personnalisé

Au lieu de fournir des prononciations intégrées avec le tag phoneme, fournissez un dictionnaire de prononciations personnalisées dans l'appel RPC de synthèse vocale. Lorsque le dictionnaire de prononciation personnalisé est inclus dans la requête, le texte saisi est automatiquement transformé avec le tag SSML phoneme.

Par exemple, la requête suivante avec une entrée de texte et une prononciation personnalisée sera transformée et sera équivalente au SSML ci-dessous.

Entrée d'origine :

input: {
  text: 'Hello world! It is indeed a beautiful world!',
  custom_pronunciations: {
    pronunciations: {
      phrase: 'world'
      phonetic_encoding: PHONETIC_ENCODING_IPA
      pronunciation: 'wɜːld'
    }
  }
}

Entrée transformée :

input: {
  ssml: '<speak>Hello <phoneme alphabet="ipa" ph="wɜːld">world</phoneme>! It is indeed a beautiful <phoneme alphabet="ipa" ph="wɜːld">world</phoneme>!</speak>'
}

Durées

Text-to-Speech accepte <say-as interpret-as="duration"> pour lire correctement les durées. Par exemple, l'expression suivante serait prononcé de "cinq heures et trente minutes" :

<say-as interpret-as="duration" format="h:m">5:30</say-as>

La chaîne de format accepte les valeurs ci-dessous :

Abréviation	Valeur
h	heures
m	minutes
s	secondes
ms	millisecondes

`<voice>`

Le tag <voice> vous permet d'utiliser plusieurs voix dans une seule requête SSML. Dans l'exemple suivant, la voix par défaut est une voix masculine anglaise. Tous les mots seront synthétisés dans cette voix à l'exception de "qu'est-ce qui t'amène ici", qui sera verbalisé en français à l'aide d'une voix féminine par rapport à la langue par défaut (anglais) et du genre (masculin).

<speak>And then she asked, <voice language="fr-FR" gender="female">qu'est-ce qui
t'amène ici</voice><break time="250ms"/> in her sweet and gentle voice.</speak>

Vous pouvez également utiliser un tag <voice> pour spécifier une voix individuelle (le nom de la voix sur la page Voix disponibles) plutôt que de spécifier une voix. language et/ou gender :

<speak>The dog is friendly<voice name="fr-CA-Wavenet-B">mais la chat est
mignon</voice><break time="250ms"/> said a pet shop
owner</speak>

Lorsque vous utilisez le tag <voice>, Text-to-Speech s'attend à recevoir un name (le nom de la voix que vous souhaitez utiliser) ou une combinaison des attributs suivants. Les trois attributs sont facultatifs, mais vous devez en fournir au moins un si vous ne fournissez pas de name.

gender : soit "homme", "femme" ou "neutre".
variant : utilisé comme condition de départage lorsqu'il existe plusieurs possibilités d'utilisation de la voix en fonction de votre configuration.
language : la langue de votre choix. Une seule langue peut être spécifiée dans un tag <voice> donné. Spécifiez la langue au format BCP-47. Le code BCP-47 correspondant à votre langue figure dans la colonne Code de langue de la page Voix et langues prises en charge.

Vous pouvez également contrôler la priorité relative de chacun des attributs gender, variant et language à l'aide de deux tags supplémentaires : required et ordering.

required : si un attribut est désigné comme required et n'est pas configuré correctement, la requête échoue.
ordering : tous les attributs répertoriés après un tag ordering sont considérés comme des attributs préférés et non obligatoires. L'API Text-to-Speech considère les attributs préférés de la façon la plus optimale possible dans l'ordre dans lequel ils sont répertoriés après le tag ordering. Si certains des attributs préférés ne sont pas configurés correctement, Text-to-Speech peut toujours renvoyer une voix valide, mais avec une configuration incorrecte.

Exemples de configurations utilisant les tags required et ordering :

<speak>And there it was <voice language="en-GB" gender="male" required="gender"
ordering="gender language">a flying bird </voice>roaring in the skies for the
first time.</speak>

<speak>Today is supposed to be <voice language="en-GB" gender="female"
ordering="language gender">Sunday Funday.</voice></speak>

`<lang>`

Vous pouvez utiliser <lang> pour inclure du texte dans plusieurs langues au sein de la même requête SSML. Toutes les langues seront synthétisées dans la même voix, sauf si vous utilisez le tag <voice> pour modifier explicitement la voix. La chaîne xml:lang doit contenir la langue cible au format BCP-47 (cette valeur est répertoriée en tant que "code de langue" dans le tableau Voix disponibles). Dans l'exemple suivant, "chat" sera verbalisé en français plutôt que dans la langue par défaut (anglais) :

<speak>The french word for cat is <lang xml:lang="fr-FR">chat</lang></speak>

Text-to-Speech accepte au mieux le tag <lang>. Toutes les combinaisons de langues ne produisent pas les mêmes résultats de qualité si elles sont spécifiées dans la même requête SSML. Dans certains cas, une combinaison linguistique peut produire un effet détectable, mais subtil ou perçu comme étant négatif. Problèmes connus :

Le japonais avec des caractères kanji n'est pas compatible avec le tag <lang>. L'entrée est translittéré et lue en tant que caractères chinois.
Les langues sémitiques telles que l'arabe, l'hébreu et le persan ne sont pas compatibles avec le tag <lang> et produisent un silence. Si vous souhaitez utiliser l'une de ces langues, nous vous recommandons d'utiliser le tag <voice> pour basculer vers une voix qui parle la langue souhaitée (le cas échéant).

Repères temporels SSML

L'API Text-to-Speech permet d'utiliser des repères temporels dans les données audio que vous avez créées. Un repère temporel est un code temporel (en secondes, mesuré à partir du début du contenu audio généré) correspondant à un moment donné du script. Vous pouvez définir un moment précis dans votre script à l'aide du tag . Une fois le contenu audio généré, l'API renvoie l'horodatage entre le début du contenu audio et le repère temporel.

Pour définir un repère temporel, suivez les deux étapes suivantes :

Ajoutez un tag SSML  à un moment donné du script pour lequel vous souhaitez obtenir un code temporel.
Définissez TimepointType sur SSML_MARK. Si ce champ n'est pas défini, les repères temporels ne sont pas renvoyés par défaut.

L'exemple suivant renvoie deux repères temporels :

timepoint_1 : indique la durée (en secondes) pendant laquelle le mot "Mark" apparaît dans le fichier audio généré.
timepoint_2 : indique la durée (en secondes) pendant laquelle le mot "see" apparaît dans le contenu audio généré.

<speak>Hello <mark name="timepoint_1"/> Mark. Good to <mark
name="timepoint_2"/> see you.</speak>

Styles

Les voix suivantes peuvent parler dans plusieurs styles :

en-US-Neural2-F
en-US-Neural2-J

Utilisez la balise <google:style> pour contrôler le style à utiliser. N'utilisez la balise que pour des phrases complètes.

Exemple :

<speak><google:style name="lively">Hello I'm so happy today!</google:style></speak>

Le champ name accepte les valeurs suivantes :

apologetic
calm
empathetic
firm
lively

Langage de balisage de synthèse vocale (SSML)

Conseils pour l'utilisation de SSML

Caractères réservés

Sélectionner une voix

Compatibilité des éléments SSML

<speak>

Exemple

<break>

Attributs

Exemple

<say‑as>

Exemples

<audio>

Attributs

Exemple

<p>,<s>

Exemple

Bonnes pratiques

<sub>

Exemples

<mark>

Exemple

<prosody>

Exemple

<emphasis>

Exemple

<par>

Exemple

<seq>

Exemple

<media>

Attributs

Spécification temporelle

<phoneme>

Marqueurs de stress

Transcriptions larges et étroites

Réduction

Syllabification

Dictionnaire de prononciation personnalisé

Durées

<voice>

<lang>

Repères temporels SSML

Styles

`<speak>`

`<break>`

`<say‑as>`

`<audio>`

`<p>,<s>`

`<sub>`

`<mark>`

`<prosody>`

`<emphasis>`

`<par>`

`<seq>`

`<media>`

`<phoneme>`

`<voice>`

`<lang>`