📙Query Data
Prerequisites
Requires a user auth token. See the API Auth section.
Querying data - API
This endpoint retrieves the stored data based on the meaning of the query. The endpoins requires:
Database name:
db
A collection name:
collection
An text string to search about:
search
optional
count
: the number of matches to return. Defaults to 3optional
metadataFilters
: to further filter data by metadata. Please see subpage
import mindplug from "@/src/mindplugAPI"; // base instance
mindplug.post("/data/query", {
db: "walmart",
collection: "office supplies",
search: "an eraser with no crumbs",
count: 1
});
Sample Response
Returns a list of matching responses.
{
"data": [
{
"id": "4334eb12-f57d-4b67-8b13-1f62d7cf5791",
"score": 0.893768728,
"values": [],
"metadata": {
"content": "Premium eraser: an eraser that works on both pen and pencil and leaves no crumbs",
"lastStock": "June 2023",
"totalItems": 123
}
}
]
}
Last updated