(dsl): Support `Boosting` query #364

vanjaftn · 2023-11-14T13:05:19Z

Part of #64

dbulaja98 · 2023-11-16T15:05:36Z

docs/overview/queries/elastic_query_boost.md

+title: "Boosting Query"
+---
+
+The `Boosting` query returns documents that match the positive query. Among those documents, the ones that also match the negative query get their relevance score lowered by multiplying it by the negative boosting factor. 


Suggested change

The `Boosting` query returns documents that match the positive query. Among those documents, the ones that also match the negative query get their relevance score lowered by multiplying it by the negative boosting factor.

The `Boosting` query returns documents that match the query marked as `positive` while reducing the relevance score of documents that also match a query which is marked as `negative` query.

dbulaja98 · 2023-11-16T15:12:17Z

modules/library/src/main/scala/zio/elasticsearch/ElasticPrimitive.scala

@@ -39,6 +39,10 @@ object ElasticPrimitive {
    def toJson(value: Double): Json = Num(value)
  }

+  implicit object ElasticFloat extends ElasticPrimitive[Float] {


Just keep in mind when you start with rebase later that you have already added this in other PR.

dbulaja98 · 2023-11-16T15:17:05Z

modules/library/src/main/scala/zio/elasticsearch/ElasticQuery.scala

+   * criteria using the specified parameters.
+   *
+   * @param negativeBoost
+   *   the query that decreases the relevance score of matching documents.


Suggested change

* the query that decreases the relevance score of matching documents.

* the number between 0 and 1.0 used to decrease the relevance score of documents matching the negative query

dbulaja98 · 2023-11-16T15:21:29Z

modules/library/src/main/scala/zio/elasticsearch/ElasticQuery.scala

+   * @return
+   *   an instance of [[zio.elasticsearch.query.BoostQuery]] that represents the boost query to be performed.
+   */
+  final def boost[S: Schema](


Can you rename both methods to boosting?

dbulaja98 · 2023-11-16T15:22:01Z

modules/library/src/main/scala/zio/elasticsearch/ElasticQuery.scala

+   * the specified parameters.
+   *
+   * @param negativeBoost
+   *   the query that decreases the relevance score of matching documents.


dbulaja98 · 2023-11-16T15:23:12Z

modules/library/src/main/scala/zio/elasticsearch/ElasticQuery.scala

+   * @param negativeQuery
+   *   the query that decreases the relevance score of matching documents.
+   * @param positiveQuery
+   *   the query that must be satisfied.


Suggested change

* the query that must be satisfied.

* the query that must be satisfied

dbulaja98 · 2023-11-16T15:23:40Z

modules/library/src/main/scala/zio/elasticsearch/query/Queries.scala

@@ -184,6 +184,24 @@ private[elasticsearch] final case class Bool[S](
  }
 }

+sealed trait BoostQuery[S] extends ElasticQuery[S]
+
+private[elasticsearch] final case class Boost[S](


Can you rename this to Boosting[S]?

dbulaja98 · 2023-11-16T15:24:00Z

modules/library/src/main/scala/zio/elasticsearch/query/Queries.scala

@@ -184,6 +184,24 @@ private[elasticsearch] final case class Bool[S](
  }
 }

+sealed trait BoostQuery[S] extends ElasticQuery[S]


Can you rename this to BoostingQuery[S]?

dbulaja98 · 2023-11-16T15:25:02Z

modules/library/src/test/scala/zio/elasticsearch/ElasticQuerySpec.scala

@@ -334,6 +334,28 @@ object ElasticQuerySpec extends ZIOSpecDefault {
            )
          }
        ),
+        test("boost") {


Suggested change

test("boost") {

test("boosting") {

dbulaja98 · 2023-11-16T15:26:01Z

modules/library/src/test/scala/zio/elasticsearch/ElasticQuerySpec.scala

@@ -2146,6 +2168,32 @@ object ElasticQuerySpec extends ZIOSpecDefault {
            assert(queryWithAllParams.toJson(fieldPath = None))(equalTo(expectedWithAllParams.toJson))
          }
        ),
+        test("boost") {


Suggested change

test("boost") {

test("boosting") {

dbulaja98 · 2023-11-17T20:59:12Z

modules/library/src/main/scala/zio/elasticsearch/ElasticQuery.scala

+   * Constructs a type-safe instance of [[zio.elasticsearch.query.BoostingQuery]] with queries that must satisfy the
+   * criteria using the specified parameters.


Suggested change

* Constructs a type-safe instance of [[zio.elasticsearch.query.BoostingQuery]] with queries that must satisfy the

* criteria using the specified parameters.

* Constructs a type-safe instance of [[zio.elasticsearch.query.BoostingQuery]] using the specified parameters.

And maybe add something like text in doc:
Boosting query returns documents that match the query marked as positive while reducing the relevance score of documents that also match a query which is marked as negative query.

dbulaja98 · 2023-11-17T21:00:29Z

modules/library/src/main/scala/zio/elasticsearch/ElasticQuery.scala

+   * Constructs an instance of [[zio.elasticsearch.query.BoostingQuery]] with queries that must satisfy the criteria
+   * using the specified parameters.


dbulaja98 · 2023-11-17T21:01:02Z

modules/library/src/main/scala/zio/elasticsearch/ElasticQuery.scala

+   * @param positiveQuery
+   *   the query that must be satisfied
+   * @return
+   *   an instance of [[zio.elasticsearch.query.BoostingQuery]] that represents the boost query to be performed


Suggested change

* an instance of [[zio.elasticsearch.query.BoostingQuery]] that represents the boost query to be performed

* an instance of [[zio.elasticsearch.query.BoostingQuery]] that represents the boost query to be performed.

dbulaja98 · 2023-11-17T21:01:11Z

modules/library/src/main/scala/zio/elasticsearch/ElasticQuery.scala

+   * @tparam S
+   *   document for which field query is executed. An implicit `Schema` instance must be in scope
+   * @return
+   *   an instance of [[zio.elasticsearch.query.BoostingQuery]] that represents the boost query to be performed


Suggested change

* an instance of [[zio.elasticsearch.query.BoostingQuery]] that represents the boost query to be performed

* an instance of [[zio.elasticsearch.query.BoostingQuery]] that represents the boost query to be performed.

vanjaftn changed the title ~~(dsl): Support Boosting query~~ (dsl): Support Boosting query Nov 14, 2023

dbulaja98 requested changes Nov 16, 2023

View reviewed changes

vanjaftn force-pushed the task-support-boosting-query branch from 8704dc9 to 32320e9 Compare November 17, 2023 11:59

dbulaja98 requested changes Nov 17, 2023

View reviewed changes

vanjaftn added 4 commits November 20, 2023 09:40

Support Boosting query

b1a4719

Fix code remarks

d94b4fb

Implement changes in Boosting query

4a8f2ab

Fix code remarks

04a7850

vanjaftn force-pushed the task-support-boosting-query branch from 66f571c to 04a7850 Compare November 20, 2023 08:41

dbulaja98 approved these changes Nov 20, 2023

View reviewed changes

dbulaja98 merged commit 4cf07e7 into lambdaworks:main Nov 20, 2023
13 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

(dsl): Support `Boosting` query #364

(dsl): Support `Boosting` query #364

vanjaftn commented Nov 14, 2023 •

edited by dbulaja98

dbulaja98 Nov 16, 2023

dbulaja98 Nov 16, 2023

dbulaja98 Nov 16, 2023

dbulaja98 Nov 16, 2023

dbulaja98 Nov 16, 2023

dbulaja98 Nov 16, 2023

dbulaja98 Nov 16, 2023

dbulaja98 Nov 16, 2023

dbulaja98 Nov 16, 2023

dbulaja98 Nov 16, 2023

dbulaja98 Nov 17, 2023

dbulaja98 Nov 17, 2023

dbulaja98 Nov 17, 2023

dbulaja98 Nov 17, 2023

dbulaja98 Nov 17, 2023

	The `Boosting` query returns documents that match the positive query. Among those documents, the ones that also match the negative query get their relevance score lowered by multiplying it by the negative boosting factor.
	The `Boosting` query returns documents that match the query marked as `positive` while reducing the relevance score of documents that also match a query which is marked as `negative` query.

	* the query that decreases the relevance score of matching documents.
	* the number between 0 and 1.0 used to decrease the relevance score of documents matching the negative query

	* the query that must be satisfied.
	* the query that must be satisfied

		* Constructs a type-safe instance of [[zio.elasticsearch.query.BoostingQuery]] with queries that must satisfy the
		* criteria using the specified parameters.

		* Constructs an instance of [[zio.elasticsearch.query.BoostingQuery]] with queries that must satisfy the criteria
		* using the specified parameters.

	* an instance of [[zio.elasticsearch.query.BoostingQuery]] that represents the boost query to be performed
	* an instance of [[zio.elasticsearch.query.BoostingQuery]] that represents the boost query to be performed.

(dsl): Support Boosting query #364

(dsl): Support Boosting query #364

Conversation

vanjaftn commented Nov 14, 2023 • edited by dbulaja98

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

(dsl): Support `Boosting` query #364

(dsl): Support `Boosting` query #364

vanjaftn commented Nov 14, 2023 •

edited by dbulaja98