_data/idl-fns.yml

# # Licensed to the Apache Software Foundation (ASF) under one or more # contributor license agreements. See the NOTICE file distributed with # this work for additional information regarding copyright ownership. # The ASF licenses this file to You under the Apache License, Version 2.0 # (the "License"); you may not use this file except in compliance with # the License. You may obtain a copy of the License at # # https://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # # # IDL functions documentation. # fn-ent: - name: ent_type sig: | ent_type(t: Entityopt) ⇒ String, # ⇒ String synopsis: Returns <a href="/apis/latest/org/apache/nlpcraft/NCEntity.html#getType-0">entity type</a> desc: | Returns <a href="/apis/latest/org/apache/nlpcraft/NCEntity.html#getType-0">entity type</a> for the current entity (default) or the provided one by the optional parameter <code>t</code>. Note that this functions has a special shorthand <code>#</code>. usage: | // Result: 'true' if the current entity type is equal to 'my_type'. ent_type == 'my_type' # == 'my_type' ent_type(ent_this) == 'my_type' #(ent_this) == 'my_type' - name: ent_groups sig: | ent_groups(t: Entityopt) ⇒ List[String] synopsis: Gets the list of <a class="not-code" href="/apis/latest/org/apache/nlpcraft/NCEntity.html#getGroups-0">groups</a> this entity belongs to desc: | Gets the list of <a class="not-code" href="/apis/latest/org/apache/nlpcraft/NCEntity.html#getGroups-0">groups</a> the current entity (default) or the provided one by the optional parameter <code>t</code> belongs to. Note that, by default, if not specified explicitly, entity always belongs to one group with type equal to entity type. May return an empty list but never a <code>null</code>. usage: | // Result: list of groups this entity belongs to. ent_groups ent_groups(ent_this) - name: ent_this sig: | ent_this ⇒ Entity synopsis: Returns current entity desc: | Returns current entity. usage: | // Result: current entity. ent_this - name: ent_text sig: | ent_text(t: Entityopt) ⇒ String synopsis: Returns entity's original text desc: | Returns <a class="not-code" href="/apis/latest/org/apache/nlpcraft/NCEntity.html#mkText-0">entity's original text</a>. If <code>t</code> is not provided the current entity is assumed. usage: | // Result: entity original input text. ent_text - name: ent_index sig: | ent_index(t: Entityopt) ⇒ Long synopsis: Returns entity's index in the original input desc: | Returns entity's index in the original input. Note that this is an index of the entity and not of the character. If <code>t</code> is not provided the current entity is assumed. usage: | // Result: 'true' if index of this entity in the original input is equal to 1. ent_index == 1 ent_index(ent_this) == 1 - name: ent_is_first sig: | ent_is_first(t: Entityopt) ⇒ Boolean synopsis: Returns <code>true</code> if this entity is the first in the original input desc: | Returns <code>true</code> if this entity is the first in the original input. Note that this checks index of the entity and not of the character. If <code>t</code> is not provided the current entity is assumed. usage: | // Result: 'true' if this entity is the first entity in the original input. ent_is_first ent_is_first(ent_this) - name: ent_is_last sig: | ent_is_last(t: Entityopt) ⇒ Boolean synopsis: Returns <code>true</code> if this entity is the last in the original input desc: | Returns <code>true</code> if this entity is the last in the original input. Note that this checks index of the entity and not of the character. If <code>t</code> is not provided the current entity is assumed usage: | // Result: 'true' if this entity is the last entity in the original input. ent_is_last ent_is_last(ent_this) - name: ent_is_before_type sig: | ent_is_before_type(type: String) ⇒ Boolean synopsis: Returns <code>true</code> if there is a entity with type <code>type</code> after this entity desc: | Returns <code>true</code> if there is a entity with type <code>type</code> after this entity. usage: | // Result: 'true' if there is a entity with type 'a' after this entity. ent_is_before_type('a') - name: ent_is_after_type sig: | ent_is_after_type(type: String) ⇒ Boolean synopsis: Returns <code>true</code> if there is a entity with type <code>type</code> before this entity desc: | Returns <code>true</code> if there is a entity with type <code>type</code> before this entity. usage: | // Result: 'true' if there is a entity with type 'a' before this entity. ent_is_after_type('a') - name: ent_is_between_types sig: | ent_is_between_types(type1: String, type2: String) ⇒ Boolean synopsis: Returns <code>true</code> if this entity is located between entities with types <code>type1</code> and <code>type2</code> desc: | Returns <code>true</code> if this entity is located between entities with types <code>type1</code> and <code>type2</code>. usage: | // Result: 'true' if this entity is located after entity with type 'before' and before the entity with type 'after'. ent_is_between_types('before', 'after') - name: ent_is_between_groups sig: | ent_is_between_groups(grp1: String, grp2: String) ⇒ Boolean synopsis: Returns <code>true</code> if this entity is located between entities with group IDs <code>grp1</code> and <code>grp2</code> desc: | Returns <code>true</code> if this entity is located between entities with group IDs <code>grp1</code> and <code>grp2</code>. usage: | // Result: 'true' if this entity is located after entity belonging to the group 'before' and before the entity belonging to the group 'after'. ent_is_between_groups('before', 'after') - name: ent_is_before_group sig: | ent_is_before_group(grp: String) ⇒ Boolean synopsis: | Returns <code>true</code> if there is a entity that belongs to the <a class="not-code" href="/apis/latest/org/apache/nlpcraft/NCEntity.html#getGroups-0">group</a> <code>grp</code> after this entity desc: | Returns <code>true</code> if there is a entity that belongs to the <a class="not-code" href="/apis/latest/org/apache/nlpcraft/NCEntity.html#getGroups-0">group</a> <code>grp</code> after this entity. usage: | // Result: 'true' if there is a entity that belongs to the group 'grp' after this entity. ent_is_before_group('grp') - name: ent_is_after_group sig: | ent_is_after_group(grp: String) ⇒ Boolean synopsis: | Returns <code>true</code> if there is a entity that belongs to the <a class="not-code" href="/apis/latest/org/apache/nlpcraft/NCEntity.html#getGroups-0">group</a> <code>grp</code> before this entity desc: | Returns <code>true</code> if there is a entity that belongs to the <a class="not-code" href="/apis/latest/org/apache/nlpcraft/NCEntity.html#getGroups-0">group</a> <code>grp</code> before this entity. usage: | // Result: 'true' if there is a entity that belongs to the group 'grp' before this entity. ent_is_after_group('grp') - name: ent_all sig: | ent_all ⇒ List[Entity] synopsis: | Returns all entities from the original input desc: | Returns all entities from the original input. usage: | // Result: list of all entities for the original input. ent_all - name: ent_count sig: | ent_count ⇒ Long synopsis: | Returns number of entities from the original input desc: | Returns number of entities from the original input. It is equivalent to <code>size(ent_all)</code> usage: | // Result: number of all entities for the original input. ent_count - name: ent_all_for_type sig: | ent_all_for_type(type: String) ⇒ List[Entity] synopsis: | Returns list of entities from the original input with type <code>type</code> desc: | Returns list of entities from the original input with type <code>type</code>. usage: | // Result: list of entities for the original input that have type 'type'. ent_all_for_type('type') - name: ent_all_for_group sig: | ent_all_for_group(grp: String) ⇒ List[Entity] synopsis: | Returns list of entities from the original input that belong to the group <code>grp</code> desc: | Returns list of entities from the original input that belong to the group <code>grp</code>. usage: | // Result: list of entities for the original input that belong to th group 'grp'. ent_all_for_group('grp') fn-datetime: - name: year sig: | year ⇒ Long synopsis: Returns current year desc: | Returns current year. usage: | // Result: 2021 year - name: month sig: | month ⇒ Long synopsis: | Returns current month: 1 ... 12 desc: | Returns current month: 1 ... 12. usage: | // Result: 5 month - name: day_of_month sig: | day_of_month ⇒ Long synopsis: | Returns current day of the month: 1 ... 31 desc: | Returns current day of the month: 1 ... 31. usage: | // Result: 5 day_of_month - name: day_of_week sig: | day_of_week ⇒ Long synopsis: | Returns current day of the week: 1 ... 7 desc: | Returns current day of the week: 1 ... 7. usage: | // Result: 5 day_of_week - name: day_of_year sig: | day_of_year ⇒ Long synopsis: | Returns current day of the year: 1 ... 365 desc: | Returns current day of the year: 1 ... 365. usage: | // Result: 51 day_of_year - name: hour sig: | hour ⇒ Long synopsis: | Returns current hour: 0 ... 23 desc: | Returns current hour: 0 ... 23. usage: | // Result: 11 hour - name: minute sig: | minute ⇒ Long synopsis: | Returns current minute: 0 ... 59 desc: | Returns current minute: 0 ... 59. usage: | // Result: 11 minute - name: second sig: | second ⇒ Long synopsis: | Returns current second: 0 ... 59 desc: | Returns current second: 0 ... 59. usage: | // Result: 11 second - name: week_of_month sig: | week_of_month ⇒ Long synopsis: | Returns current week of the month: 1 ... 4 desc: | Returns current week of the month: 1 ... 4. usage: | // Result: 2 week_of_month - name: week_of_year sig: | week_of_year ⇒ Long synopsis: | Returns current week of the year: 1 ... 56 desc: | Returns current week of the year: 1 ... 56. usage: | // Result: 21 week_of_year - name: quarter sig: | quarter ⇒ Long synopsis: | Returns current quarter: 1 ...4 desc: | Returns current quarter: 1 ... 4. usage: | // Result: 2 quarter - name: now sig: | now ⇒ Long synopsis: | Returns current time in milliseconds desc: | Returns current time in milliseconds. usage: | // Result: 122312341212 now fn-req: - name: req_id sig: | req_id ⇒ String synopsis: Returns <a class="not-code" href="/apis/latest/org/apache/nlpcraft/NCRequest.html#getRequestId-0">request ID</a> desc: | Returns <a class="not-code" href="/apis/latest/org/apache/nlpcraft/NCRequest.html#getRequestId-0">request ID</a>. usage: | // Result: request ID. req_id - name: req_text sig: | req_text ⇒ String synopsis: Returns request <a class="not-code" target="javadoc" href="/apis/latest/org/apache/nlpcraft/NCRequest.html#getText-0">text</a> desc: | Returns request <a class="not-code" target="javadoc" href="/apis/latest/org/apache/nlpcraft/NCRequest.html#getText-0">text</a>. usage: | // Result: request text. req_text - name: req_tstamp sig: | req_tstamp ⇒ Long synopsis: Gets UTC/GMT receive <a class="not-code" target="javadoc" href="/apis/latest/org/apache/nlpcraft/NCRequest.html#getReceiveTimestamp-0">timestamp</a> desc: | Gets UTC/GMT <a class="not-code" target="javadoc" href="/apis/latest/org/apache/nlpcraft/NCRequest.html#getReceiveTimestamp-0">timestamp</a> in ms when user input was received. usage: | // Result: input receive timsstamp in ms. req_tstamp - name: user_id sig: | user_id ⇒ String synopsis: Returns <code>user ID</code> desc: | Returns <code>user ID</code> usage: | // Result: user ID. user_id fn-math: - name: abs sig: | abs(x: {Long|Double}) ⇒ {Long|Double} synopsis: Returns absolute value for parameter <code>x</code> desc: | Returns absolute value for parameter <code>x</code>. usage: | // Result: 1 abs(-1) // Result: 1.5 abs(-1.5) - name: ceil sig: | ceil(d: Double) ⇒ Double synopsis: Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#ceil(double)"><code>Math.ceil(d)</code></a> desc: | Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#ceil(double)"><code>Math.ceil(d)</code></a>. usage: | // Result: 2.0 ceil(1.5) - name: floor sig: | floor(d: Double) ⇒ Double synopsis: Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#floor(double)"><code>Math.floor(d)</code></a> desc: | Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#floor(double)"><code>Math.floor(d)</code></a>. usage: | // Result: 1.0 floor(1.5) - name: rint sig: | rint(d: Double) ⇒ Double synopsis: Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#rint(double)"><code>Math.rint(d)</code></a> desc: | Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#rint(double)"><code>Math.rint(d)</code></a>. usage: | // Result: 1.0 rint(1.2) - name: round sig: | round(d: Double) ⇒ Long synopsis: Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#round(double)"><code>Math.round(d)</code></a> desc: | Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#round(double)"><code>Math.round(d)</code></a>. usage: | // Result: 1 round(1.2) - name: signum sig: | signum(d: Double) ⇒ Double synopsis: Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#signum(double)"><code>Math.signum(d)</code></a> desc: | Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#signum(double)"><code>Math.signum(d)</code></a>. usage: | // Result: 1.0 signum(1.2) - name: sqrt sig: | sqrt(d: Double) ⇒ Double synopsis: Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#sqrt(double)"><code>Math.sqrt(d)</code></a> desc: | Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#sqrt(double)"><code>Math.sqrt(d)</code></a>. usage: | // Result: 4.0 sqrt(2.0) - name: cbrt sig: | cbrt(d: Double) ⇒ Double synopsis: Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#cbrt(double)"><code>Math.cbrt(d)</code></a> desc: | Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#cbrt(double)"><code>Math.cbrt(d)</code></a>. usage: | // Result: -3.0 cbrt(-27.0) - name: acos sig: | acos(d: Double) ⇒ Double synopsis: Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#acos(double)"><code>Math.acos(d)</code></a> desc: | Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#acos(double)"><code>Math.acos(d)</code></a>. usage: | acos(1.0) - name: asin sig: | asin(d: Double) ⇒ Double synopsis: Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#asin(double)"><code>Math.asin(d)</code></a> desc: | Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#asin(double)"><code>Math.asin(d)</code></a>. usage: | asin(1.0) - name: atan sig: | atan(d: Double) ⇒ Double synopsis: Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#atan(double)"><code>Math.atan(d)</code></a> desc: | Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#atan(double)"><code>Math.atan(d)</code></a>. usage: | atan(1.0) - name: tan sig: | tan(d: Double) ⇒ Double synopsis: Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#tan(double)"><code>Math.tan(d)</code></a> desc: | Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#tan(double)"><code>Math.tan(d)</code></a>. usage: | tan(1.0) - name: sin sig: | sin(d: Double) ⇒ Double synopsis: Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#sin(double)"><code>Math.sin(d)</code></a> desc: | Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#sin(double)"><code>Math.sin(d)</code></a>. usage: | sin(1.0) - name: cos sig: | cos(d: Double) ⇒ Double synopsis: Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#cos(double)"><code>Math.cos(d)</code></a> desc: | Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#cos(double)"><code>Math.cos(d)</code></a>. usage: | cos(1.0) - name: tanh sig: | tanh(d: Double) ⇒ Double synopsis: Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#tanh(double)"><code>Math.tanh(d)</code></a> desc: | Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#tanh(double)"><code>Math.tanh(d)</code></a>. usage: | tanh(1.0) - name: sinh sig: | sinh(d: Double) ⇒ Double synopsis: Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#sinh(double)"><code>Math.sinh(d)</code></a> desc: | Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#sinh(double)"><code>Math.sinh(d)</code></a>. usage: | sinh(1.0) - name: cosh sig: | cosh(d: Double) ⇒ Double synopsis: Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#cosh(double)"><code>Math.cosh(d)</code></a> desc: | Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#cosh(double)"><code>Math.cosh(d)</code></a>. usage: | cosh(1.0) - name: atan2 sig: | atan2(d1: Double, d2: Double) ⇒ Double synopsis: Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#atan2(double, double)"><code>Math.atan2(d2, d2)</code></a> desc: | Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#atan2(double, double)"><code>Math.atan2(d1, d2)</code></a>. usage: | atan2(1.0, 1.0) - name: degrees sig: | degrees(d: Double) ⇒ Double synopsis: Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#toDegrees(double)"><code>Math.toDegrees(d)</code></a> desc: | Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#toDegrees(double)"><code>Math.toDegrees(d)</code></a>. usage: | degrees(1.0) - name: radians sig: | radians(d: Double) ⇒ Double synopsis: Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#toRadians(double)"><code>Math.toRadians(d)</code></a> desc: | Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#toRadians(double)"><code>Math.toRadians(d)</code></a>. usage: | radians(1.0) - name: exp sig: | exp(d: Double) ⇒ Double synopsis: Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#exp(double)"><code>Math.exp(d)</code></a> desc: | Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#exp(double)"><code>Math.exp(d)</code></a>. usage: | exp(1.0) - name: expm1 sig: | expm1(d: Double) ⇒ Double synopsis: Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#expm1(double)"><code>Math.expm1(d)</code></a> desc: | Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#expm1(double)"><code>Math.expm1(d)</code></a>. usage: | expm1(1.0) - name: log sig: | log(d: Double) ⇒ Double synopsis: Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#log(double)"><code>Math.log(d)</code></a> desc: | Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#log(double)"><code>Math.log(d)</code></a>. usage: | log(1.0) - name: log10 sig: | log10(d: Double) ⇒ Double synopsis: Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#log10(double)"><code>Math.log10(d)</code></a> desc: | Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#log10(double)"><code>Math.log10(d)</code></a>. usage: | log10(1.0) - name: square sig: | square(x: {Long|Double}) ⇒ {Long|Double} synopsis: Returns square of <code>>x</code> desc: | Returns square of <code>>x</code> usage: | // Result: 4 square(2) - name: log1p sig: | log1p(d: Double) ⇒ Double synopsis: Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#log1p(double)"><code>Math.log1p(d)</code></a> desc: | Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#log1p(double)"><code>Math.log1p(d)</code></a>. usage: | log1p(1.0) - name: pi sig: | pi ⇒ Double synopsis: Returns PI constant desc: | Returns PI constant. usage: | // Result: 3.14159265359 pi - name: euler sig: | pi ⇒ Double synopsis: Returns Euler constant desc: | Returns Euler constant. usage: | // Result: 0.5772156649 euler - name: max sig: | max(c: List) ⇒ Any synopsis: Returns maximum value for given list desc: | Returns maximum value for given list. Throws runtime exception if the list is empty. This function uses a natural ordering. usage: | // Result: 3 max(list(1, 2, 3)) - name: min sig: | min(c: List) ⇒ Any synopsis: Returns minimum value for given list desc: | Returns minimum value for given list. Throws runtime exception if the list is empty. This function uses a natural ordering. usage: | // Result: 1 min(list(1, 2, 3)) - name: avg sig: | avg(c: List[{Long|Double|String}]) ⇒ Double synopsis: Returns average (mean) value for given list desc: | Returns average (mean) value for given list of ints, doubles or strings. Throws runtime exception if the list is empty. If list list contains strings, they have to be convertable to int or double. usage: | // Result: 2.0 avg(list(1, 2, 3)) avg(list("1.0", 2, "3")) - name: stdev sig: | stdev(c: List[{Long|Double|String}]) ⇒ Double synopsis: Returns standard deviation value for given list desc: | Returns standard deviation value for given list of ints, doubles or strings. Throws runtime exception if the list is empty. If list list contains strings, they have to be convertable to int or double. usage: | stdev(list(1, 2, 3)) stdev(list("1.0", 2, "3")) - name: pow sig: | pow(d1: Double, d2: Double) ⇒ Double synopsis: Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#pow(double, double)"><code>Math.pow(d2, d2)</code></a> desc: | Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#pow(double, double)"><code>Math.pow(d1, d2)</code></a>. usage: | // Result: 4.0 pow(2.0, 2.0) - name: hypot sig: | hypot(d1: Double, d2: Double) ⇒ Double synopsis: Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#hypot(double, double)"><code>Math.hypot(d2, d2)</code></a> desc: | Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Math.html#hypot(double, double)"><code>Math.hypot(d1, d2)</code></a>. usage: | hypot(2.0, 2.0) fn-collections: - name: list sig: | list(t: Any...opt) ⇒ List[Any] synopsis: Returns new list with given parameters desc: | Returns new list with given parameters. usage: | // Result: [] list // Result: [1, 2, 3] list(1, 2, 3) // Result: ["1", true, 1.25] list("1", 2 == 2, to_double('1.25')) - name: get sig: | get(c: {List|Map}, k: {Long|Any}) ⇒ Any synopsis: Gets element <code>k</code> from either list or map <code>c</code> desc: | Gets element from either list or map <code>c</code>. For list the <code>k</code> must be 0-based integer index in the list. usage: | // Result: 1 get(list(1, 2, 3), 0) // Result: true get(json('{"a": true}'), "a") - name: has sig: | has(c: List, x: Any) ⇒ Boolean synopsis: Calls <code>c</code>.<a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/List.html#contains(java.lang.Object)"><code>contains(x</code>)</a> desc: | Calls <code>c</code>.<a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/List.html#contains(java.lang.Object)"><code>contains(x</code>)</a> and returns its result. usage: | // Result: true has(list("a", "b"), "a") - name: has_all sig: | has_all(c: List, x: Any) ⇒ Boolean synopsis: Calls <code>c</code>.<a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/List.html#containsAll(java.util.Collection)"><code>containsAll(x</code>)</a> desc: | Calls <code>c</code>.<a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/List.html#containsAll(java.util.Collection)"><code>containsAll(x</code>)</a> and returns its result. usage: | // Result: false has_all(list("a", "b"), "a") - name: has_any sig: | has_any(c: List, x: List) ⇒ Boolean synopsis: Checks if list <code>c</code> contains any of the elements from the list <code>x</code> desc: | Checks if list <code>c</code> contains any of the elements from the list <code>x</code>. usage: | // Result: true has_any(list("a", "b"), list("a")) - name: first sig: | first(c: List) ⇒ Any synopsis: Returns first element from the list <code>c</code> or <code>null</code> desc: | Returns first element from the list <code>c</code> or <code>null</code> if the list is empty. usage: | // Result: "a" first(list("a", "b")) - name: last sig: | last(c: List) ⇒ Any synopsis: Returns last element from the list <code>c</code> or <code>null</code> desc: | Returns last element from the list <code>c</code> or <code>null</code> if the list is empty. usage: | // Result: "b" last(list("a", "b")) - name: keys sig: | keys(m: Map) ⇒ Any synopsis: Returns list of keys for map <code>m</code> desc: | Returns list of keys for map <code>m</code>. usage: | // Result: ["a", "b"] keys(json('{"a": true, "b": 1}')) - name: values sig: | values(m: Map) ⇒ Any synopsis: Returns list of values for map <code>m</code> desc: | Returns list of values for map <code>m</code>. usage: | // Result: [true, 1] values(json('{"a": true, "b": 1}')) - name: reverse sig: | reverse(x: List) ⇒ List synopsis: Reverses the list <code>x</code> desc: | Returns reversed list <code>x</code>. This function uses the natural sorting order. usage: | // Result: [3, 2, 1] reverse(list(1, 2, 3)) - name: sort sig: | sort(x: List) ⇒ List synopsis: Sorts the list <code>x</code> desc: | Returns sorted list <code>x</code>. This function uses the natural sorting order. usage: | // Result: [1, 2, 3] sort(list(2, 1, 3)) - name: is_empty sig: | is_empty(x: {String|List|Map}) ⇒ Boolean synopsis: Checks if given string, list or map is <code>x</code> empty desc: | Checks if given string, list or map <code>x</code> is empty. usage: | // Result: false is_empty("text") is_empty(list(1)) is_empty(json('{"a": 1}')) - name: non_empty sig: | non_empty(x: {String|List|Map}) ⇒ Boolean synopsis: Checks if given string, list or map is <code>x</code> non empty desc: | Checks if given string, list or map <code>x</code> is non empty. usage: | // Result: true non_empty("text") non_empty(list(1)) non_empty(json('{"a": 1}')) - name: distinct sig: | distinct(x: List) ⇒ List synopsis: Makes list <code>x</code> distinct desc: | Makes list <code>x</code> distinct. usage: | // Result: [1, 2, 3] distinct(list(1, 2, 2, 3, 1)) - name: concact sig: | concat(x1: List, x1: List) ⇒ List synopsis: Concatenates lists <code>x1</code> and <code>x2</code> desc: | Concatenates lists <code>x1</code> and <code>x2</code>. usage: | // Result: [1, 2, 3, 4] concat(list(1, 2), list(3, 4)) fn-metadata: - name: meta_ent sig: | meta_ent(p: String) ⇒ Any synopsis: Gets entity metadata property <code>p</code> desc: | Gets entity metadata property <code>p</code>. usage: | // Result: 'nlp:token:text' entity metadata property. meta_ent('nlp:token:text') - name: meta_req sig: | meta_req(p: String) ⇒ Any synopsis: Gets request metadata property <code>p</code> desc: | Gets request metadata property <code>p</code>. usage: | // Result: 'my:prop' user request data property. meta_req('my:prop') - name: meta_intent sig: | meta_intent(p: String) ⇒ Any synopsis: Gets intent metadata property <code>p</code> desc: | Gets intent metadata property <code>p</code>. usage: | // Result: 'my:prop' intent metadata property. meta_intent('my:prop') - name: meta_conv sig: | meta_conv(p: String) ⇒ Any synopsis: Gets conversation metadata property <code>p</code> desc: | Gets conversation metadata property <code>p</code>. usage: | // Result: 'my:prop' conversation metadata property. meta_conv('my:prop') - name: meta_frag sig: | meta_frag(p: String) ⇒ Any synopsis: Gets fragment metadata property <code>p</code> desc: | Gets fragment metadata property <code>p</code>. Fragment metadata can be optionally passed in when referencing the fragment to parameterize it. usage: | // Result: 'my:prop' fragment metadata property. meta_frag('my:prop') - name: meta_sys sig: | meta_sys(p: String) ⇒ Any synopsis: Gets system property or environment variable <code>p</code> desc: | Gets system property or environment variable <code>p</code>. usage: | // Result: 'java.home' system property. meta_sys('java.home') // Result: 'HOME' environment variable. meta_sys('HOME') - name: meta_cfg sig: | meta_cfg(p: String) ⇒ Any synopsis: Gets configuration property <code>p</code> desc: | Gets configuration property <code>p</code>. usage: | // Result: 'my:prop' configuration property. meta_cfg('my:prop') fn-other: - name: if sig: | if(c: Boolean, then: Any: else: Any) ⇒ Any synopsis: This function provides 'if-then-else' equivalent desc: | This function provides 'if-then-else' equivalent as IDL does not provide branching on the language level. This function will evaluate <code>c</code> parameter and either return <code>then</code> value if it evaluates to <code>true</code> or <code>else</code> value in case if it evaluates to <code>false</code>. Note that evaluation will be short-circuit, i.e. either <code>then</code> or <code>else</code> will actually be computed but not both. usage: | // Result: // - 'list(1, 2, 3)' if 1st parameter is 'true'. // - 'null' if 1st parameter is 'false'. if(meta_model('my_prop') == true, list(1, 2, 3), null) - name: json sig: | json(p: String) ⇒ Map[String, Any] synopsis: Converts JSON in <code>p</code> parameter to a map desc: | Converts JSON in <code>p</code> parameter to a map. Use single quoted string to avoid escaping double quotes in JSON. usage: | // Result: Map. json('{"a": 2, "b": [1, 2, 3]}') - name: to_string sig: | to_string(p: Any) ⇒ {String|List[String]} synopsis: Converts <code>p</code> parameter to a string desc: | Converts <code>p</code> parameter to a string. In case of a list this function will convert individual list elements to string and return the list of strings. usage: | // Result: "1.25" to_string(1.25) // Result: list("1", "2", "3") to_string(list(1, 2, 3)) - name: or_else sig: | or_else(p: Any, a: Any) ⇒ Any synopsis: Returns <code>p</code> if it is not <code>null</code>, <code>a</code> otherwise desc: | Returns <code>p</code> if it is not <code>null</code>, <code>a</code> otherwise. Note that evaluation will be short-circuit, i.e. <code>a</code> will be evaluated only if <code>p</code> is <code>null</code>. usage: | // Result: 'some_prop' model metadata or 'text' if one is 'null'. @dflt = 'text' or_else(meta_model('some_prop'), @dflt) fn-text: - name: length sig: | length(p: {String|List|Map}) ⇒ Long synopsis: Returns size or length of the given string, list or map desc: | Returns size or length of the given string, list or map. This function has aliases: <code>size</code> and <code>count</code>. usage: | // Result: 9 length("some text") // Result: 3 @lst = list(1, 2, 3) size(@lst) count(@lst) - name: regex sig: | regex(s: String, rx: String) ⇒ Boolean synopsis: Checks whether string <code>s</code> matches Java regular expression <code>rx</code> desc: | Returns <code>true</code> if string <code>s</code> matches Java regular expression <code>rx</code>, <code>false</code> otherwise. usage: | regex('textabc', '^text.*$') // Returns 'true'. regex('_textabc', '^text.*$') // Returns 'false'. - name: trim sig: | trim(p: String) ⇒ Long synopsis: Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html#trim()"><code>String.trim()</code></a> desc: | Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html#trim()"><code>String.trim()</code></a> on given parameter <code>p</code> and returns its result. This function has alias: <code>strip</code> usage: | // Result: "text" trim(" text ") strip(" text ") - name: uppercase sig: | uppercase(p: String) ⇒ String synopsis: Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html#toUpperCase()"><code>String.toUpperCase()</code></a> desc: | Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html#toUpperCase()"><code>String.toUpperCase()</code></a> on given parameter <code>p</code> and returns its result. usage: | // Result: "TEXT" uppercase("text") - name: lowercase sig: | lowercase(p: String) ⇒ String synopsis: Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html#toLowerCase()"><code>String.toLowerCase()</code></a> desc: | Calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html#toLowerCase()"><code>String.toLowerCase()</code></a> on given parameter <code>p</code> and returns its result. usage: | // Result: "text" lowercase("TeXt") - name: is_alpha sig: | is_alpha(p: String) ⇒ Boolean synopsis: Calls <a target="javadoc" href="https://commons.apache.org/proper/commons-lang/apidocs/org/apache/commons/lang3/StringUtils.html#isAlpha-java.lang.CharSequence-"><code>StringUtils.isAlpha()</code></a> desc: | Calls <a target="asf" href="https://commons.apache.org/">Apache Commons</a> <a target="javadoc" href="https://commons.apache.org/proper/commons-lang/apidocs/org/apache/commons/lang3/StringUtils.html#isAlpha-java.lang.CharSequence-"><code>StringUtils.isAlpha()</code></a> on given parameter <code>p</code> and returns its result. usage: | // Result: true is_alpha("text") - name: is_alphanum sig: | is_alphanum(p: String) ⇒ Boolean synopsis: Calls <a target="javadoc" href="https://commons.apache.org/proper/commons-lang/apidocs/org/apache/commons/lang3/StringUtils.html#isAlphanumeric-java.lang.CharSequence-"><code>StringUtils.isAlphanumeric()</code></a> desc: | Calls <a target="asf" href="https://commons.apache.org/">Apache Commons</a> <a target="javadoc" href="https://commons.apache.org/proper/commons-lang/apidocs/org/apache/commons/lang3/StringUtils.html#isAlphanumeric-java.lang.CharSequence-"><code>StringUtils.isAlphanumeric()</code></a> on given parameter <code>p</code> and returns its result. usage: | // Result: true is_alphanum("text123") - name: is_whitespace sig: | is_whitespace(p: String) ⇒ Boolean synopsis: Calls <a target="javadoc" href="https://commons.apache.org/proper/commons-lang/apidocs/org/apache/commons/lang3/StringUtils.html#isWhitespace-java.lang.CharSequence-"><code>StringUtils.isWhitespace()</code></a> desc: | Calls <a target="asf" href="https://commons.apache.org/">Apache Commons</a> <a target="javadoc" href="https://commons.apache.org/proper/commons-lang/apidocs/org/apache/commons/lang3/StringUtils.html#isWhitespace-java.lang.CharSequence-"><code>StringUtils.isWhitespace()</code></a> on given parameter <code>p</code> and returns its result. usage: | // Result: false is_whitespace("text123") // Result: true is_whitespace(" ") - name: is_num sig: | is_num(p: String) ⇒ Boolean synopsis: Calls <a target="javadoc" href="https://commons.apache.org/proper/commons-lang/apidocs/org/apache/commons/lang3/StringUtils.html#isNumeric-java.lang.CharSequence-"><code>StringUtils.isNumeric()</code></a> desc: | Calls <a target="asf" href="https://commons.apache.org/">Apache Commons</a> <a target="javadoc" href="https://commons.apache.org/proper/commons-lang/apidocs/org/apache/commons/lang3/StringUtils.html#isNumeric-java.lang.CharSequence-"><code>StringUtils.isNumeric()</code></a> on given parameter <code>p</code> and returns its result. usage: | // Result: true is_num("123") - name: is_numspace sig: | is_numspace(p: String) ⇒ Boolean synopsis: Calls <a target="javadoc" href="https://commons.apache.org/proper/commons-lang/apidocs/org/apache/commons/lang3/StringUtils.html#isNumericSpace-java.lang.CharSequence-"><code>StringUtils.isNumericSpace()</code></a> desc: | Calls <a target="asf" href="https://commons.apache.org/">Apache Commons</a> <a target="javadoc" href="https://commons.apache.org/proper/commons-lang/apidocs/org/apache/commons/lang3/StringUtils.html#isNumericSpace-java.lang.CharSequence-"><code>StringUtils.isNumericSpace()</code></a> on given parameter <code>p</code> and returns its result. usage: | // Result: true is_numspace(" 123") - name: is_alphaspace sig: | is_alphaspace(p: String) ⇒ Boolean synopsis: Calls <a target="javadoc" href="https://commons.apache.org/proper/commons-lang/apidocs/org/apache/commons/lang3/StringUtils.html#isAlphaSpace-java.lang.CharSequence-"><code>StringUtils.isAlphaSpace()</code></a> desc: | Calls <a target="asf" href="https://commons.apache.org/">Apache Commons</a> <a target="javadoc" href="https://commons.apache.org/proper/commons-lang/apidocs/org/apache/commons/lang3/StringUtils.html#isAlphaSpace-java.lang.CharSequence-"><code>StringUtils.isAlphaSpace()</code></a> on given parameter <code>p</code> and returns its result. usage: | // Result: true is_alphaspace(" text ") - name: is_alphanumspace sig: | is_alphanumspace(p: String) ⇒ Boolean synopsis: Calls <a target="javadoc" href="https://commons.apache.org/proper/commons-lang/apidocs/org/apache/commons/lang3/StringUtils.html#isAlphaNumericSpace-java.lang.CharSequence-"><code>StringUtils.isAlphaNumericSpace()</code></a> desc: | Calls <a target="asf" href="https://commons.apache.org/">Apache Commons</a> <a target="javadoc" href="https://commons.apache.org/proper/commons-lang/apidocs/org/apache/commons/lang3/StringUtils.html#isAlphaNumericSpace-java.lang.CharSequence-"><code>StringUtils.isAlphaNumericSpace()</code></a> on given parameter <code>p</code> and returns its result. usage: | // Result: true is_alphanumspace(" 123 text ") - name: split sig: | split(p1: String, p2: String) ⇒ List[String] synopsis: Calls <code>p1</code>.<a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html#split(java.lang.String)"><code>split(p2)</code></a> desc: | Calls <code>p1</code>.<a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html#split(java.lang.String)"><code>split(p2)</code></a> and returns its result converted to the list. usage: | // Result: [ "a", "b", "c" ] split("a|b|c", "|") - name: split_trim sig: | split_trim(p1: String, p2: String) ⇒ List[String] synopsis: Calls <code>p1</code>.<a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html#split(java.lang.String)"><code>split(p2)</code></a> desc: | Calls <code>p1</code>.<a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html#split(java.lang.String)"><code>split(p2)</code></a> converting the result to the list. Then calls <a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html#strip()">String.strip()</a> on each element. usage: | // Result: ["a", "b", "c"] split_trim("a | b | c", "|") - name: starts_with sig: | starts_with(p1: String, p2: String) ⇒ Boolean synopsis: Calls <code>p1</code>.<a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html#split(java.lang.String)"><code>startsWith(p2)</code></a> desc: | Calls <code>p1</code>.<a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html#split(java.lang.String)"><code>startsWith(p2)</code></a> and returns its result. usage: | // Result: true starts_width("abc", "ab") - name: ends_with sig: | ends_with(p1: String, p2: String) ⇒ Boolean synopsis: Calls <code>p1</code>.<a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html#split(java.lang.String)"><code>endsWith(p2)</code></a> desc: | Calls <code>p1</code>.<a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html#split(java.lang.String)"><code>endsWith(p2)</code></a> and returns its result. usage: | // Result: true ends_width("abc", "bc") - name: contains sig: | contains(p1: String, p2: String) ⇒ Boolean synopsis: Calls <code>p1</code>.<a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html#contains(java.lang.CharSequence)"><code>contains(p2)</code></a> desc: | Calls <code>p1</code>.<a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html#contains(java.lang.CharSequence)"><code>contains(p2)</code></a> and returns its result. usage: | // Result: true contains("abc", "bc") - name: index_of sig: | index_of(p1: String, p2: String) ⇒ Long synopsis: Calls <code>p1</code>.<a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html#indexOf(java.lang.String)"><code>indexOf(p2)</code></a> desc: | Calls <code>p1</code>.<a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html#indexOf(java.lang.String)"><code>indexOf(p2)</code></a> and returns its result. usage: | // Result: 1 index_of("abc", "bc") - name: substr sig: | substr(p1: String, p2: Long, p3: Long) ⇒ String synopsis: Calls <code>p1</code>.<a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html#substring(int,int)"><code>substring(p2, p3)</code></a> desc: | Calls <code>p1</code>.<a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html#substring(int,int)"><code>substring(p2, p3)</code></a> and returns its result. usage: | // Result: "bc" substr("abc", 1, 3) - name: replace sig: | replace(p1: String, p2: String, p3: String) ⇒ String synopsis: Calls <code>p1</code>.<a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html#replace(java.lang.CharSequence,java.lang.CharSequence)"><code>replace(p2, p3)</code></a> desc: | Calls <code>p1</code>.<a target="javadoc" href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html#replace(java.lang.CharSequence,java.lang.CharSequence)"><code>replace(p2, p3)</code></a> and returns its result. usage: | // Result: "aBC" replace("abc", "bc", "BC") - name: to_double sig: | to_double(p1: {Long|String}) ⇒ Double synopsis: Converts given integer or string to double value desc: | Converts given integer or string to double value. usage: | // Result: 1.2 to_double("1.2") // Result: 1.0 to_double(1) - name: to_int sig: | to_int(p1: {Double|String}) ⇒ Long synopsis: Converts given double or string to integer value desc: | Converts given double or string to integer value. In case of double value it will be rounded to the nearest integer value. usage: | // Result: 1 to_int("1.2") to_int(1.2)

_data/idl-fns.yml (1,139 lines of code) (raw):