AskYP

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 and the Vercel AI SDK to interact with the Yelp Fusion API 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)
• IPINFO_TOKEN - your IPInfo API key (you can get one here)
• YELP_CLIENT_ID - your Yelp Fusion API client ID (you can get one here)
• YELP_API_KEY - your Yelp Fusion API key (you can get one here)
• KV_URL - your Vercel KV URL (you can get one here)
• KV_REST_API_URL - your Vercel KV API URL (you can get one here)
• KV_REST_API_TOKEN - your Vercel KV REST API URL (you can get one here)
• KV_REST_API_READ_ONLY_TOKEN - your Vercel KV READ-ONLY REST API URL (you can get one here)

Tech Stack

AskYP is built on the following stack:

• Next.js – framework
• OpenAI Functions - AI completions
• Vercel AI SDK – AI streaming library
• Yelp Fusion API – API
• IPInfo – IP geolocation
• Vercel KV – database
• Vercel – deployments
• TailwindCSS – styles

Contributing

Here's how you can contribute:

• Open an issue if you believe you've encountered a bug.
• Make a pull request to add new features/make quality-of-life improvements/fix bugs.

Author

• Jaleel Bennett (@jal_eelll)

License

Licensed under the MIT license.