Deploying an Educational Chatbot with API
Training your bot using a Document/webpage
Last updated
Was this helpful?
Training your bot using a Document/webpage
Last updated
Was this helpful?
This documentation aims at walking you through setting up and training your AI bot via our API using document/book/webpage data sources. Let us assume you’re an A student in class, but struggling with a particular topic and your exams are fast approaching, or Let’s say you’re a developer struggling with a particular concept in javascript, you can teach your AI bot to teach you that concept, or topic. I’d be using a document I found on the internet for demonstration purposes, walk with me.
Get your OpenAI API key, if you don’t already have one, get one here OpenAI API key. After creating your account with OpenAI, navigate to API and create your unique secret key, copy and keep it somewhere safe you’d need it later.
If you’re on this document, you should already have an account with BoostGPT, if you don’t, it’s easy to create an account here BoostGPT Account
Before creating your AI, you first need to create a project, this helps in categorizing your AI chatbots should in case you have more than 10 bots created. Getting excited? I bet yeah! To create a new project, go to the top left of your screen where your name is displayed, click on it, click on the Create New button, and give the project name. Click CREATE like the below screenshot to create a new Chatbot.
Select a model you want your AI to run on, if you’re familiar with OpenAI released versions else leave the default selection.
Give it strict instructions and change the name if you like, if you don’t understand this part, leave it as it is and submit it, it’ll make sense later in the tutorial.
Copy your bot ID, go to settings, and also copy your project ID.
Lastly, go to your profile and create your BoostGPT API key, copy it, and keep it somewhere safe.
We’ll be training our bot using the Postman interface (You should be familiar with Postman UI, if not don’t worry, I’ll walk you through step by step in training your AI assistant. You can access the Postman documenter for BoostGPT here.
On the top right corner, click on Run in Postman
Select the Web version or Windows (if you have Postman installed on your machine)
Select Team Workspace if you work with a team, else select my workspace and import. Hurray, you’re up and running, told you it was an easy setup.
Look through the interface provided, you’d be given a BoostGPT API folder, with four subfolders categories accordingly inside.
Go to the bot folder, click on POST method and click on HEADERS and provide your BoostGPT API key, in the authorization section, click on bearer and paste your API key there, should be like the below screenshot.
Repeat this step for other subfolders (Training & Chat folder respectively).
Still, in the bot folder, click on POST method and click on BODY, make sure your project_ID corresponds with the one you copied, it’s automatically generated for you but we want to make sure everything is okay, to avoid future errors, if it doesn’t kindly paste the project_ID you copied in Step 3.
Click on the training folder, if you followed step 5 correctly by placing your API key in the Authorization header, simply click on POST, and go to BODY you should see the below image on your screen.
Verify that your project_id and bot_it correspond with the one you copied previously, if it doesn’t please paste the one you copied respectively as a string shown above.
We’re training this model with a document, so give it the tag of “document”
I uploaded my document online via google docs, so the type would be a webpage because I'll be providing a link to the document where it's hosted.
Lastly source: provide an array with the link(s) to the document as the source to feed your AI with as much data as possible. PS: if you’re using the google docs link, make sure to set the link to view and edit.
Click on SEND, after you have provided all the parameters. This crawls the link and provides you with tokens.
Congratulations, you’ve successfully trained your AI assistant to suit your narrative, Now let us test it.
Go to the Chat folder, Click on POST, and click on BODY, verify your project_id, and bot_id to make sure they correspond, if they don’t paste the correct one provided by boostGPT as strings respectively.
Provide your OpenAI API key as a string as well, in the above provision for openai_key:
Message: “Type your question” and click send. This is the provision for providing a prompt or question to the AI, in the above I asked for objectives of larvicidal activity because I had trained it with a document on larvicidal activity on methanol stem extract, here’s the reply I got
The same is applicable to you as a student or a developer, provide it with a book or webpage, ask it for anything relating to the document provided, and see the magic.
NOTE: You’re not limited to just documents, see other aspects of BoostGPT case studies.
Happy Hacking.
