any milestone or timetable on SDK of ragflow ?

[yangboz]

Describe your problem

it seems the sdk/python package and codebase is updating here.
I am wondering does any overall milestone or time table on it ? then we can easily integration on our current project. not too much code base incursions happen , thanks.

[nicklhy]

+1.

I tried to use the python sdk recently, but got troubles on a simple knowledge base retrieval test.
The source code has a comment "Note: This is a hypothetical implementation and may need adjustments based on the actual backend service API."

[Feiue]

+1.

I tried to use the python sdk recently, but got troubles on a simple knowledge base retrieval test. The source code has a comment "Note: This is a hypothetical implementation and may need adjustments based on the actual backend service API."

The SDK API and HTTP API are both being updated. Except for the documentation-related APIs, others has been mostly completed. You can refer to the latest api document python_api and code for reference.

[nicklhy]

+1.
I tried to use the python sdk recently, but got troubles on a simple knowledge base retrieval test. The source code has a comment "Note: This is a hypothetical implementation and may need adjustments based on the actual backend service API."

The SDK API and HTTP API are both being updated. Except for the documentation-related APIs, others has been mostly completed. You can refer to the latest api document python_api and code for reference.

Thanks for your reply. Can I ask when will the python sdk become stable. We are considering if we can integrate RAGFlow as a knowledge retrieval backend in our custom system recently.

[KevinHuSh]

What do you mean by stable?
The progress mostly depends on the reaction/respond to this SDK by the community.

[nicklhy]

What do you mean by stable? The progress mostly depends on the reaction/respond to this SDK by the community.

Recently, I did a few test about the RAGFlow.retrieval api defined in api/apps/sdk/doc.py but always got some errors with the example code in python_api_reference.md doc .

After looking into the source code, I found either the installed sdk (which comse from the main branch) doesn't match the docker image (i.e. RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:dev-slim) or the python sdk code sdk/python/ragflow/ragflow.py doesn't match the api defined in api/apps/sdk/doc.py.

And the api name and parameters are still changing these days. For instance, the RAGFlow.retrieval was just renamed to RAGFlow.retrieve yesterday in this commit.

Thus, I am wondering whether it is a good time for us to integrate RAGFlow using the python sdk right now. If it is still under quick development. Maybe we should wait for a few weeks until it become a stable version.

[KevinHuSh]

Got it.
I think it's more suitable after 0.13 release which will be next week.