https://github.com/jaleelb/ask-yp
AskYP is an open-source AI chatbot that uses OpenAI Functions and the Vercel AI SDK to interact with the Yelp Fusion API with natural language.
https://github.com/jaleelb/ask-yp
ai ai-sdk edge-functions nextjs openai openai-functions streaming vercel-ai yelp yelp-fusion-api
Last synced: about 1 year ago
JSON representation
AskYP is an open-source AI chatbot that uses OpenAI Functions and the Vercel AI SDK to interact with the Yelp Fusion API with natural language.
- Host: GitHub
- URL: https://github.com/jaleelb/ask-yp
- Owner: JaleelB
- License: mit
- Created: 2023-07-31T01:56:58.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-27T15:27:45.000Z (almost 3 years ago)
- Last Synced: 2025-05-07T20:03:49.621Z (about 1 year ago)
- Topics: ai, ai-sdk, edge-functions, nextjs, openai, openai-functions, streaming, vercel-ai, yelp, yelp-fusion-api
- Language: TypeScript
- Homepage: https://askyp.vercel.app
- Size: 1.02 MB
- Stars: 18
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Chat with Yelp using natural language. Built with OpenAI Functions, Vercel AI SDK and the Yelp Fusion API.
Introduction ·
Setting Up Locally ·
Tech Stack ·
Contributing ·
License
## Introduction
AskYP is an open-source AI chatbot that uses [OpenAI Functions](https://platform.openai.com/docs/guides/gpt/function-calling) and the [Vercel AI SDK](https://sdk.vercel.ai/docs) to interact with the [Yelp Fusion API](https://docs.developer.yelp.com/docs/getting-started) with natural language.
https://github.com/JaleelB/ask-yp/assets/78449846/3ddcb9c1-695b-426a-a80b-dad46630622b
## Setting Up Locally
To set up AskYP locally, you'll need to clone the repository and set up the following environment variables:
- `OPENAI_API_KEY` – your OpenAI API key (you can get one [here](https://platform.openai.com/account/api-keys))
- `IPINFO_TOKEN` - your IPInfo API key (you can get one [here](https://ipinfo.io/account/token))
- `YELP_CLIENT_ID` - your Yelp Fusion API client ID (you can get one [here](https://www.yelp.com/developers/v3/manage_app))
- `YELP_API_KEY` - your Yelp Fusion API key (you can get one [here](https://www.yelp.com/developers/v3/manage_app))
- `KV_URL` - your Vercel KV URL (you can get one [here](https://vercel.com/docs/storage/vercel-kv/quickstart))
- `KV_REST_API_URL` - your Vercel KV API URL (you can get one [here](https://vercel.com/docs/storage/vercel-kv/quickstart))
- `KV_REST_API_TOKEN` - your Vercel KV REST API URL (you can get one [here](https://vercel.com/docs/storage/vercel-kv/quickstart))
- `KV_REST_API_READ_ONLY_TOKEN` - your Vercel KV READ-ONLY REST API URL (you can get one [here](https://vercel.com/docs/storage/vercel-kv/quickstart))
## Tech Stack
AskYP is built on the following stack:
- [Next.js](https://nextjs.org/) – framework
- [OpenAI Functions](https://platform.openai.com/docs/guides/gpt/function-calling) - AI completions
- [Vercel AI SDK](https://sdk.vercel.ai/docs) – AI streaming library
- [Yelp Fusion API](https://docs.developer.yelp.com/docs/getting-started) – API
- [IPInfo](https://ipinfo.io/) – IP geolocation
- [Vercel KV](https://vercel.com/docs/storage/vercel-kv/quickstart) – database
- [Vercel](https://vercel.com) – deployments
- [TailwindCSS](https://tailwindcss.com/) – styles
## Contributing
Here's how you can contribute:
- [Open an issue](https://github.com/JaleelB/ask-yp/issues) if you believe you've encountered a bug.
- Make a [pull request](https://github.com/JaleelB/ask-yp/pulls) to add new features/make quality-of-life improvements/fix bugs.
## Author
- Jaleel Bennett ([@jal_eelll](https://twitter.com/jal_eelll))
## License
Licensed under the [MIT license](https://github.com/JaleelB/ask-yp/blob/main/LICENSE.md).
