Add SearchIndex/AsyncSearchIndex serialization helpers
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 427
- Forks
- 101
- Avg merge
- 6d 3h
- Merged PRs (30d)
- 20
Description
Summary
Add serialization helpers for SearchIndex and AsyncSearchIndex to improve automation and reproducibility.
Level: Intermediate
Current State
- RedisVL has schema-centric factory methods, but limited top-level index serialization helpers.
- Agent and automation flows often need a portable index config artifact.
Proposed Change
- Add
to_dict()and optionalto_yaml()helpers for index configuration. - Include schema and safe connection metadata with redaction options for sensitive fields.
- Ensure sync/async parity where applicable.
Definition of Done
- Round-trip config serialization is supported and tested.
- Sensitive connection details can be omitted/redacted.
- Existing index creation and usage remain non-breaking.
Out of Scope
- Full environment secret management framework.
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 by locating the SearchIndex and AsyncSearchIndex entry points and reviewing the existing schema-centric factory methods. Trace how index configuration and connection metadata are represented, then define tests for sync/async round trips, sensitive-field omission or redaction, and unchanged index creation and usage.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, redis
- Domain
- databases
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100