From 1000ca5b559d245236e5e7146d63def9d9442afb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aleix=20Conchillo=20Flaqu=C3=A9?= Date: Mon, 18 Mar 2024 10:38:27 -0700 Subject: [PATCH] add dot-env.template --- README.md | 11 +++-------- dot-env.template | 5 +++++ 2 files changed, 8 insertions(+), 8 deletions(-) create mode 100644 dot-env.template diff --git a/README.md b/README.md index 4dd3af33f..d852245a2 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,12 @@ Build things like this: -**`dailyai` started as a toolkit for implementing generative AI voice bots.** Things like personal coaches, meeting assistants, story-telling toys for kids, customer support bots, and snarky social companions. +**`dailyai` started as a toolkit for implementing generative AI voice bots.** Things like personal coaches, meeting assistants, story-telling toys for kids, customer support bots, and snarky social companions. In 2023 a *lot* of us got excited about the possibility of having open-ended conversations with LLMs. It became clear pretty quickly that we were all solving the same [low-level problems](https://www.daily.co/blog/how-to-talk-to-an-llm-with-your-voice/): - low-latency, reliable audio transport -- echo cancellation +- echo cancellation - phrase endpointing (knowing when the bot should respond to human speech) - interruptibility - writing clean code to stream data through "pipelines" of speech-to-text, LLM inference, and text-to-speech models @@ -55,11 +55,7 @@ Today, the easiest way to get started with `dailyai` is to use [Daily](https://w pip install dailyai # set up an .env file with API keys -# for example -OPENAI_API_KEY=... -ELEVENLABS_API_KEY=... -ELEVENLABS_VOICE_ID=... -DAILY_SAMPLE_ROOM_URL=https://... +cp dot-env.template .env # sign up for a free Daily account, if you don't already have one, and # join the Daily room URL directly from a browser tab, then run one of the @@ -103,4 +99,3 @@ If you want to use this package from another directory, you can run: ``` pip install path_to_this_repo ``` - diff --git a/dot-env.template b/dot-env.template new file mode 100644 index 000000000..60e09358a --- /dev/null +++ b/dot-env.template @@ -0,0 +1,5 @@ +OPENAI_API_KEY=... +ELEVENLABS_API_KEY=... +ELEVENLABS_VOICE_ID=... +DAILY_API_KEY=... +DAILY_SAMPLE_ROOM_URL=https://...