Browse Source

Add example for decay (#134705)

Ioana Tagirta 1 month ago
parent
commit
f21200641f

+ 11 - 1
docs/reference/query-languages/esql/_snippets/functions/examples/decay.md

@@ -3,7 +3,17 @@
 **Example**
 
 ```esql
-null
+FROM employees
+| EVAL decay_result = decay(salary, 0, 100000, {"offset": 5, "decay": 0.5, "type": "linear"})
+| SORT decay_result DESC
 ```
 
+| decay_result:double |
+| --- |
+| 0.873405 |
+| 0.8703 |
+| 0.870145 |
+| 0.867845 |
+| 0.86395 |
+
 

+ 1 - 1
docs/reference/query-languages/esql/kibana/definition/functions/decay.json

@@ -254,7 +254,7 @@
     }
   ],
   "examples" : [
-    null
+    "FROM employees\n| EVAL decay_result = decay(salary, 0, 100000, {\"offset\": 5, \"decay\": 0.5, \"type\": \"linear\"})\n| SORT decay_result DESC"
   ],
   "preview" : true,
   "snapshot_only" : false

+ 3 - 1
docs/reference/query-languages/esql/kibana/docs/functions/decay.md

@@ -4,5 +4,7 @@
 Calculates a relevance score that decays based on the distance of a numeric, spatial or date type value from a target origin, using configurable decay functions.
 
 ```esql
-null
+FROM employees
+| EVAL decay_result = decay(salary, 0, 100000, {"offset": 5, "decay": 0.5, "type": "linear"})
+| SORT decay_result DESC
 ```

+ 5 - 1
x-pack/plugin/esql/qa/testFixtures/src/main/resources/decay.csv-spec

@@ -104,18 +104,22 @@ decay_result:double
 intMultipleRows
 required_capability: decay_function
 
+// tag::decay[]
 FROM employees
 | EVAL decay_result = decay(salary, 0, 100000, {"offset": 5, "decay": 0.5, "type": "linear"})
-| KEEP decay_result
 | SORT decay_result DESC
+// end::decay[]
+| KEEP decay_result
 | LIMIT 5;
 
+// tag::decay-result[]
 decay_result:double
 0.873405
 0.8703
 0.870145
 0.867845
 0.86395
+// end::decay-result[]
 ;
 
 intOriginReference