feat: add a REST API streaming endpoint for the query pipeline #5697
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related Issues
Following the suggestion in PR #4889, I implemented a streaming endpoint in my application. I thought this feature might be interesting for other users as well, which leads to this PR.
Proposed Changes:
query-streaming
, which outputs the result of the last component in the pipeline in streaming formstream_handler
in theirrun
method. Otherwise, a warning message will be returned.How did you test it?
To start the backend, run
To query the results, run
Notes for the reviewer
There is another PR #5646 of mine which enables passing an object to
pipeline.run()
. This PR will only work if that PR gets merged first. @ZanSaraThe "exception handling" in my solution (the warning message) is not optimal, pls let me know if you have a better idea.
Also please let me know if a unit test is needed here.
Checklist
fix:
,feat:
,build:
,chore:
,ci:
,docs:
,style:
,refactor:
,perf:
,test:
.