Skip to content

Commit

Permalink
docs: add examples for how to use metadata and filter (#105)
Browse files Browse the repository at this point in the history
  • Loading branch information
elisalimli committed Apr 30, 2024
1 parent 6e97448 commit de60ec6
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,10 @@ Super-Rag comes with a built in REST API powered by FastApi.
"files": [
{
"name": "My file", // Optional
"url": "https://path-to-my-file.pdf"
"url": "https://path-to-my-file.pdf",
"metadata": { // Optional
"key": "value"
}
}
],
"document_processor": { // Optional
Expand Down Expand Up @@ -127,6 +130,18 @@ Super-Rag comes with a built in REST API powered by FastApi.
"name": "embed-multilingual-light-v3.0",
"dimensions": 384
},
"filter": { // Optional
// Each provider has its own filter schema,
// for Qdrant it looks like the following:
"must": [
{
"key": "key",
"match": {
"value": "value"
}
}
]
},
"exclude_fields": ["metadata"], // Exclude specific fields
"interpreter_mode": False, // Set to True if you wish to run computation Q&A with a code interpreter
"session_id": "my_session_id" // keeps micro-vm sessions and enables caching
Expand Down

0 comments on commit de60ec6

Please sign in to comment.