Skip to content

Commit a1131de

Browse files
committed
chore(sample): update doc
1 parent 1db7b39 commit a1131de

File tree

1 file changed

+23
-4
lines changed

1 file changed

+23
-4
lines changed

samples/speech-to-speech/README.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111
- [Usage](#usage)
1212
- [Load testing](#load-testing)
1313
- [Clean Up](#clean-up)
14+
- [Content Security Legal Disclaimer](#content-security-legal-disclaimer)
15+
- [Operational Metrics Collection](#operational-metrics-collection)
1416

1517
## Overview
1618

@@ -60,7 +62,14 @@ The solution consists of three main components:
6062
- [Git](https://git-scm.com/downloads)
6163
- [AWS CDK Toolkit](https://docs.aws.amazon.com/cdk/v2/guide/cli.html)
6264
- [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html)
63-
- Node.js 16.x or higher
65+
```
66+
aws configure --profile [your-profile]
67+
AWS Access Key ID [None]: xxxxxx
68+
AWS Secret Access Key [None]:yyyyyyyyyy
69+
Default region name [None]: us-east-1
70+
Default output format [None]: json
71+
```
72+
- Node.js: v18.12.1 or higher
6473
- npm 8.x or higher
6574
- Ensure you enable model access to Amazon Nova Sonic in the [Bedrock console](https://us-east-1.console.aws.amazon.com/bedrock/home?region=us-east-1#/modelaccess) in the region you intend to deploy this sample. For an up to date list of supported regions for Amazon Nova Sonic, please refer to the [documentation](https://docs.aws.amazon.com/bedrock/latest/userguide/models-regions.html)
6675
- Chrome, Safari, or Edge browser environment (Firefox is currently not supported)
@@ -149,6 +158,8 @@ The build output in `frontend/dist/` directory will be automatically deployed by
149158
cdk deploy --require-approval=never
150159
```
151160

161+
The command above will deploy one stack in your account. With the default configuration of this sample, the observed deployment time was ~646 seconds (10.5 minutes).
162+
152163
Get the CloudFront domain name:
153164

154165
```shell
@@ -158,7 +169,7 @@ aws cloudformation describe-stacks \
158169
--output text
159170
```
160171

161-
The frontend can be accessed at the domain name above.
172+
The frontend can be accessed at the domain name above (XXXX.cloudfront.net).
162173

163174
## User creation
164175

@@ -179,8 +190,8 @@ $ aws cloudformation describe-stacks --stack-name NovaSonicSolutionBackendStack
179190

180191
## Usage
181192

182-
1. Go to the application URL - `https://$CLOUDFRONT_URL/` (CloudFront domain from CDK outputs)
183-
2. Click on "Speech to Speech" in the navigation menu.
193+
1. Open your browser and go to the application URL (CloudFront domain from CDK outputs) previously recovered.
194+
2. Click on "Speech to Speech" in the sidebar navigation menu.
184195
3. Click the "Start Streaming" button. When prompted, allow access to your microphone.
185196
4. Begin speaking - you should see your speech being transcribed in real-time on the UI
186197
5. The assistant will automatically process your message and respond through speech
@@ -225,3 +236,11 @@ cdk destroy NovaSonicSolutionBackendStack
225236
Delete the associated logs created by the different services in Amazon CloudWatch logs.
226237

227238
Ensure S3 buckets are emptied before deletion.
239+
240+
## Content Security Legal Disclaimer
241+
242+
The sample code; software libraries; command line tools; proofs of concept; templates; or other related technology (including any of the foregoing that are provided by our personnel) is provided to you as AWS Content under the AWS Customer Agreement, or the relevant written agreement between you and AWS (whichever applies). You should not use this AWS Content in your production accounts, or on production or other critical data. You are responsible for testing, securing, and optimizing the AWS Content, such as sample code, as appropriate for production grade use based on your specific quality control practices and standards. Deploying AWS Content may incur AWS charges for creating or using AWS chargeable resources, such as running Amazon EC2 instances or using Amazon S3 storage.
243+
244+
## Operational Metrics Collection
245+
246+
This solution collects anonymous operational metrics to help AWS improve the quality and features of the solution. Data collection is subject to the AWS Privacy Policy (https://aws.amazon.com/privacy/). To opt out of this feature, simply remove the tag(s) starting with “uksb-” or “SO” from the description(s) in any CloudFormation templates or CDK TemplateOptions.

0 commit comments

Comments
 (0)