Skip to content

[DOC] Regex docs #4923

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

Merged
merged 3 commits into from
Jun 24, 2025
Merged

[DOC] Regex docs #4923

merged 3 commits into from
Jun 24, 2025

Conversation

itaismith
Copy link
Contributor

Description of changes

Adding regex ops to docs

@itaismith itaismith requested a review from philipithomas June 24, 2025 06:10
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)

Copy link
Contributor

propel-code-bot bot commented Jun 24, 2025

This PR updates the documentation to include details and examples for the new $regex and $not_regex operators available in full text search filtering. The sidebar navigation is also updated to reflect the expanded content with the new page title 'Full Text Search and Regex'.

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

@itaismith itaismith requested a review from philipithomas June 24, 2025 17:44
{
"$regex": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$"
}
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Documentation]

Consider adding an example of the $not_regex operator similar to how you've shown both $contains and $not_contains. This would provide complete documentation for the regex filtering capabilities.

```python
# Filtering using a regex pattern for an email address
{
"$regex": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[BestPractice]

Consider adding a simpler regex example alongside the email pattern. Email regex patterns are quite complex, and a simpler example like case-insensitive matching might be more approachable for users new to regular expressions.

…ons/full-text-search.md

Co-authored-by: propel-code-bot[bot] <203372662+propel-code-bot[bot]@users.noreply.github.com>
@itaismith itaismith merged commit e66ea23 into main Jun 24, 2025
57 checks passed
Inventrohyder pushed a commit to Inventrohyder/chroma that referenced this pull request Aug 5, 2025
## Description of changes

Adding regex ops to docs

---------

Co-authored-by: Philip I. Thomas <philip@trychroma.com>
Co-authored-by: propel-code-bot[bot] <203372662+propel-code-bot[bot]@users.noreply.github.com>
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.

2 participants