-
Notifications
You must be signed in to change notification settings - Fork 1.9k
[DOC] Document search API #5521
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Reviewer ChecklistPlease leverage this checklist to ensure your code review is thorough before approving Testing, Bugs, Errors, Logs, Documentation
System Compatibility
Quality
|
42b935d
to
f3f86db
Compare
f3f86db
to
ca756c3
Compare
Add Comprehensive Documentation for Chroma Cloud Search API This PR introduces a new, detailed documentation suite for the Chroma Cloud Search API. It adds extensive multi-page docs, including an overview, quick start, API basics, filtering, ranking and scoring (with dictionary and builder syntax), hybrid search with RRF, pagination, batch operations, migration from legacy APIs, and end-to-end examples. The PR also updates the documentation sidebar navigation and references to surface the new Search API docs and links from Chroma Cloud onboarding materials. Key Changes• Added new documentation files under Affected Areas• This summary was automatically generated by @propel-code-bot |
Description of changes
Summarize the changes made by this PR.
Test plan
How are these changes tested?
pytest
for python,yarn test
for js,cargo test
for rustMigration 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?_