diff --git a/README.md b/README.md index 23ff29a..0f25d5b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# HeyGen Streaming Avatar NextJS Demo +# HeyGen Interactive Avatar NextJS Demo -![HeyGen Streaming Avatar NextJS Demo Screenshot](./public/demo.png) +![HeyGen Interactive Avatar NextJS Demo Screenshot](./public/demo.png) This is a sample project and was bootstrapped using [NextJS](https://nextjs.org/). Feel free to play around with the existing code and please leave any feedback for the SDK [here](https://github.com/HeyGen-Official/StreamingAvatarSDK/discussions). @@ -15,7 +15,7 @@ Feel free to play around with the existing code and please leave any feedback fo 3. Run `npm install` (assuming you have npm installed. If not, please follow these instructions: https://docs.npmjs.com/downloading-and-installing-node-js-and-npm/) -4. Enter your HeyGen Enterprise API Token or Trial Token in the `.env` file. Replace `PLACEHOLDER-API-KEY` with your API key. This will allow the Client app to generate secure Access Tokens with which to create streaming sessions. +4. Enter your HeyGen Enterprise API Token or Trial Token in the `.env` file. Replace `PLACEHOLDER-API-KEY` with your API key. This will allow the Client app to generate secure Access Tokens with which to create interactive sessions. You can retrieve either the API Key or Trial Token by logging in to HeyGen and navigating to this page in your settings: [https://app.heygen.com/settings?nav=API]. NOTE: use the trial token if you don't have an enterprise API token yet. @@ -25,35 +25,35 @@ Feel free to play around with the existing code and please leave any feedback fo ### Difference between Trial Token and Enterprise API Token -The HeyGen Trial Token is available to all users, not just Enterprise users, and allows for testing of the Streaming API, as well as other HeyGen API endpoints. +The HeyGen Trial Token is available to all users, not just Enterprise users, and allows for testing of the Interactive Avatar API, as well as other HeyGen API endpoints. -Each Trial Token is limited to 3 concurrent streaming sessions. However, every streaming session you create with the Trial Token is free of charge, no matter how many tasks are sent to the avatar. Please note that streaming sessions will automatically close after 10 minutes of no tasks sent. +Each Trial Token is limited to 3 concurrent interactive sessions. However, every interactive session you create with the Trial Token is free of charge, no matter how many tasks are sent to the avatar. Please note that interactive sessions will automatically close after 10 minutes of no tasks sent. -If you do not 'close' the streaming sessions and try to open more than 3, you will encounter errors including stuttering and freezing of the Streaming Avatar. Please endeavor to only have 3 sessions open at any time while you are testing the Streaming Avatar API with your Trial Token. +If you do not 'close' the interactive sessions and try to open more than 3, you will encounter errors including stuttering and freezing of the Interactive Avatar. Please endeavor to only have 3 sessions open at any time while you are testing the Interactive Avatar API with your Trial Token. ### Starting sessions NOTE: Make sure you have enter your token into the `.env` file and run `npm run dev`. -To start your 'session' with a Streaming Avatar, first click the 'start' button. If your HeyGen API key is entered into the Server's .env file, then you should see our demo Streaming Avatar (Monica!) appear. +To start your 'session' with a Interactive Avatar, first click the 'start' button. If your HeyGen API key is entered into the Server's .env file, then you should see our demo Interactive Avatar (Monica!) appear. -After you see Monica appear on the screen, you can enter text into the input labeled 'Repeat', and then hit Enter. The Streaming Avatar will say the text you enter. +After you see Monica appear on the screen, you can enter text into the input labeled 'Repeat', and then hit Enter. The Interactive Avatar will say the text you enter. If you want to see a different Avatar or try a different voice, you can close the session and enter the IDs and then 'start' the session again. Please see below for information on where to retrieve different Avatar and voice IDs that you can use. ### Connecting to OpenAI -A common use case for a Streaming Avatar is to use it as the 'face' of an LLM that users can interact with. In this demo we have included functionality to showcase this by both accepting user input via voice (using OpenAI's Whisper library) and also sending that input to an OpenAI LLM model (using their Chat Completions endpoint). +A common use case for a Interactive Avatar is to use it as the 'face' of an LLM that users can interact with. In this demo we have included functionality to showcase this by both accepting user input via voice (using OpenAI's Whisper library) and also sending that input to an OpenAI LLM model (using their Chat Completions endpoint). Both of these features of this demo require an OpenAI API Key. If you do not have a paid OpenAI account, you can learn more on their website: [https://openai.com/index/openai-api/] -Without an OpenAI API Key, this functionality will not work, and the Streaming Avatar will only be able to repeat text input that you provide, and not demonstrate being the 'face' of an LLM. Regardless, this demo is meant to demonstrate what kinds of apps and experiences you can build with our Streaming Avatar SDK, so you can code your own connection to a different LLM if you so choose. +Without an OpenAI API Key, this functionality will not work, and the Interactive Avatar will only be able to repeat text input that you provide, and not demonstrate being the 'face' of an LLM. Regardless, this demo is meant to demonstrate what kinds of apps and experiences you can build with our Interactive Avatar SDK, so you can code your own connection to a different LLM if you so choose. To add your Open AI API Key, fill copy it to the `OPENAI_API_KEY` and `NEXT_PUBLIC_OPENAI_API_KEY` variables in the `.env` file. ### How does the integration with OpenAI / ChatGPT work? -In this demo, we are calling the Chat Completions API from OpenAI in order to come up with some response to user input. You can see the relevant code in components/StreamingAvatar.tsx. +In this demo, we are calling the Chat Completions API from OpenAI in order to come up with some response to user input. You can see the relevant code in components/InteractiveAvatar.tsx. In the initialMessages parameter, you can replace the content of the 'system' message with whatever 'knowledge base' or context that you would like the GPT-4o model to reply to the user's input with. @@ -61,20 +61,20 @@ You can explore this API and the different parameters and models available here: ### Which Avatars can I use with this project? -By default, there are several Public Avatars that can be used in Streaming. (AKA Streaming Avatars.) You can find the Avatar IDs for these Public Avatars by navigating to [app.heygen.com/streaming-avatar](https://app.heygen.com/streaming-avatar) and clicking 'Select Avatar' and copying the avatar id. +By default, there are several Public Avatars that can be used in Interactive Avatar. (AKA Interactive Avatars.) You can find the Avatar IDs for these Public Avatars by navigating to [app.heygen.com/interactive-avatar](https://app.heygen.com/interactive-avatar) and clicking 'Select Avatar' and copying the avatar id. -In order to use a private Avatar created under your own account in Streaming, it must be upgraded to be a Streaming Avatar. Only 1. Finetune Instant Avatars and 2. Studio Avatars are able to be upgraded to Streaming Avatars. This upgrade is a one-time fee and can be purchased by navigating to [app.heygen.com/streaming-avatar] and clicking 'Select Avatar'. +In order to use a private Avatar created under your own account in Interactive Avatar, it must be upgraded to be a Interactive Avatar. Only 1. Finetune Instant Avatars and 2. Studio Avatars are able to be upgraded to Interactive Avatars. This upgrade is a one-time fee and can be purchased by navigating to [app.heygen.com/interactive-avatar] and clicking 'Select Avatar'. -Please note that Photo Avatars are not compatible with Streaming and cannot be used. +Please note that Photo Avatars are not compatible with Interactive Avatar and cannot be used. -### Which voices can I use with my Streaming Avatar? +### Which voices can I use with my Interactive Avatar? -Most of HeyGen's AI Voices can be used with the Streaming API. To find the Voice IDs that you can use, please use the List Voices v2 endpoint from HeyGen: [https://docs.heygen.com/reference/list-voices-v2] +Most of HeyGen's AI Voices can be used with the Interactive Avatar API. To find the Voice IDs that you can use, please use the List Voices v2 endpoint from HeyGen: [https://docs.heygen.com/reference/list-voices-v2] Please note that for voices that support Emotions, such as Christine and Tarquin, you need to pass in the Emotion string in the Voice Setting parameter: [https://docs.heygen.com/reference/new-session-copy#voicesetting] -You can also set the speed at which the Streaming Avatar speaks by passing in a Rate in the Voice Setting. +You can also set the speed at which the Interactive Avatar speaks by passing in a Rate in the Voice Setting. -### Where can I read more about enterprise-level usage of the Streaming API? +### Where can I read more about enterprise-level usage of the Interactive Avatar API? -Please read our Streaming Avatar 101 article for more information on pricing and how to increase your concurrent session limit: https://help.heygen.com/en/articles/9182113-streaming-avatar-101-your-ultimate-guide +Please read our Interactive Avatar 101 article for more information on pricing and how to increase your concurrent session limit: https://help.heygen.com/en/articles/9182113-interactive-avatar-101-your-ultimate-guide diff --git a/app/layout.tsx b/app/layout.tsx index 66def79..19f2cbb 100644 --- a/app/layout.tsx +++ b/app/layout.tsx @@ -19,8 +19,8 @@ const fontMono = FontMono({ export const metadata: Metadata = { title: { - default: "HeyGen Streaming Avatar SDK Demo", - template: `%s - HeyGen Streaming Avatar SDK Demo`, + default: "HeyGen Interactive Avatar SDK Demo", + template: `%s - HeyGen Interactive Avatar SDK Demo`, }, icons: { icon: "/heygen-logo.png", diff --git a/app/page.tsx b/app/page.tsx index 61a8b8b..eec5225 100644 --- a/app/page.tsx +++ b/app/page.tsx @@ -1,7 +1,7 @@ "use client"; -import StreamingAvatar from "@/components/StreamingAvatar"; -import StreamingAvatarCode from "@/components/StreamingAvatarCode"; +import InteractiveAvatar from "@/components/InteractiveAvatar"; +import InteractiveAvatarCode from "@/components/InteractiveAvatarCode"; import { Tab, Tabs } from "@nextui-org/react"; export default function App() { @@ -9,12 +9,12 @@ export default function App() { { id: "demo", label: "Demo", - content: , + content: , }, { id: "code", label: "Code", - content: , + content: , }, ]; diff --git a/components/StreamingAvatar.tsx b/components/InteractiveAvatar.tsx similarity index 98% rename from components/StreamingAvatar.tsx rename to components/InteractiveAvatar.tsx index 70ced66..d8b77ab 100644 --- a/components/StreamingAvatar.tsx +++ b/components/InteractiveAvatar.tsx @@ -21,14 +21,14 @@ import { useChat } from "ai/react"; import clsx from "clsx"; import OpenAI from "openai"; import { useEffect, useRef, useState } from "react"; -import StreamingAvatarTextInput from "./StreamingAvatarTextInput"; +import InteractiveAvatarTextInput from "./InteractiveAvatarTextInput"; const openai = new OpenAI({ apiKey: process.env.NEXT_PUBLIC_OPENAI_API_KEY, dangerouslyAllowBrowser: true, }); -export default function StreamingAvatar() { +export default function InteractiveAvatar() { const [isLoadingSession, setIsLoadingSession] = useState(false); const [isLoadingRepeat, setIsLoadingRepeat] = useState(false); const [isLoadingChat, setIsLoadingChat] = useState(false); @@ -53,7 +53,7 @@ export default function StreamingAvatar() { return; } - //send the ChatGPT response to the Streaming Avatar + //send the ChatGPT response to the Interactive Avatar await avatar.current .speak({ taskRequest: { text: message.content, sessionId: data?.sessionId }, @@ -352,7 +352,7 @@ export default function StreamingAvatar() { - -

This SDK supports the following behavior:

@@ -10,13 +10,13 @@ export default function StreamingAvatarCode() {

  • Start:

    Start the - streaming avatar session + Interactive Avatar session

  • Close:

    Close the - streaming avatar session + Interactive Avatar session
  • @@ -47,15 +47,15 @@ const TEXT = ` const [stream, setStream] = useState (); const mediaStream = useRef(null); - // Instantiate the streaming avatar api using your access token + // Instantiate the Interactive Avatar api using your access token const avatar = useRef(new StreamingAvatarApi( new Configuration({accessToken: ''}) )); - // State holding streaming avatar session data + // State holding Interactive Avatar session data const [sessionData, setSessionData] = useState(); - // Function to start the streaming avatar session + // Function to start the Interactive Avatar session async function start(){ const res = await avatar.current.createStartAvatar( { newSessionRequest: @@ -70,7 +70,7 @@ const TEXT = ` setSessionData(res); } - // Function to stop the streaming avatar session + // Function to stop the Interactive Avatar session async function stop(){ await avatar.current.stopAvatar({stopSessionRequest: {sessionId: sessionData?.sessionId}}); } @@ -82,7 +82,7 @@ const TEXT = ` } useEffect(()=>{ - // Handles the display of the streaming avatar + // Handles the display of the Interactive Avatar if(stream && mediaStream.current){ mediaStream.current.srcObject = stream; mediaStream.current.onloadedmetadata = () => { diff --git a/components/StreamingAvatarTextInput.tsx b/components/InteractiveAvatarTextInput.tsx similarity index 97% rename from components/StreamingAvatarTextInput.tsx rename to components/InteractiveAvatarTextInput.tsx index 7eb286b..c5e3d36 100644 --- a/components/StreamingAvatarTextInput.tsx +++ b/components/InteractiveAvatarTextInput.tsx @@ -13,7 +13,7 @@ interface StreamingAvatarTextInputProps { loading?: boolean; } -export default function StreamingAvatarTextInput({ +export default function InteractiveAvatarTextInput({ label, placeholder, input, diff --git a/components/NavBar.tsx b/components/NavBar.tsx index cb1b3ae..e61a92f 100644 --- a/components/NavBar.tsx +++ b/components/NavBar.tsx @@ -19,7 +19,7 @@ export default function NavBar() {

    - HeyGen Streaming Avatar SDK NextJS Demo + HeyGen Interactive Avatar SDK NextJS Demo

    @@ -28,7 +28,7 @@ export default function NavBar() { Avatars @@ -49,7 +49,7 @@ export default function NavBar() { Guide