-
Notifications
You must be signed in to change notification settings - Fork 1.7k
[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
[DOC] Regex docs #4923
Conversation
Reviewer ChecklistPlease leverage this checklist to ensure your code review is thorough before approving Testing, Bugs, Errors, Logs, Documentation
System Compatibility
Quality
|
This PR updates the documentation to include details and examples for the new This summary was automatically generated by @propel-code-bot |
docs/docs.trychroma.com/markdoc/content/docs/querying-collections/full-text-search.md
Outdated
Show resolved
Hide resolved
docs/docs.trychroma.com/markdoc/content/docs/querying-collections/full-text-search.md
Outdated
Show resolved
Hide resolved
{ | ||
"$regex": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$" | ||
} | ||
``` |
There was a problem hiding this comment.
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,}$" |
There was a problem hiding this comment.
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>
## 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>
Description of changes
Adding regex ops to docs