Lyrebird Vocal Avatar API Sample Actions on Google Home

A sample app for the Google Assistant that uses Lyrebird Vocal Avatar API, Node.js and Cloud Functions for Firebase

Setup Instructions

See the developer guide and release notes at https://developers.google.com/actions/ for more details.

Steps

Lyrebird Vocal Avatar API Application

1. If you don't have developer access to the Lyrebird Vocal Avatar API, ask for an access by sending an email to support@lyrebird.ai.
2. Go to the Applications and create a new application.
3. Note the CLIENT_ID and the CLIENT_SECRET given to you.
4. In the .env in the functions folder, edit the LYREBIRD_CLIENT_ID and LYREBIRD_CLIENT_SECRET by using the ones just provided to you.

Dialog Flow - Actions on Google Setup

1. Use the Actions on Google Console to add a new project with a name of your choosing and click Create Project.
2. Click Skip, located on the top right to skip over category selection menu.
3. On the left navigation menu under BUILD, click on Actions. Click on Add Your First Action and choose your app's language(s).
4. Select Custom intent, click BUILD. This will open a Dialogflow console. Click CREATE.
5. Click on the gear icon to see the project settings.
6. Select Export and Import.
7. Select Restore from zip. Follow the directions to restore from the Lyrebird-Vocal-Avatar-API-Sample.zip file in this repo.
8. Deploy the fulfillment webhook provided in the functions folder using Google Cloud Functions for Firebase:
   1. Follow the instructions to set up and initialize Firebase SDK for Cloud Functions. Make sure to select the project that you have previously generated in the Actions on Google Console and to reply N when asked to overwrite existing files by the Firebase CLI.
   2. In the .env update your FIREBASE_PROJECT_ID by using the one just provided to you.
   3. Run firebase deploy --only functions and take note of the endpoint where the fulfillment webhook has been published. It should look like Function URL (lyrebirdVocalAvatarSample): https://${REGION}-${PROJECT}.cloudfunctions.net/lyrebirdVocalAvatarSample
9. Go back to the Dialogflow console and select Fulfillment from the left navigation menu. Enable Webhook, set the value of URL to the Function URL from the previous step, then click Save.
10. Select Integrations from the left navigation menu and open the Integration Settings menu for Actions on Google.
11. Enable Auto-preview changes and Click Test. This will open the Actions on Google simulator.
12. Type Talk to my test app in the simulator, or say OK Google, talk to my test app to any Actions on Google enabled device signed into your developer account.

For more detailed information on deployment, see the documentation.

References and How to report bugs

• If you find any issues, please open a bug here on GitHub.
• Actions on Google documentation: https://developers.google.com/actions/.
• Questions are answered on StackOverflow.

How to make contributions?

Please read and follow the steps in the CONTRIBUTING.md.

License

See LICENSE.

Terms

Your use of this sample is subject to, and by using or downloading the sample files you agree to comply with, the Lyrebird APIs Terms of Service.

Slack Group

If you have some questions, please visit our slack group: https://avatar-api-support.slack.com/.