Skip to content

Commit

Permalink
chore: update supporting files
Browse files Browse the repository at this point in the history
  • Loading branch information
lukeocodes committed May 4, 2024
1 parent c4d10d6 commit 65fb2c7
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 18 deletions.
22 changes: 5 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,8 @@
# Deepgram Aura TTS Demo

> Project codename EmilyAI
# NextJS Live Transcription with Deepgram

[![Discord](https://dcbadge.vercel.app/api/server/xWRaCDBtW4?style=flat)](https://discord.gg/xWRaCDBtW4)

The purpose of this demo is to showcase how you can build a Conversational AI application that engages users in natural language interactions, mimicking human conversation through natural language processing using [Deepgram](https://deepgram.com/).

Examples of where you would see this type of application include: virtual assistants for tasks like answering queries and controlling smart devices, educational tutors for personalized learning, healthcare advisors for medical information, and entertainment chat bots for engaging conversations and games.

These applications aim to enhance user experiences by offering efficient and intuitive interactions, reducing the need for human intervention in various tasks and services.
The purpose of this demo is to showcase how you can build a NextJS speech to text app using [Deepgram](https://deepgram.com/).

## Issue Reporting

Expand All @@ -19,8 +13,6 @@ Check out our [KNOWN ISSUES](./KNOWN_ISSUES.md) before reporting.
## Demo features

- Capture streaming audio using [Deepgram Streaming Speech to Text](https://developers.deepgram.com/docs/getting-started-with-live-streaming-audio).
- Natural Language responses using an OpenAI LLM.
- Speech to Text conversion using [Deepgram Aura Text to Speech](https://developers.deepgram.com/docs/text-to-speech).

## What is Deepgram?

Expand All @@ -38,7 +30,7 @@ Follow these steps to get started with this starter application.

#### Clone the repository

Go to GitHub and [clone the repository](https://github.com/deepgram-starters/live-nextjs-starter).
Go to GitHub and [clone the repository](https://github.com/deepgram-starters/nextjs-live-transcription).

#### Install dependencies

Expand All @@ -53,14 +45,10 @@ npm install
Copy the code from `sample.env.local` and create a new file called `.env.local`.

```bash
DEEPGRAM_STT_DOMAIN=https://api.deepgram.com
DEEPGRAM_API_KEY=YOUR-DG-API-KEY
OPENAI_API_KEY=YOUR-OPENAI-API-KEY
```

1. For `DEEPGRAM_API_KEY` paste in the key you generated in the [Deepgram console](https://console.deepgram.com/).
2. Set `DEEPGRAM_STT_DOMAIN` to be `https://api.deepgram.com`.
3. `OPENAI_API_KEY` should be an OpenAI API Key that can access the chat completions API.
For `DEEPGRAM_API_KEY` paste in the key you generated in the [Deepgram console](https://console.deepgram.com/).

#### Run the application

Expand All @@ -74,7 +62,7 @@ npm run dev

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 in this repository](https://github.com/deepgram-devs/deepgram-aura-tts-demo/issues)
- [Open an issue in this repository](https://github.com/deepgram-starters/nextjs-live-transcription/issues)
- [Join the Deepgram Github Discussions Community](https://github.com/orgs/deepgram/discussions)
- [Join the Deepgram Discord Community](https://discord.gg/xWRaCDBtW4)

Expand Down
2 changes: 1 addition & 1 deletion deepgram.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[meta]
title = "Live audio Next.js Starter"
title = "NextJS Live Transcript with Deepgram"
description = "Basic demo for using Deepgram to transcribe microphone audio in Next.js"
author = "Deepgram DX Team <[email protected]> (https://developers.deepgram.com)"
useCase = "Live"
Expand Down

1 comment on commit 65fb2c7

@vercel
Copy link

@vercel vercel bot commented on 65fb2c7 May 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.