RDoc-2514 Explain Boosting options + Update indexing configuration #1738

Danielle9897 · 2024-01-17T16:15:35Z

Related issues:
https://issues.hibernatingrhinos.com/issue/RDoc-2514/Explain-Boosting-options-when-indexing
https://issues.hibernatingrhinos.com/issue/RDoc-2552/Disable-OrderByScore-when-Boosting-is-involved-Update-indexing-configuration-file
https://issues.hibernatingrhinos.com/issue/RDoc-2332/Add-information-about-supporting-document-boost-in-documentation
https://issues.hibernatingrhinos.com/issue/RDoc-2380/Add-missing-indexing-configuration-keys

Work included:

../indexing-configuration files:
Update the indexing-configuration with all missing keys

../indexes/boosting files:
Explain the 2 ways to apply boosting inside the index definition (on index-field vs index-entry)
Added Javascript index examples + updated Node.js

../sort-query-results files:
Organize "how to get the score" in a single location.

../boost-search-results files:
Explain the configurable option to order-by-score when Boosting is involved - in all relevant places

@ml054 The main Node.js files to check in this PR is:

Documentation/6.0/Raven.Documentation.Pages/indexes/boosting.js.markdown
Documentation/6.0/Samples/nodejs/indexes/boosting.js

@maciejaszyk The main C# files to check:

Documentation/5.4/Raven.Documentation.Pages/server/configuration/indexing-configuration.markdown
Documentation/6.0/Raven.Documentation.Pages/server/configuration/indexing-configuration.markdown
Documentation/6.0/Raven.Documentation.Pages/indexes/boosting.dotnet.markdown
Documentation/6.0/Samples/csharp/Raven.Documentation.Samples/Indexes/Boosting.cs

Danielle9897 · 2024-01-17T17:31:50Z

Documentation/5.4/Samples/nodejs/indexes/boosting.js

+             }`;
+    }
+}
+//endregion


@ml054
My Q was about this index and the one below

Can we use Boost with JS index in Node.js client ?

The only implementation I saw in the tests was with AbstractCsharpIndexCreationTask

in query yes, in JS index I don't see such feature.

maciejaszyk · 2024-01-23T14:25:37Z

...les/csharp/Raven.Documentation.Samples/ClientApi/Session/Querying/TextSearch/BoostResults.cs

+                    //
+                    // * Unless configured otherwise, the resulting documents will be ordered by their score.   
+                    // 
+                    // * Search is case-insensitive.


This is unnecessary information I guess.

If it is Not incorrect (as I saw when I ran the above), then I would prefer to leave this info.
For now, just modified the location of this comment to be less noticeable as follows:

// * Results will contain all Employee documents that have // EITHER 'English' OR 'Italian' in their 'Notes' field (case-insensitive). // // * Matching documents that contain 'Italian' will get a HIGHER score // than those that contain 'English'. // // * Unless configured otherwise, the resulting documents will be ordered by their score.

I meant // * Search is case-insensitive. but OK.

The reason I provide the text about search being case-sensitive is because the text in my comment says the following;

Results will contain all Employee documents that have EITHER 'English' OR 'Italian' in their 'Notes' field

my comment specified 'English' OR 'Italian'
but results will also contain documents having 'english' OR 'italian' (in the supplied example)
so that is why I thought to mention that.

maciejaszyk · 2024-01-23T14:27:24Z

...mentation.Pages/client-api/session/querying/text-search/boost-search-results.dotnet.markdown

+{CODE-TAB:csharp:DocumentQuery boost_3@ClientApi\Session\Querying\TextSearch\BoostResults.cs /}
+{CODE-TAB-BLOCK:sql:RQL}
+from "Employees" where
+(search(Notes, "English") or boost(search(Notes, "Italian"), 10))


Brackets are not required here.

removed the excess brackets

maciejaszyk · 2024-01-23T14:29:55Z

Documentation/5.4/Samples/csharp/Raven.Documentation.Samples/Indexes/Boosting.cs

+                        .ToList();
+
+                    // Because index-field 'ShipToCountry' was boosted (inside the index definition),
+                    // then documents containing 'Poland' in their 'ShipTo.Country' field will get a higher score than


Remove dot from field name.

The reason I wrote ShipTo.Country is because at this point the sentence refers to the document-field.

As I understand - the content of index-field ShipToCountry is composed of the content from the document-field ShipTo.Country.

So you boost the index-field, but the resulting documents (in this example) are those that contain the matching value in their document-field

=> So is that incorrect ?

I have asked because you have index definition with different fieldname but OK.

maciejaszyk · 2024-01-23T14:31:11Z

Documentation/5.4/Raven.Documentation.Pages/indexes/boosting.java.markdown

@@ -0,0 +1,29 @@
+# Indexes: Boosting
+
+A feature that RavenDB leverages from Lucene is called Boosting. This feature gives you the ability to manually tune the relevance level of matching documents when performing a query. 


Should we use same text as for dotnet version here?

So I added (just) the text to the Java markdown files
but, it needs to be said that for my current scope of work, as was done for previous PRs,
I do not modify, test, or provide new Java examples, I concentrate on C# and Node.js

If a new C# markdown file needs to be created in 6.0 for example, then the Java files (and other clients files)
must be copied over to the folder, otherwise the language will not be visible at run time.

Danielle9897 · 2024-01-24T21:50:21Z

...mentation/5.4/Raven.Documentation.Pages/server/configuration/indexing-configuration.markdown

- **Scope**: Server-wide or per database
+- **Default**: `6`
+- **Scope**: Server-wide, or per database, or per index
+- **Alias:** `Indexing.Lucene.Analyzers.NGram.MaxGram`


@maciejaszyk

Pls see my Q about Lucene in this related issue:
https://issues.hibernatingrhinos.com/issue/RavenDB-19207/Create-new-aliases-for-Lucene-Indexing-configuration#focus=Comments-67-1048397.0-0

Answered in ticket

… order alphabetically

Danielle9897 added 11 commits January 14, 2024 16:01

RDoc-2552 Update indexing-configuration file

6dc3541

RDoc-2514 Explain Boosting options when indexing

7b5c80c

RDoc-2552 Update file "boost-search-results"

93d4536

RDoc-2514 Unify location of how to "Get resulting score"

3359959

RDoc-2514 Update Node.js for file ../indexes/boosting

6ee6712

RDoc-2552 Update file sort-query-results for 6.0

b31fc06

RDoc-2514 Update file ../indexes/boosting for 6.0

5f2774a

RDoc-2332 update the corax page: ../search-engine/corax

d6c2737

RDoc-2552 Fix link to indexing-configuraiton file

2cd2067

RavenDB-2552 Fix typo for NuGetAllowPreReleasePackages

981b1b5

RavenDB-2552 Fix links

09cc414

Danielle9897 commented Jan 17, 2024

View reviewed changes

Danielle9897 requested review from ml054 and maciejaszyk January 17, 2024 17:37

maciejaszyk reviewed Jan 23, 2024

View reviewed changes

Danielle9897 added 2 commits January 24, 2024 21:04

RavenDB-2552 Fix review comments

8815e50

RavenDB-2380 Organize configuration keys by categories

b96f5dc

Danielle9897 commented Jan 24, 2024

View reviewed changes

Danielle9897 requested a review from maciejaszyk January 24, 2024 21:54

RDoc-2380 Added text for keys that are relevant only for Lucene

35c8dfa

Danielle9897 force-pushed the RDoc-2552-disableOrderByScoreWhenBoosting branch from c57d139 to 35c8dfa Compare January 25, 2024 09:15

Danielle9897 mentioned this pull request Jan 30, 2024

RavenDB-22028 Fix order of new Lucene configuration keys ravendb/ravendb#18065

Merged

24 tasks

RDoc-2380 List new Lucene keys as "Title" and older keys as "Alias" +…

843e6c9

… order alphabetically

maciejaszyk approved these changes Jan 31, 2024

View reviewed changes

ml054 approved these changes Feb 6, 2024

View reviewed changes

ppekrol merged commit 692a167 into ravendb:master Feb 6, 2024
1 of 2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

RDoc-2514 Explain Boosting options + Update indexing configuration #1738

RDoc-2514 Explain Boosting options + Update indexing configuration #1738

Danielle9897 commented Jan 17, 2024 •

edited

Loading

Danielle9897 Jan 17, 2024 •

edited

Loading

ml054 Feb 6, 2024

maciejaszyk Jan 23, 2024

Danielle9897 Jan 24, 2024

maciejaszyk Jan 29, 2024

Danielle9897 Jan 29, 2024

maciejaszyk Jan 23, 2024

Danielle9897 Jan 24, 2024

maciejaszyk Jan 23, 2024

Danielle9897 Jan 24, 2024

maciejaszyk Jan 29, 2024

maciejaszyk Jan 23, 2024

Danielle9897 Jan 24, 2024

Danielle9897 Jan 24, 2024

maciejaszyk Jan 29, 2024

		@@ -0,0 +1,29 @@
		# Indexes: Boosting

		A feature that RavenDB leverages from Lucene is called Boosting. This feature gives you the ability to manually tune the relevance level of matching documents when performing a query.

RDoc-2514 Explain Boosting options + Update indexing configuration #1738

RDoc-2514 Explain Boosting options + Update indexing configuration #1738

Conversation

Danielle9897 commented Jan 17, 2024 • edited Loading

Danielle9897 Jan 17, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Danielle9897 commented Jan 17, 2024 •

edited

Loading

Danielle9897 Jan 17, 2024 •

edited

Loading