/web-crawl-qa

Learn how to crawl your website and build a Q/A bot with the OpenAI API

Primary LanguageJupyter Notebook

Web Q&A with Embeddings

Learn how to crawl your website and build a Q/A bot with the OpenAI API. You can find the full tutorial in the OpenAI documentation.

To run the server:

python -m venv venv
pip install -r requirements.txt
python app.py

Flowchart of Design

graph TD;

a(Upload HTML and Ask)
b{HTML uploaded}
c(Ask Assistant with HTML retrieval)
d(Upload To OpenAI)
e(Return Answer)
a -->b
b --yes--> c
b --no--> d
d --> c
c --> e
Loading

API Reference

PATH METHOD PARAMS HEADER BODY RESPONSE
/web_qa GET question(str): question to ask about the site
url(str): url of the page to ask, e.g. https://platform.openai.com/docs/api-reference/messages/getMessage		 -- -- {
"answer":"",
"basis":["keyword", "or sentence"]
}
/suggestion GET url(str): url of the page to ask, e.g. https://platform.openai.com/docs/api-reference/messages/getMessage -- -- {
"questions":["question1","question2"]
}
/upload POST url(str): url of the page to ask, e.g. https://platform.openai.com/docs/api-reference/messages/getMessage -- {"html":html string} { "status": "success" }
/assistant_qa SAME TO THE WEB_QA
/assistant_suggestion SAME TO THE SUGGESTION