Skip to content

docs: add regex syntax details to full-text search docs#6851

Open
JKDasondee wants to merge 1 commit intochroma-core:mainfrom
JKDasondee:docs/regex-details-5118
Open

docs: add regex syntax details to full-text search docs#6851
JKDasondee wants to merge 1 commit intochroma-core:mainfrom
JKDasondee:docs/regex-details-5118

Conversation

@JKDasondee
Copy link
Copy Markdown

Summary

Addresses #5118 by adding regex documentation details to the full-text search page and the Cloud quotas page.

Changes to docs/querying-collections/full-text-search.mdx:

  • New "Regex Syntax" section documenting:
    • 3-character minimum pattern length
    • Cloud max length (256 bytes) vs no limit on self-hosted
    • Rust regex crate with link to full syntax reference
    • Unsupported features: lookaheads, lookbehinds, byte patterns
    • Performance tip: include literal substrings for faster regex scans
  • Complex example in all three language tabs (Python, TypeScript, Rust) combining $regex + $not_contains document filters with metadata filters and logical operators

Changes to cloud/quotas-limits.mdx:

  • Clarified that the 256-byte regex/full-text search limit is Cloud-only
  • Added note about the 3-character minimum applying to all deployments

Closes #5118

@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 9, 2026

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
Copy Markdown
Contributor

@propel-code-bot propel-code-bot bot left a comment

Choose a reason for hiding this comment

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

Review found no issues; documentation updates are clear, scoped, and aligned with the stated PR goals.

Status: No Issues Found | Risk: Low

Review Details

📁 2 files reviewed | 💬 0 comments

Instruction Files
└── docs/
    └── mintlify/
        ├── AGENTS.md
        └── CLAUDE.md

@propel-code-bot
Copy link
Copy Markdown
Contributor

propel-code-bot bot commented Apr 9, 2026

Document regex syntax limits and advanced filtering examples for full-text search

This PR is a documentation-only update that expands guidance for full-text search and regex usage. It adds a new Regex Syntax section to docs/mintlify/docs/querying-collections/full-text-search.mdx, clarifying engine behavior (Rust regex), minimum/maximum pattern constraints, unsupported constructs, and a performance recommendation for literal substrings.

It also adds new advanced examples in Python, TypeScript, and Rust showing combined use of document filters (including $regex and $not_contains) with metadata filters and logical operators. In docs/mintlify/cloud/quotas-limits.mdx, quota wording is updated to explicitly state the 256-byte regex/full-text limit is Cloud-only while the 3-character minimum applies to all deployments.

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

Document regex engine details (Rust regex crate), 3-character minimum
pattern length, Cloud vs self-hosted max length limits, unsupported
features (lookaheads, byte patterns), performance tips, and complex
examples combining regex with metadata filters and logical operators.

Closes chroma-core#5118
@JKDasondee JKDasondee force-pushed the docs/regex-details-5118 branch from 8b997de to 1c33ab8 Compare April 10, 2026 03:11
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.

Add more regex details to docs

1 participant