Skip to content

Commit ba8ac44

Browse files
committed
ReadMe v3 added the Default Values
1 parent e1a6a3c commit ba8ac44

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ A list that contains the `key_prefixes` to use
5454

5555
## --> `score_weights` : float[]
5656
A list that holds the weight value for each of the key_prefixes in the `key_prefixes` field.
57-
For example, in the **Usage** section, the `key_prefix` "mystore-" is beeing multiplied by **0.5** and the "gympass-" for **1**.
57+
For example, in the **Usage** section, the `key_prefix` *"mystore-"* is beeing multiplied by **0.5** and the *"gympass-"* for **1**.
5858

5959
<br/>
6060

@@ -77,14 +77,24 @@ The formula is:
7777
**score** = *elasticsearch_score* (`boost_operator`) ( redis[`key_prefix[0]`+`key_field`] (`score_operator`) redis[`key_prefix[n-1]`+`key_field`])
7878

7979

80-
If `score_operator`: "ADD" **&** `boost_operator`: "MULTIPLY",
80+
If `score_operator`: *"ADD"* **&** `boost_operator`: *"MULTIPLY"*,
8181
The formula will be:
8282
```
8383
score = elasticsearch_score * ( redis[mystore-20] + redis[gympass-20])
8484
```
8585

86+
<br/>
87+
<br/>
8688

89+
# Field Default Values
90+
The only field that is **required** for the plugin to run is the `key_field`, all the others can be `null`.
91+
## Default Values
92+
### `score_operator` | `boost_operator`
93+
***"ADD"***
94+
<br/>
8795

96+
### `scores_weight` | `boost_weight`
97+
***1***
8898
<br/>
8999
<br/>
90100

0 commit comments

Comments
 (0)