[ENH] Implement row iterator for search result

[Sicheng-Pan]

Description of changes

Summarize the changes made by this PR.

• Improvements & Bug fixes
  • N/A
• New functionality
  • Implement a rows method for the search result
  • Add a test for this

Test plan

How are these changes tested?

• Tests pass locally with pytest for python, yarn test for js, cargo test for rust

Migration plan

Are there any migrations, or any forwards/backwards compatibility changes needed in order to make sure this change deploys reliably?

Observability plan

What is the plan to instrument and monitor this change?

Documentation Changes

Are all docstrings for user-facing APIs updated if required? Do we need to make documentation changes in the docs section?

[Sicheng-Pan]

• [ENH] Allow dict as search args #5503
• [ENH] Implements RRF helper expression #5499
• [ENH] Implement row iterator for search result #5498 👈 (View in Graphite)
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

[github-actions]

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

• Can you think of any use case in which the code does not behave as intended? Have they been tested?
• Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
• If appropriate, are there adequate property based tests?
• If appropriate, are there adequate unit tests?
• Should any logging, debugging, tracing information be added or removed?
• Are error messages user-friendly?
• Have all documentation changes needed been made?
• Have all non-obvious changes been commented?

System Compatibility

• Are there any potential impacts on other parts of the system or backward compatibility?
• Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

• Is this code of a unexpectedly high quality (Readability, Modularity, Intuitiveness)

[propel-code-bot]

Implement rows Iterator for SearchResult and Associated Tests

This pull request adds a rows method to the SearchResult object, enabling users to iterate over search results in a row-major (record-wise) structure instead of the default column-major format. The new method converts column-oriented search results into a list of dictionaries, each containing all available fields for a particular result, which improves consumption and downstream processing of search results. Supporting changes include a new SearchResultRow type, updates to the SearchResult API type, changes in chromadb/api/fastapi.py and chromadb/api/async_fastapi.py to instantiate SearchResult correctly, and comprehensive testing in chromadb/test/test_api.py.

Key Changes

• Introduced SearchResultRow TypedDict, defining the schema for a single result row.
• Refactored SearchResult from a TypedDict to a dictionary subclass with a .rows() method for row-major conversion.
• Added the .rows() method to SearchResult, implementing column-to-row transformation logic.
• Updated exports in chromadb/api/types.py to include the new SearchResultRow.
• Patched chromadb/api/fastapi.py and chromadb/api/async_fastapi.py to instantiate SearchResult from server response dictionaries for backward compatibility.
• Added extensive unit tests in chromadb/test/test_api.py to validate various use-cases and edge cases for the new rows() API.

Affected Areas

• chromadb/api/types.py (API types, result conversion logic)
• chromadb/api/fastapi.py and chromadb/api/async_fastapi.py (client/server response wrapping)
• chromadb/test/test_api.py (new and updated tests for SearchResult.rows)

This summary was automatically generated by @propel-code-bot

[Sicheng-Pan]

Merge activity

• Sep 23, 12:17 AM UTC: A user started a stack merge that includes this pull request via Graphite.
• Sep 23, 12:17 AM UTC: @Sicheng-Pan merged this pull request with Graphite.