Skip to content

Conversation

codetheweb
Copy link
Contributor

@codetheweb codetheweb commented Sep 10, 2025

Needed for better error messaging prior to new release.

Copy link

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)

@codetheweb codetheweb marked this pull request as ready for review September 10, 2025 22:28
@codetheweb codetheweb merged commit 8851e98 into main Sep 10, 2025
60 checks passed
Copy link
Contributor

Disable Search API by Marking as Not Implemented

This pull request updates the search method in both AsyncCollection (chromadb/api/models/AsyncCollection.py) and Collection (chromadb/api/models/Collection.py) to explicitly raise NotImplementedError. The previous implementation called the client-side _search method, but with this change, any attempt to use the search API results in a clear exception. The PR also improves docstring formatting for these methods by adding consistent blank lines for readability. According to the author's note, this change aims to improve error messaging before a new release by making search API unavailability explicit.

Key Changes

• Replaced client _search calls in Collection.search() and AsyncCollection.search() with raising NotImplementedError("This API is not yet available").
• Adjusted docstrings in both files for improved formatting (added blank lines for readability and consistency).

Affected Areas

chromadb/api/models/Collection.py
chromadb/api/models/AsyncCollection.py

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant