oceanbase / oceanbase/pyseekdb
[Enhancement]: Better syntax of parameters of get/query/hybrid_search
Open
Nobody has claimed this yet.
priority: p2
type: enhancement
- Dominant language
- Python
- Stars
- 62
- Forks
- 35
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 2
Description
Description
Now, we can use json parameters to tell pyseekdb how to search data. But json is difficult to use and debug.
We can provide a better syntax to simplify the developing and debugging.
Refer to chroma new search api.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the get, query, and hybrid_search entry points and inspect how their JSON parameters are currently accepted and passed through. Compare the proposed syntax with the linked Chroma search API documentation. Done means the desired parameter syntax is defined and consistently supported across all three search methods, with its behavior documented and verified.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, databases
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100