Pagination for single field queries #251
Merged
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.
What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
Pagination feature
What is the current behavior? (You can also link to an open issue here)
Currently, results cannot be paginated. See issue: Pagination [ENHANCEMENT] #71
What is the new behavior (if this is a feature change)?
This introduces an
offset
parameter, which allows users to skip results (for pagination). This uses thefrom
andsize
parameters of open search.There are some issues with skipping/duplication of results near the edges of the first few pages (around 3% of results affected overall) in tensor search specifically. This is believed to be an issue with OpenSearch KNN, and is being observed in the issue here: opensearch-project/k-NN#698
For now, the unit tests for pagination do not assume exact precision in results when using pagination.
Additionally,
verbose
parameter was added to _lexical_search and _vector_text_search for debugging purposes.Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)
No.
Have unit tests been run against this PR? (Has there also been any additional testing?)
Yes.
Related Python client changes (link commit/PR here)
Pagination offset parameter implemented py-marqo#49
Related documentation changes (link commit/PR here)
https://github.com/marqo-ai/marqodocs/pull/42
Other information:
Please check if the PR fulfills these requirements