├── .gitignore ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── agent.zip ├── firebase.json └── functions ├── .eslintrc.json ├── app.js ├── index.js ├── package.json ├── responses.js └── utils.js /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | package-lock.json 3 | *.DS_store 4 | *.log 5 | .firebaserc 6 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # How to become a contributor and submit your own code 2 | 3 | ## Contributor License Agreements 4 | 5 | We'd love to accept your sample apps and patches! Before we can take them, we 6 | have to jump a couple of legal hurdles. 7 | 8 | Please fill out either the individual or corporate Contributor License Agreement 9 | (CLA). 10 | 11 | * If you are an individual writing original source code and you're sure you 12 | own the intellectual property, then you'll need to sign an [individual CLA](https://developers.google.com/open-source/cla/individual). 13 | * If you work for a company that wants to allow you to contribute your work, 14 | then you'll need to sign a [corporate CLA](https://developers.google.com/open-source/cla/corporate). 15 | 16 | Follow either of the two links above to access the appropriate CLA and 17 | instructions for how to sign and return it. Once we receive it, we'll be able to 18 | accept your pull requests. 19 | 20 | ## Contributing A Patch 21 | 22 | 1. Submit an issue describing your proposed change to the repo in question. 23 | 1. The repo owner will respond to your issue promptly. 24 | 1. If your proposed change is accepted, and you haven't already done so, sign a 25 | Contributor License Agreement (see details above). 26 | 1. Fork the desired repo, develop and test your code changes. 27 | 1. Ensure that your code adheres to the existing style in the sample to which 28 | you are contributing. Refer to the 29 | [Google Cloud Platform Samples Style Guide](https://github.com/GoogleCloudPlatform/Template/wiki/style.html) for the 30 | recommended coding standards for this organization. 31 | 1. Ensure that your code has an appropriate set of unit tests which all pass. 32 | 1. Submit a pull request. 33 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Actions on Google: SSML Sample 2 | 3 | *:warning: Warning: Conversational Actions will be deprecated on June 13, 2023. For more information, see [Conversational Actions Sunset](https://goo.gle/ca-sunset).* 4 | 5 | 6 | This sample demonstrates Actions on Google features for use on Google Assistant including Speech Synthesis Markup Language -- using the [Node.js client library](https://github.com/actions-on-google/actions-on-google-nodejs) and deployed on [Cloud Functions for Firebase](https://firebase.google.com/docs/functions/). 7 | 8 | :warning: This code sample was built using Dialogflow. We now recommend using [Actions Builder or the Actions SDK](https://developers.google.com/assistant/conversational/overview) to develop, test, and deploy Conversational Actions. 9 | 10 | ## Setup Instructions 11 | ### Prerequisites 12 | 1. Node.js and NPM 13 | + We recommend installing using [NVM](https://github.com/creationix/nvm) 14 | 1. Install the [Firebase CLI](https://developers.google.com/assistant/actions/dialogflow/deploy-fulfillment) 15 | + We recommend using version 6.5.0, `npm install -g firebase-tools@6.5.0` 16 | + Run `firebase login` with your Google account 17 | 18 | ### Configuration 19 | #### Actions Console 20 | 1. From the [Actions on Google Console](https://console.actions.google.com/), New project > **Create project** > under **More options** > **Conversational** 21 | 1. From the top menu under **Develop** > **Actions** (left nav) > **Add your first action** > **BUILD** (this will bring you to the Dialogflow console) > Select language and time zone > **CREATE**. 22 | 1. In the Dialogflow console, go to **Settings** ⚙ > **Export and Import** > **Restore from zip** using the `agent.zip` in this sample's directory. 23 | 24 | #### Firebase Deployment 25 | 1. On your local machine, in the `functions` directory, run `npm install` 26 | 1. Run `firebase deploy --project {PROJECT_ID}` to deploy the function 27 | + To find your **Project ID**: In [Dialogflow console](https://console.dialogflow.com/) under **Settings** ⚙ > **General** tab > **Project ID**. 28 | 29 | #### Dialogflow Console 30 | 1. Return to the [Dialogflow Console](https://console.dialogflow.com) > select **Fulfillment** > **Enable** Webhook > Set **URL** to the **Function URL** that was returned after the deploy command > **SAVE**. 31 | ``` 32 | Function URL (dialogflowFirebaseFulfillment): https://${REGION}-${PROJECT_ID}.cloudfunctions.net/dialogflowFirebaseFulfillment 33 | ``` 34 | 1. From the left navigation menu, click **Integrations** > **Integration Settings** under Google Assistant > Enable **Auto-preview changes** > **Test** to open the Actions on Google simulator then say or type `Talk to my test app`. 35 | 36 | ### Running this Sample 37 | + You can test your Action on any Google Assistant-enabled device on which the Assistant is signed into the same account used to create this project. Just say or type, “OK Google, talk to my test app”. 38 | + You can also use the Actions on Google Console simulator to test most features and preview on-device behavior. 39 | 40 | ## References & Issues 41 | + Questions? Go to [StackOverflow](https://stackoverflow.com/questions/tagged/actions-on-google), [Assistant Developer Community on Reddit](https://www.reddit.com/r/GoogleAssistantDev/) or [Support](https://developers.google.com/assistant/support). 42 | + For bugs, please report an issue on Github. 43 | + Actions on Google [Documentation](https://developers.google.com/assistant) 44 | + Actions on Google [Codelabs](https://codelabs.developers.google.com/?cat=Assistant) 45 | + [Webhook Boilerplate Template](https://github.com/actions-on-google/dialogflow-webhook-boilerplate-nodejs) for Actions on Google 46 | 47 | ## Make Contributions 48 | Please read and follow the steps in the [CONTRIBUTING.md](CONTRIBUTING.md). 49 | 50 | ## License 51 | See [LICENSE](LICENSE). 52 | 53 | ## Terms 54 | Your use of this sample is subject to, and by using or downloading the sample files you agree to comply with, the [Google APIs Terms of Service](https://developers.google.com/terms/). 55 | -------------------------------------------------------------------------------- /agent.zip: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/actions-on-google/dialogflow-ssml-nodejs/7f90ea9d081d0fdd479c5b4a75ed76dfeeb6c8ae/agent.zip -------------------------------------------------------------------------------- /firebase.json: -------------------------------------------------------------------------------- 1 | {} 2 | -------------------------------------------------------------------------------- /functions/.eslintrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "parserOptions": { 3 | "ecmaVersion": 7, 4 | "sourceType": "script" 5 | }, 6 | "extends": ["google"], 7 | "env": { 8 | "node": true 9 | } 10 | } 11 | -------------------------------------------------------------------------------- /functions/app.js: -------------------------------------------------------------------------------- 1 | // Copyright 2017, Google, Inc. 2 | // Licensed under the Apache License, Version 2.0 (the 'License'); 3 | // you may not use this file except in compliance with the License. 4 | // You may obtain a copy of the License at 5 | // 6 | // http://www.apache.org/licenses/LICENSE-2.0 7 | // 8 | // Unless required by applicable law or agreed to in writing, software 9 | // distributed under the License is distributed on an 'AS IS' BASIS, 10 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 11 | // See the License for the specific language governing permissions and 12 | // limitations under the License. 13 | 14 | 'use strict'; 15 | 16 | const app = require('actions-on-google').dialogflow({debug: true}); 17 | const {completeResponses, examples} = require('./responses'); 18 | 19 | const welcome = (conv) => { 20 | conv.ask(completeResponses.welcome); 21 | conv.ask(completeResponses.examplesList); 22 | }; 23 | 24 | const fallback = (conv) => { 25 | conv.ask(completeResponses.didNotUnderstand); 26 | conv.ask(completeResponses.examplesList); 27 | }; 28 | 29 | const chooseExample = (conv, params) => { 30 | const element = params.element; 31 | if (!element) return fallback(conv); 32 | conv.ask(completeResponses.leadToExample(element)); 33 | conv.ask(examples[element]); 34 | }; 35 | 36 | app.intent('Welcome', welcome); 37 | app.intent('Fallback', fallback); 38 | app.intent('Choose Example', chooseExample); 39 | 40 | module.exports = app; 41 | -------------------------------------------------------------------------------- /functions/index.js: -------------------------------------------------------------------------------- 1 | // Copyright 2017, Google, Inc. 2 | // Licensed under the Apache License, Version 2.0 (the 'License'); 3 | // you may not use this file except in compliance with the License. 4 | // You may obtain a copy of the License at 5 | // 6 | // http://www.apache.org/licenses/LICENSE-2.0 7 | // 8 | // Unless required by applicable law or agreed to in writing, software 9 | // distributed under the License is distributed on an 'AS IS' BASIS, 10 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 11 | // See the License for the specific language governing permissions and 12 | // limitations under the License. 13 | 14 | 'use strict'; 15 | 16 | const functions = require('firebase-functions'); 17 | const app = require('./app'); 18 | 19 | module.exports.dialogflowFirebaseFuflfillment = functions.https.onRequest(app); 20 | -------------------------------------------------------------------------------- /functions/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "ssml-examples", 3 | "description": "SSML Examples in Actions on Google for the Google Assistant", 4 | "version": "0.0.1", 5 | "private": true, 6 | "license": "Apache Version 2.0", 7 | "author": "Google Inc.", 8 | "engines": { 9 | "node": "8" 10 | }, 11 | "scripts": { 12 | "lint": "eslint --fix \"**/*.js\"", 13 | "test": "npm run lint", 14 | "start": "firebase serve --only functions", 15 | "deploy": "firebase deploy --only functions", 16 | "logs": "firebase functions:log" 17 | }, 18 | "dependencies": { 19 | "actions-on-google": "^2.6.0", 20 | "firebase-admin": "^7.2.0", 21 | "firebase-functions": "^2.2.1" 22 | }, 23 | "devDependencies": { 24 | "eslint": "^4.19.0", 25 | "eslint-config-google": "^0.9.1" 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /functions/responses.js: -------------------------------------------------------------------------------- 1 | // Copyright 2017, Google, Inc. 2 | // Licensed under the Apache License, Version 2.0 (the 'License'); 3 | // you may not use this file except in compliance with the License. 4 | // You may obtain a copy of the License at 5 | // 6 | // http://www.apache.org/licenses/LICENSE-2.0 7 | // 8 | // Unless required by applicable law or agreed to in writing, software 9 | // distributed under the License is distributed on an 'AS IS' BASIS, 10 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 11 | // See the License for the specific language governing permissions and 12 | // limitations under the License. 13 | 14 | /* eslint max-len: 0 */ 15 | 16 | 'use strict'; 17 | 18 | const {ssml} = require('./utils'); 19 | 20 | const examples = { 21 | 'break': ssml` 22 | 23 | Step 1, take a deep breath. 24 | Step 2, exhale. 25 | 26 | `, 27 | 'say-as': ssml` 28 | 29 | This interprets "12345" normally. 30 | This interprets "12345" as a cardinal. 31 | This interprets "1" normally. 32 | This interprets "1" as an ordinal. 33 | This interprets "can" normally. 34 | This interprets "can" as characters. 35 | This interprets "5+1/2" normally. 36 | This interprets "5+1/2" as a fraction. 37 | This interprets "censored" normally. 38 | This interprets "censored" as an expletive. 39 | This interprets "10 foot" normally. 40 | This interprets "10 foot" as a unit. 41 | This interprets "abcdefg" normally. 42 | This interprets "abcdefg" as verbatim. 43 | This interprets "1960-09-10" normally. 44 | This interprets "1960-09-10" as a date. 45 | This interprets "2:30pm" normally. 46 | This interprets "2:30pm" as a time. 47 | This interprets "(781) 771-7777" normally. 48 | This interprets " 49 | (781) 771-7777 50 | " as a telephone number. 51 | 52 | `, 53 | 'audio': ssml` 54 | 55 | 59 | 60 | `, 61 | 'paragraph': ssml` 62 | 63 |

64 | This is sentence one. 65 | This is sentence two. 66 |

67 | 68 | `, 69 | 'sub': ssml` 70 | 71 | This is speaking "W3C" normally. 72 | This is speaking "W3C" using the sub tag. 73 | 74 | `, 75 | 'prosody': ssml` 76 | 77 | 78 | My name is Wonder Woman. 79 | 80 | 81 | Hi, my name is lowly worm. 82 | Hi, my name is huckleberry cat. 83 | Was that fun? 84 | Hi I'm speaking fast. 85 | I'm speaking slow. 86 | I'm speaking softly. 87 | I'm speaking loud 88 | I'm speaking high. 89 | I'm speaking deep. 90 | 91 | `, 92 | 'emphasis': ssml` 93 | 94 | I would like to emphasize the importance of SSML. 95 | I told you to pick up those toys an hour ago. 96 | I told you to pick up those toys an hour ago. 97 | I told you to pick up those toys an hour ago. 98 | I told you to pick up those toys an hour ago. 99 | I told you to pick up those toys an hour ago. 100 | 101 | `, 102 | 'speed': ssml` 103 | 104 | This is without prosody. 105 | This is speaking at 100% rate. 106 | This is speaking at 150% rate. 107 | This is speaking at normal rate. 108 | This is speaking at 200% rate. 109 | This is speaking at medium rate. 110 | This is speaking at 300% rate. 111 | This is speaking at default rate. 112 | This is speaking at 75% rate. 113 | This is speaking at 50% rate. 114 | This is speaking at 25% rate. 115 | This is speaking at 10% rate. 116 | 117 | `, 118 | 'volume': ssml` 119 | 120 | This is without prosody. 121 | This is speaking at +5dB volume. 122 | This is speaking at 100% volume. 123 | This is speaking at loud volume. 124 | This is speaking at +10dB volume. 125 | This is speaking at medium volume. 126 | This is speaking at x-loud volume. 127 | This is speaking at default volume. 128 | This is speaking at -5dB volume. 129 | This is speaking at -10dB volume. 130 | This is speaking at soft volume. 131 | This is speaking at x-soft volume. 132 | 133 | `, 134 | 'pitch': ssml` 135 | 136 | This is without prosody. 137 | This is speaking at +6 semitones pitch. 138 | This is speaking at high pitch. 139 | This is speaking at +0 semitones pitch. 140 | This is speaking at medium pitch. 141 | This is speaking at default pitch. 142 | This is speaking at +200% pitch. 143 | This is speaking at +12 semitones pitch. 144 | This is speaking at x-high pitch. 145 | This is speaking at -6 semitones pitch. 146 | This is speaking at low pitch. 147 | This is speaking at -12 semitones pitch. 148 | This is speaking at x-low pitch. 149 | 150 | `, 151 | 'layered': ssml` 152 | 153 | The key element for layered sound mixing is ${''} 154 | (as in "parallel") which inserts a mixed sound at the current point of the TTS. 155 | It is similar to the ${'

'} 156 | element with an important difference of not displaying 157 | the text content in chat bubbles on surfaces with displays. 158 | 159 | 160 | 161 | This media element contains a ${''} for TTS. 162 | It has an xml:id attribute so that other 163 | ${''} elements can refer to it. 164 | There is also a "begin" attribute that delays the start time by 2.5 seconds. 165 | Millisecond units are also supported by the 166 | ms suffix. 167 | 168 | 169 | 170 | 174 | 175 | 176 | 177 | This TTS starts 1234 milliseconds 178 | after the end of the media element with the 179 | xml:id equal to "first_thing". 180 | 181 | 182 | 183 | 184 | `, 185 | }; 186 | 187 | const baseResponses = { 188 | askExample: 'Ask me for an example of a SSML element.', 189 | }; 190 | 191 | const elements = Object.keys(examples); 192 | 193 | const completeResponses = { 194 | examplesList: `You can ask me about ${elements.slice(0, elements.length - 1).join(', ')}` + 195 | `, and ${elements[elements.length - 1]}.`, 196 | didNotUnderstand: `Sorry, I didn't understand you. ${baseResponses.askExample}.`, 197 | welcome: `Welcome! ${baseResponses.askExample} ` + 198 | `You can say "give me an example of the prosody element".`, 199 | /** 200 | * @param {string} element 201 | * @return {string} 202 | */ 203 | leadToExample: (element) => `Ok, here's an SSML example of ${element}.`, 204 | }; 205 | 206 | module.exports = {completeResponses, examples}; 207 | -------------------------------------------------------------------------------- /functions/utils.js: -------------------------------------------------------------------------------- 1 | // Copyright 2017, Google, Inc. 2 | // Licensed under the Apache License, Version 2.0 (the 'License'); 3 | // you may not use this file except in compliance with the License. 4 | // You may obtain a copy of the License at 5 | // 6 | // http://www.apache.org/licenses/LICENSE-2.0 7 | // 8 | // Unless required by applicable law or agreed to in writing, software 9 | // distributed under the License is distributed on an 'AS IS' BASIS, 10 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 11 | // See the License for the specific language governing permissions and 12 | // limitations under the License. 13 | 14 | 'use strict'; 15 | 16 | /** 17 | * Sanitize template literal inputs by escaping characters into XML entities 18 | * to use in SSML 19 | * Also normalize the extra spacing for better text rendering in SSML 20 | * A tag function used by ES6 tagged template literals 21 | * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference 22 | * /Template_literals#Tagged_template_literals 23 | * 24 | * @example 25 | * const equation = '"1 + 1 > 1"'; 26 | * const response = ssml` 27 | * 28 | * ${equation} 29 | * 30 | * `; 31 | * // Equivalent to ssml`\n \n ${equation}\n \n` 32 | * console.log(response); 33 | * 34 | * Prints: 35 | * ` 36 | * "1 + 1 > 1" 37 | * ` 38 | * Equivalent to 39 | * '\n "1 + 1 > 1"\n' 40 | * 41 | * @param {TemplateStringsArray} template 42 | * Non sanitized constant strings in the template literal 43 | * @param {Array} inputs 44 | * Computed expressions to be sanitized surrounded by ${} 45 | * @return {string} 46 | */ 47 | const ssml = (template, ...inputs) => { 48 | // Generate the raw escaped string 49 | const raw = template.reduce((out, str, i) => i 50 | ? out + ( 51 | inputs[i - 1] 52 | .replace(/&/g, '&') 53 | .replace(//g, '>') 55 | .replace(/"/g, '"') 56 | ) + str 57 | : str 58 | ); 59 | // Trim out new lines at the start and end but keep indentation 60 | const trimmed = raw 61 | .replace(/^\s*\n(\s*)/, '$1') 62 | .replace(/<\/speak>\s+$/, ''); 63 | // Remove extra indentation 64 | const lines = trimmed.split('\n'); 65 | const indent = /^\s*/.exec(lines[0])[0]; 66 | const match = new RegExp(`^${indent}`); 67 | return lines.map((line) => line.replace(match, '')).join('\n'); 68 | }; 69 | 70 | module.exports = {ssml}; 71 | --------------------------------------------------------------------------------