REST Search API
So you want to serve your searches on a Web/JS app? We've got you covered. Simon offers a bare-bones REST API that you can host to get you on your way.
Getting Started
Install (More!) Simon
There are additional packages (think: Flask) which Simon needs to function as a REST API. To install them, run:
Setup Environment
Create a new folder in which you would like to run Simon's API from. In that folder, please set up an environments file containing your database/OpenAI credentials following these instructions. You can also expose those variables using bash variables.
Run the API!
When you are ready, you can get started to run the API. In the same folder for which you have setup the environments file, execute:
where PORT is the point number you wish to bind to, and WORKERS is the number of parallel workers to bind to.
Endpoint Documentation
There are three stable endpoints that Simon's API offers, and each of them do a search task.
GET /query and GET /brainstorm
These endpoints performs the full LLM search query and the LLM recommendation queries respectively, and takes the following arguments.
| Query Parameter | Type | Use |
|---|---|---|
q |
str |
The query you wish to answer |
response |
Optional[str] |
Provide the string "streaming" to get a streaming response |
| Header | Type | Use |
|---|---|---|
| Authorization | Bearer | Provide the Project ID ("UID") to simon.create_context as the bearer token |
Without passing the response=streaming parameter, this endpoint returns the same exact JSON object in the body as the Python API. The structure of that JSON is outlined here: /query, /brainstorm.
If you passed the response=streaming parameter, this endpoint will return an HTTP stream, with each chunk containing the same format as a chunk from the Python streaming generator API of Simon.
GET /search
This endpoint performs the simple semantic search, and takes the following arguments.
| Query Parameter | Type | Use |
|---|---|---|
q |
str |
The query you wish to answer |
| Header | Type | Use |
|---|---|---|
| Authorization | Bearer | Provide the Project ID ("UID") to simon.create_context as the bearer token |
This endpoint returns the same exact JSON object in the body as the Python API. The structure of that JSON is outlined here.
Additional Endpoints
Additionally, the endpoints store_file, store_text, and forget are available for data management but is not stable as of now. Feel free to browse the API source for a sense of how they work, but we heavily discourage the use of them.
Building Your Own
We understand Simon's built-in REST API is limiting in many ways (i.e.: no authentication, no security, no parallelization). Fortunately, you can bootstrap off of our code to build your own! Simply copy this file, containing the source code of the bare-bones Flask-based API—and add customizations to your heart's content.