mirror of
https://github.com/deepset-ai/haystack.git
synced 2025-07-23 17:00:41 +00:00
713771095b
* Add docstrings to the REST API endpoint to have them included in the OpenAPI specs * Attempt at make GitHub CI generate the OpenAPI specs * Missing __init__.py was breaking rest_api import * Add comment on dummy pipeline * Create separate workflow file for the OpenAPI specs generation Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Markus Paff <markuspaff.mp@gmail.com>
52 lines
1.7 KiB
Python
52 lines
1.7 KiB
Python
from typing import List
|
|
|
|
import logging
|
|
|
|
from fastapi import APIRouter
|
|
|
|
from rest_api.controller.search import DOCUMENT_STORE
|
|
from rest_api.config import LOG_LEVEL
|
|
from rest_api.schema import FilterRequest, DocumentSerialized
|
|
|
|
|
|
logging.getLogger("haystack").setLevel(LOG_LEVEL)
|
|
logger = logging.getLogger("haystack")
|
|
|
|
|
|
router = APIRouter()
|
|
|
|
|
|
@router.post("/documents/get_by_filters", response_model=List[DocumentSerialized], response_model_exclude_none=True)
|
|
def get_documents(filters: FilterRequest):
|
|
"""
|
|
This endpoint allows you to retrieve documents contained in your document store.
|
|
You can filter the documents to delete by metadata (like the document's name),
|
|
or provide an empty JSON object to clear the document store.
|
|
|
|
Example of filters:
|
|
`'{"filters": {{"name": ["some", "more"], "category": ["only_one"]}}'`
|
|
|
|
To get all documents you should provide an empty dict, like:
|
|
`'{"filters": {}}'`
|
|
"""
|
|
docs = [doc.to_dict() for doc in DOCUMENT_STORE.get_all_documents(filters=filters.filters)]
|
|
for doc in docs:
|
|
doc["embedding"] = None
|
|
return docs
|
|
|
|
|
|
@router.post("/documents/delete_by_filters", response_model=bool)
|
|
def delete_documents(filters: FilterRequest):
|
|
"""
|
|
This endpoint allows you to delete documents contained in your document store.
|
|
You can filter the documents to delete by metadata (like the document's name),
|
|
or provide an empty JSON object to clear the document store.
|
|
|
|
Example of filters:
|
|
`'{"filters": {{"name": ["some", "more"], "category": ["only_one"]}}'`
|
|
|
|
To get all documents you should provide an empty dict, like:
|
|
`'{"filters": {}}'`
|
|
"""
|
|
DOCUMENT_STORE.delete_documents(filters=filters.filters)
|
|
return True |