Skip to content

Latest commit

 

History

History
73 lines (52 loc) · 3.49 KB

README.md

File metadata and controls

73 lines (52 loc) · 3.49 KB
Chat with Yelp using natural language.

Chat with Yelp using natural language. Built with OpenAI Functions, Vercel AI SDK and the Yelp Fusion API.

License AskYP's GitHub repo

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.

Screen.Recording.2023-08-18.at.1.11.16.AM.mov

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:

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

License

Licensed under the MIT license.