Repository navigation
Clarify full-text telemetry lifecycle and query-policy guidance #800
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?
Changes from all commits
c1dcf05
2ce8f21
3ba1f2f
fc3be3e
96831d1
2973709
ca9803c
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -21,14 +21,16 @@ Results are ordered by BM25 relevance. The `FullText` field, not one of its sour | |
|
|
||
| ## Match modes | ||
|
|
||
| | Comparator | Behavior | Required index option | | ||
| | ---------------------- | --------------------------------------------------------------------- | --------------------- | | ||
| | `matches` | Matches any analyzed query term. | β | | ||
| | `matches_all` | Requires every analyzed query term. | β | | ||
| | `matches_phrase` | Matches analyzed terms in order as a phrase. | `positions: true` | | ||
| | `matches_prefix` | Matches records whose analyzed terms start with the final query term. | `surfaceTerms: true` | | ||
| | `matches_fuzzy` | Matches terms within one edit, including a transposition. | β | | ||
| | `matches_fuzzy_prefix` | Combines one-edit fuzzy matching with a final-term prefix. | `surfaceTerms: true` | | ||
| | Comparator | Behavior | Required index option | | ||
| | ---------------------- | ----------------------------------------------------------------------- | --------------------- | | ||
| | `matches` | Matches any analyzed query term. | β | | ||
| | `matches_all` | Requires every analyzed query term. | β | | ||
| | `matches_phrase` | Matches analyzed terms in order as a phrase. | `positions: true` | | ||
| | `matches_prefix` | Matches records whose analyzed terms start with the final query term. | `surfaceTerms: true` | | ||
| | `matches_fuzzy` | Matches terms within one edit by default, including a transposition. | β | | ||
| | `matches_fuzzy_prefix` | Combines fuzzy matching (one edit by default) with a final-term prefix. | `surfaceTerms: true` | | ||
|
|
||
| <VersionBadge version="v5.4.0" /> On a `Table.search()` fuzzy or fuzzy-prefix condition, `fuzzyDistance` accepts an integer `0`β`2` and defaults to `1`. It must not exceed `storage.fullText.query.maxFuzzyDistance`; exceeding that maximum returns HTTP 400. With a maximum of `0`, set `fuzzyDistance: 0` explicitly. Distance `2` remains preview and requires workload qualification. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The phrasing "With a maximum of Consider rephrasing to: |
||
|
|
||
| Every comparator also has a negated form: `not_matches`, `not_matches_all`, `not_matches_phrase`, `not_matches_prefix`, `not_matches_fuzzy`, and `not_matches_fuzzy_prefix`. | ||
|
|
||
|
|
||
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.
The phrasing "With
0, fuzzy and fuzzy-prefix conditions that omitfuzzyDistance: 0are rejected with HTTP 400; omitted distances remain1" is slightly confusing. It sounds like the conditions are rejected because they omit the value0, whereas they are actually rejected because omitting the parameter causes it to default to1, which exceeds the configured maximum of0.Clarifying this behavior makes the configuration option much easier to understand for operators.
Consider rephrasing to:
"If set to
0, fuzzy and fuzzy-prefix conditions that do not explicitly specifyfuzzyDistance: 0are rejected with HTTP 400, as omitted distances default to1(which exceeds the maximum of0)."References