From 6fd131a5fdbe4562461e97be5d5b354c2c59ff5f Mon Sep 17 00:00:00 2001 From: Kelly J Andrews Date: Tue, 27 Aug 2019 09:03:35 -0400 Subject: [PATCH] updates to readme --- README.md | 29 +++++++++++++++++++---------- 1 file changed, 19 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 25b86c6..b6cf20b 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,15 @@ # Nexmo Voice API Call Transcription with Amazon Transcribe - + This is example code for a [tutorial](https://developer.nexmo.com/use-cases/trancribe-amazon-api) that shows you how to transcribe a phone call automatically using the Amazon Transcribe API. You'll need two handsets with two different phone numbers to test this. It uses the Nexmo Voice API to initiate and record the call. The call audio is created in your local `recordings` folder and uploaded to an S3 bucket. Amazon Cloudwatch triggers a serverless Lambda function when the transcription job has completed. Transcripts are created in S3 and downloaded to your application's `transcripts` folder. - + ## Welcome to Nexmo - + If you're new to Nexmo, you can [sign up for a Nexmo account](https://dashboard.nexmo.com/sign-up?utm_source=DEV_REL&utm_medium=github&utm_campaign=amazon-transcribe-call) and get some free credit to get you started. - + ## Setup ### Install the Nexmo CLI @@ -105,6 +105,8 @@ serverless deploy ## Running the code +### Local Install + 1. In the root directory of your application, execute: ``` @@ -117,21 +119,29 @@ node index.js 4. Watch the console as the transcription job is being processed. If everything works properly, you should receive a notification that your job is complete and you should find the call audio file in your `recordings` directory and the corresponding transcript (in JSON format) in `transcripts`. Note how the transcript is split into channels, one for each device you used. The application parses the completed transcription and displays the result for each channel in the console. +### Docker Compose + +You can also run the code using Docker Compose using the following command. + +``` +docker-compose up +``` + ## Adding more callers If you have more than two numbers, you can add more callers to the conversation. Simply create a `connect` action for each in the `/webhooks/answer` NCCO and increase the number of channels in the `record` action accordingly. - + ## Getting Help - + We love to hear from you so if you have questions, comments or find a bug in the project, let us know! You can either: - + * Open an issue on this repository * Tweet at us! We're [@NexmoDev on Twitter](https://twitter.com/NexmoDev) * Or [join the Nexmo Community Slack](https://developer.nexmo.com/community/slack) - + ## Further Reading -* Read the [tutorial](https://developer.nexmo.com/use-cases/trancribe-amazon-api) that accompanies this demo application to learn how it was put together. +* Read the [tutorial](https://developer.nexmo.com/use-cases/trancribe-amazon-api) that accompanies this demo application to learn how it was put together. * Nexmo Voice API * [Voice API call recording guide](/voice/voice-api/guides/recording) * ["Record a call" code snippet](/voice/voice-api/code-snippets/record-a-call) @@ -144,4 +154,3 @@ We love to hear from you so if you have questions, comments or find a bug in the * [Amazon S3 documentation](https://docs.aws.amazon.com/s3/) * [Amazon CloudWatch documentation](https://docs.aws.amazon.com/cloudwatch/) * [Amazon Lambda](https://docs.aws.amazon.com/lambda/) -