Skip to content

Commit 6d53b50

Browse files
author
Anton Hosgood
committed
doc: add details to lucene.md
1 parent 3556f53 commit 6d53b50

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

oak-doc/src/site/markdown/query/lucene.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,7 @@ Below is the canonical index definition structure
154154
- queryPaths (string) multiple = ['/']
155155
- excludedPaths (string) multiple
156156
- maxFieldLength (long) = 10000
157+
- maxTagLength (long) = 100
157158
- refresh (boolean)
158159
- useIfExists (string)
159160
- blobSize (long) = 32768
@@ -233,6 +234,13 @@ selectionPolicy
233234
[maxFieldLength][OAK-2469]
234235
: Numbers of terms indexed per field. Defaults to 10000
235236

237+
[maxTagLength][OAK-12101]
238+
: Optional integer property. Defaults to 100.
239+
: Maximum length of similarity tag and dynamic boost tag values to be indexed.
240+
Tags with values longer than this limit are skipped during indexing.
241+
Set to -1 to disable the length check entirely.
242+
See [Dynamic Boost](#dynamic-boost) and [Search by similar feature vectors](#similar-fv) for details.
243+
236244
refresh
237245
: Optional boolean property.
238246
: Used to refresh the stored index definition. See [Effective Index Definition](#stored-index-definition)
@@ -1231,6 +1239,11 @@ with boost set to the confidence.
12311239
This is a replacement for the `IndexFieldProvider`.
12321240
See also [OAK-8971][OAK-8971].
12331241

1242+
Tag values that exceed the configured `maxTagLength` (default 100) are skipped during indexing.
1243+
This prevents unexpectedly long values from being indexed as dynamic boost tags.
1244+
The limit can be changed by setting the `maxTagLength` property on the index definition,
1245+
or disabled entirely by setting it to -1. See [OAK-12101][OAK-12101].
1246+
12341247

12351248
### <a name="native-query"></a>Native Query and Index Selection
12361249
`@deprecated Oak 1.46`
@@ -1702,6 +1715,11 @@ As a further improvement for the accuracy of similarity search results if nodes
17021715
holding text values that can be used as keywords or tags that well describe the feature vector contents, the
17031716
`similarityTags` configuration can be set to _true_ for such properties (see [OAK-8118](https://issues.apache.org/jira/browse/OAK-8118)).
17041717

1718+
Similarity tag values that exceed the configured `maxTagLength` (default 100) are skipped during indexing.
1719+
This prevents unexpectedly long values from being indexed as similarity tags.
1720+
The limit can be changed by setting the `maxTagLength` property on the index definition,
1721+
or disabled entirely by setting it to -1. See [OAK-12101][OAK-12101].
1722+
17051723
See also [OAK-7575](https://issues.apache.org/jira/browse/OAK-7575).
17061724

17071725

@@ -2231,6 +2249,7 @@ SELECT rep:facet(title) FROM [app:Asset] WHERE [title] IS NOT NULL
22312249
[OAK-7739]: https://issues.apache.org/jira/browse/OAK-7739
22322250
[OAK-8971]: https://issues.apache.org/jira/browse/OAK-8971
22332251
[OAK-9625]: https://issues.apache.org/jira/browse/OAK-9625
2252+
[OAK-12101]: https://issues.apache.org/jira/browse/OAK-12101
22342253
[luke]: https://code.google.com/p/luke/
22352254
[tika]: http://tika.apache.org/
22362255
[oak-console]: https://github.com/apache/jackrabbit-oak/tree/trunk/oak-run#console

0 commit comments

Comments
 (0)