How to search using api

[xyzhu68]

In Web site there is a tab "Search". You can do Search on specified knowledgebases. How can I use this function with APIs.
I need search function, because with rag, I cannot ask questions like "list all products with the property xyz".

[dosubot[bot]]

You can use the RAGFlow search function via API by leveraging the "retrieve chunks" endpoint, which allows you to perform searches on specified knowledgebases—similar to the "Search" tab on the website. The detailed API documentation for this endpoint is available here cite.

To list all products with a specific property (e.g., "list all products with the property xyz"), you can use the /retrieval_test endpoint. This endpoint lets you send a POST request with parameters such as kb_id (knowledgebase ID), question (your search query), and optional filters. The API will return ranked document chunks that match your criteria cite.

If you want to filter documents by specific properties or tags, consider using the "Tag" functionality. This involves creating a knowledgebase with the "Tag" chunking method, uploading tag samples, and applying the tag knowledgebase to your main knowledgebase. This approach helps you filter and retrieve only the documents (or products) that have the property you specify cite.

Be aware that in RAGFlow v0.17.2, there was a bug where the search function could return empty results even if the knowledgebase test worked. This issue is fixed in the nightly version, so if you encounter this, updating may resolve it cite.

In summary: use the "retrieve chunks" API endpoint for general search, /retrieval_test for advanced retrieval and filtering, and the "Tag" functionality for property-based filtering. The API supports searching, filtering, and listing results programmatically, just as you would in the web UI.

To reply, just mention my name @dosu.

---

^{How did I do? Good | Irrelevant | Incorrect | Verbose | Hallucination | Report 🐛 | Other}   

[ZhenhangTung]

noted.