AnswerIt is an API that enables personalized learning for students based on their education level with latest and highest ranked sources from the web using AI algorithms, Search Engines and LLMs.
How it works?
The API accepts the query or the area which the student wants to learn about. It first assesses the level of learner, takes the decision of performing a safe search and then searches the web for the latest information on the subject. Aggregating the content from highest ranked sources, it uses its algorithms and a relevant Large Language Model to summarize and teach the learner in the most appropriate style. The learner can continue to interact with the result of the API. It has a single endpoint which can be used to start a new query or interact with past results.
Input Fields: 1. The first field is "query". This is a required field which can be used to enter the area or question which the student wants to learn about or a response to a question asked by Tutor. In latter case, the field of responseId will need to be filled to refer to the query. An examples of query is "2024 Olympics".
2. The second field is "level" which identifies the category of learner. This is an optional field and a blank value will assume the learner to be at "high-school" level by default. The possible values are: "preschool", "elementary-school", "middle-school" ,"high-school", "undergraduate" and "graduate".
3. The next field is "interaction" which informs the API about the action that it needs to suggest to the learner. This is an optional field and a blank or undefined value will assume the value of "none" by default which instructs the API to not to have any interaction after giving the information. The possible values are: "none", "converse", "quiz" and "random". Based on the value entered, "converse" will start a conversation, "quiz" will ask a question based on the text given and "Random" will take one of any actions.
4. The optional field of "country" is a 2 character ISO code to define the country in which the user is present so that the search engines of that country can be used.
5. "safesearch" is an optional Boolean field which if set to true will filter potentially offensive and inappropriate content. It is set to true by default unless clearly set to false.
6. "responseId" is an optional field that is used when interacting with API, say by giving an answer to a question or a selection. The responseId of the last response is entered, while the answer is entered in query. If this field is blank, the API uses the value in query field to search the web.
Output Fields: 1. responseId - The unique ID which is to be used for follow up conversations 2. response - The response in Markdown. 3. status - 200 for success.
