44 lines
2.2 KiB
Markdown
44 lines
2.2 KiB
Markdown
# AI SDK, Next.js, and OpenAI Chat Example
|
|
|
|
This example shows how to use the [AI SDK](https://ai-sdk.dev/docs) with [Next.js](https://nextjs.org/) and [OpenAI](https://openai.com) to create a ChatGPT-like AI-powered streaming chat bot.
|
|
|
|
## Deploy your own
|
|
|
|
Deploy the example using [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=ai-sdk-example):
|
|
|
|
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fvercel%2Fai%2Ftree%2Fmain%2Fexamples%2Fnext-openai&env=OPENAI_API_KEY&project-name=ai-sdk-next-openai&repository-name=ai-sdk-next-openai)
|
|
|
|
## How to use
|
|
|
|
Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init), [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/), or [pnpm](https://pnpm.io) to bootstrap the example:
|
|
|
|
```bash
|
|
npx create-next-app --example https://github.com/vercel/ai/tree/main/examples/next-openai next-openai-app
|
|
```
|
|
|
|
```bash
|
|
yarn create next-app --example https://github.com/vercel/ai/tree/main/examples/next-openai next-openai-app
|
|
```
|
|
|
|
```bash
|
|
pnpm create next-app --example https://github.com/vercel/ai/tree/main/examples/next-openai next-openai-app
|
|
```
|
|
|
|
To run the example locally you need to:
|
|
|
|
1. Sign up at [OpenAI's Developer Platform](https://platform.openai.com/signup).
|
|
2. Go to [OpenAI's dashboard](https://platform.openai.com/account/api-keys) and create an API KEY.
|
|
3. If you choose to use external files for attachments, then create a [Vercel Blob Store](https://vercel.com/docs/storage/vercel-blob).
|
|
4. Set the required environment variable as the token value as shown [the example env file](./.env.local.example) but in a new file called `.env.local`
|
|
5. `pnpm install` to install the required dependencies.
|
|
6. `pnpm dev` to launch the development server.
|
|
|
|
## Learn More
|
|
|
|
To learn more about OpenAI, Next.js, and the AI SDK take a look at the following resources:
|
|
|
|
- [AI SDK docs](https://ai-sdk.dev/docs)
|
|
- [Vercel AI Playground](https://ai-sdk.dev/playground)
|
|
- [OpenAI Documentation](https://platform.openai.com/docs) - learn about OpenAI features and API.
|
|
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
|