askui 0.20.1 → 0.20.2

package/dist/cjs/execution/dsl.d.ts

@@ -3,7 +3,7 @@ import { DetectedElement } from '../core/model/annotation-result/detected-elemen
 export declare enum Separators {
     STRING = "<|string|>"
 }
-export declare type INTERSECTING_OPTION = 'center' | 'bbox' | 'screen';
+export declare type INTERSECTION_AREA = 'element_center_line' | 'element_edge_area' | 'display_edge_area';
 export declare type PC_KEY = 'backspace' | 'delete' | 'enter' | 'tab' | 'escape' | 'up' | 'down' | 'right' | 'left' | 'home' | 'end' | 'pageup' | 'pagedown' | 'f1' | 'f2' | 'f3' | 'f4' | 'f5' | 'f6' | 'f7' | 'f8' | 'f9' | 'f10' | 'f11' | 'f12' | 'space' | '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g' | 'h' | 'i' | 'j' | 'k' | 'l' | 'm' | 'n' | 'o' | 'p' | 'q' | 'r' | 's' | 't' | 'u' | 'v' | 'w' | 'x' | 'y' | 'z' | 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H' | 'I' | 'J' | 'K' | 'L' | 'M' | 'N' | 'O' | 'P' | 'Q' | 'R' | 'S' | 'T' | 'U' | 'V' | 'W' | 'X' | 'Y' | 'Z' | '!' | '"' | '#' | '$' | '%' | '&' | "'" | '(' | ')' | '*' | '+' | ',' | '-' | '.' | '/' | ':' | ';' | '<' | '=' | '>' | '?' | '@' | '[' | '\\' | ']' | '^' | '_' | '`' | '{' | '|' | '}' | '~ ';
 export declare type ANDROID_KEY = 'home' | 'back' | 'call' | 'endcall' | '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'star' | 'pound' | 'dpad_up' | 'dpad_down' | 'dpad_left' | 'dpad_right' | 'dpad_center' | 'volume_up' | 'volume_down' | 'power' | 'camera' | 'clear' | 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g' | 'h' | 'i' | 'j' | 'k' | 'l' | 'm' | 'n' | 'o' | 'p' | 'q' | 'r' | 's' | 't' | 'u' | 'v' | 'w' | 'x' | 'y' | 'z' | 'comma' | 'period' | 'alt_left' | 'alt_right' | 'shift_left' | 'shift_right' | 'tab' | 'space' | 'sym' | 'explorer' | 'envelope' | 'enter' | 'del' | 'grave' | 'minus' | 'equals' | 'left_bracket' | 'right_bracket' | 'backslash' | 'semicolon' | 'apostrophe' | 'slash' | 'at' | 'num' | 'headsethook' | 'focus' | 'plus' | 'menu' | 'notification' | 'search' | 'media_play_pause' | 'media_stop' | 'media_next' | 'media_previous' | 'media_rewind' | 'media_fast_forward' | 'mute' | 'page_up' | 'page_down' | 'switch_charset' | 'escape' | 'forward_del' | 'ctrl_left' | 'ctrl_right' | 'caps_lock' | 'scroll_lock' | 'function' | 'break' | 'move_home' | 'move_end' | 'insert' | 'forward' | 'media_play' | 'media_pause' | 'media_close' | 'media_eject' | 'media_record' | 'f1' | 'f2' | 'f3' | 'f4' | 'f5' | 'f6' | 'f7' | 'f8' | 'f9' | 'f10' | 'f11' | 'f12' | 'num_lock' | 'numpad_0' | 'numpad_1' | 'numpad_2' | 'numpad_3' | 'numpad_4' | 'numpad_5' | 'numpad_6' | 'numpad_7' | 'numpad_8' | 'numpad_9' | 'numpad_divide' | 'numpad_multiply' | 'numpad_subtract' | 'numpad_add' | 'numpad_dot' | 'numpad_comma' | 'numpad_enter' | 'numpad_equals' | 'numpad_left_paren' | 'numpad_right_paren' | 'volume_mute' | 'info' | 'channel_up' | 'channel_down' | 'zoom_in' | 'zoom_out' | 'window' | 'guide' | 'bookmark' | 'captions' | 'settings' | 'app_switch' | 'language_switch' | 'contacts' | 'calendar' | 'music' | 'calculator' | 'assist' | 'brightness_down' | 'brightness_up' | 'media_audio_track' | 'sleep' | 'wakeup' | 'pairing' | 'media_top_menu' | 'last_channel' | 'tv_data_service' | 'voice_assist' | 'help' | 'navigate_previous' | 'navigate_next' | 'navigate_in' | 'navigate_out' | 'dpad_up_left' | 'dpad_down_left' | 'dpad_up_right' | 'dpad_down_right' | 'media_skip_forward' | 'media_skip_backward' | 'media_step_forward' | 'media_step_backward' | 'soft_sleep' | 'cut' | 'copy' | 'paste' | 'all_apps' | 'refresh';
 export declare type MODIFIER_KEY = 'command' | 'alt' | 'control' | 'shift' | 'right_shift';
@@ -121,6 +121,7 @@ export declare class FluentFilters extends FluentBase {
      */
     cell(row_index: number, column_index: number): FluentFiltersOrRelations;
     /**
+     * Filters for a UI element 'table'.
      *
      * @return {FluentFiltersOrRelations}
      */
@@ -145,6 +146,8 @@ export declare class FluentFilters extends FluentBase {
      * await aui.click().text().withTextRegex('\b[Ss]\w+').exec();
      * ```
      *
+     * @param {string} [text] - A text to be matched.
+     *
      * @return {FluentFiltersOrRelations}
      */
     text(text?: string): FluentFiltersOrRelations;
@@ -166,9 +169,9 @@ export declare class FluentFilters extends FluentBase {
      */
     icon(): FluentFiltersOrRelations;
     /**
-     * Filters for a 'custom element', that is a UI element which is defined by providing an image and other parameters such as degree of rotation. It allows filtering for a UI element based on an image instead of using text or element descriptions like `button().withText('Submit')` in `await aui.click().button().withText('Submit').exec()`.
+     * Filters for a 'custom element', that is a UI element that is defined by providing an image and other parameters such as degree of rotation. It allows filtering for a UI element based on an image instead of using text or element descriptions like `button().withText('Submit')` in `await aui.click().button().withText('Submit').exec()`.
      *
-     * See the tutorial - [Custom Element](https://docs.askui.com/docs/general/Tutorials/custom-element) for more detail.
+     * See the tutorial - [Custom Element](https://docs.askui.com/docs/general/Element%20Selection/custom-elements) for more details.
      *
      * **Example**
      * ```typescript
@@ -199,7 +202,7 @@ export declare class FluentFilters extends FluentBase {
      * - **rotationDegreePerStep** (*`number`, optional*):
      *     - Step size in rotation degree. Rotates the custom image by this step size until 360° is exceeded. The range is from `0` to `360`. Defaults to `0`.
      * - **imageCompareFormat** (*`'RGB' | 'grayscale' | 'edges'`, optional*):
-     *     - The color compare style. 'edges' compares only edges, 'greyscale' compares the brightness of each pixel whereas 'RGB' compares all three colors (red, green, blue). Defaults to 'grayscale'.
+     *     - The color compare style. `'edges'` compares only edges, `'greyscale'` compares the brightness of each pixel whereas `'RGB'` compares all three colors (red, green, blue). Defaults to `'grayscale'`.
      *
      *
      * @param {CustomElementJson} customElement - The custom element to filter for.
@@ -208,7 +211,13 @@ export declare class FluentFilters extends FluentBase {
      */
     customElement(customElement: CustomElementJson): FluentFiltersOrRelations;
     /**
-     * Detects an AI Element created with the workflow creator.
+     * Detects an AI Element created with the [snipping workflow](https://docs.askui.com/docs/general/Components/aielement#snipping-workflow).
+     *
+     * **Examples:**
+     *
+     * ```typescript
+     * await aui.click().aiElement('askui-logo').exec();
+     * ```
      *
      * @param {string} aiElementName - Name of the AI Element.
      *
@@ -279,12 +288,13 @@ export declare class FluentFilters extends FluentBase {
      * 'other' === withText('text') => false
      *
      * // optional parameter: similarity_score
-     * '978-0-201-00650-6' == withText('978-0-201-00') => true with 82.76 similarity
-     * '978-0-201-00650-6' == withText('978-0-201-00650', 90) => true with 93.75 < 90 similarity
+     * '978-0-201-00650-6' == withText("978-0-201-00", 90) => false with 82.76 < 90 similarity
+     * '978-0-201-00650-6' == withText("978-0-201-00650", 90) => true with 93.75 > 90 similarity
      * ```
      * ![](https://docs.askui.com/img/gif/withText.gif)
      *
      * @param {string} text - A text to be matched.
+     * @param {number} [similarityScore=70] - Similarity score minimum value, it should be between `0` and `100`.
      *
      * @return {FluentFiltersOrRelations}
      */
@@ -366,7 +376,7 @@ export declare class FluentFilters extends FluentBase {
      * E.g., `puzzle piece` can fail while `an icon showing a puzzle piece` might work.
      * Generally, the more detail the better.
      *
-     * We also recommend to not restrict the type of element by using the generalselector `element()` as shown in the examples below.
+     * We also recommend to not restrict the type of element by using the general selector `element()` as shown in the examples below.
      *
      * **Examples:**
      * ```typescript
@@ -520,7 +530,12 @@ export declare class FluentFiltersOrRelations extends FluentFilters {
     /**
      * Filters for an element right of another element.
      *
-     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     * Takes an optional parameter `index` to select the nth element (defaults to `0`).
+     *
+     * Takes an optional parameter `intersection_area` to specify which elements right of the other element are filtered for based on their vertical position (y-coordinates of bounding box):
+     * - `"element_center_line"` - considered right of the other element if element's bounding box intersects with a horizontal line passing through the center of the other element
+     * - `"element_edge_area"` - considered right of the other element if element's bounding box intersects with an area between the top and the bottom edge of the other element
+     * - `"display_edge_area"` - considered right of the other element no matter where it is placed vertically on the screen (y-axis)
      *
      * **Examples:**
      * ```typescript
@@ -538,13 +553,21 @@ export declare class FluentFiltersOrRelations extends FluentFilters {
      * ```
      * ![](https://docs.askui.com/img/gif/rightOf.gif)
      *
+     * @param {number} [index=0] - Index of element to filter for going into the direction specified. Defaults to `0` which is the first element (zero-indexed) found in that direction.
+     * @param {INTERSECTION_AREA} [intersection_area="element_edge_area"] - Intersecting with either `"element_center_line"`, `"element_edge_area"` or `"display_edge_area"`. Defaults to `"element_edge_area"`.
+     *
      * @return {FluentFilters}
      */
-    rightOf(optionalIndex?: number, intersecting?: INTERSECTING_OPTION): FluentFilters;
+    rightOf(index?: number, intersection_area?: INTERSECTION_AREA): FluentFilters;
     /**
      * Filters for an element left of another element.
      *
-     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     * Takes an optional parameter `index` to select the nth element (defaults to `0`).
+     *
+     * Takes an optional parameter `intersection_area` to specify which elements left of the other element are filtered for based on their vertical position (y-coordinates of bounding box):
+     * - `"element_center_line"` - considered left of the other element if element's bounding box intersects with a horizontal line passing through the center of the other element
+     * - `"element_edge_area"` - considered left of the other element if element's bounding box intersects with an area between the top and the bottom edge of the other element
+     * - `"display_edge_area"` - considered left of the other element no matter where it is placed vertically on the screen (y-axis)
      *
      * **Examples:**
      * ```typescript
@@ -562,13 +585,21 @@ export declare class FluentFiltersOrRelations extends FluentFilters {
      * ```
      * ![](https://docs.askui.com/img/gif/leftOf.gif)
      *
+     * @param {number} [index=0] - Index of element to filter for going into the direction specified. Defaults to `0` which is the first element (zero-indexed) found in that direction.
+     * @param {INTERSECTION_AREA} [intersection_area="element_edge_area"] - Intersecting with either `"element_center_line"`, `"element_edge_area"` or `"display_edge_area"`. Defaults to `"element_edge_area"`.
+     *
      * @return {FluentFilters}
      */
-    leftOf(optionalIndex?: number, intersecting?: INTERSECTING_OPTION): FluentFilters;
+    leftOf(index?: number, intersection_area?: INTERSECTION_AREA): FluentFilters;
     /**
      * Filters for an element below another element.
      *
-     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     * Takes an optional parameter `index` to select the nth element (defaults to `0`).
+     *
+     * Takes an optional parameter `intersection_area` to specify which elements below of the other element are filtered for based on their horizontal position (y-coordinates of bounding box):
+     * - `"element_center_line"` - considered below of the other element if element's bounding box intersects with a vertical line passing through the center of the other element
+     * - `"element_edge_area"` - considered below of the other element if element's bounding box intersects with an area between the left and the right edge of the other element
+     * - `"display_edge_area"` - considered below of the other element no matter where it is placed horizontally on the screen (y-axis)
      *
      * **Examples:**
      * ```typescript
@@ -592,13 +623,21 @@ export declare class FluentFiltersOrRelations extends FluentFilters {
      * ```
      * ![](https://docs.askui.com/img/gif/below.gif)
      *
+     * @param {number} [index=0] - Index of element to filter for going into the direction specified. Defaults to `0` which is the first element (zero-indexed) found in that direction.
+     * @param {INTERSECTION_AREA} [intersection_area="element_edge_area"] - Intersecting with either `"element_center_line"`, `"element_edge_area"` or `"display_edge_area"`. Defaults to `"element_edge_area"`.
+     *
      * @return {FluentFilters}
      */
-    below(optionalIndex?: number, intersecting?: INTERSECTING_OPTION): FluentFilters;
+    below(index?: number, intersection_area?: INTERSECTION_AREA): FluentFilters;
     /**
      * Filters for an element above another element.
      *
-     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     * Takes an optional parameter `index` to select the nth element (defaults to `0`).
+     *
+     * Takes an optional parameter `intersection_area` to specify which elements above of the other element are filtered for based on their horizontal position (y-coordinates of bounding box):
+     * - `"element_center_line"` - considered above of the other element if element's bounding box intersects with a vertical line passing through the center of the other element
+     * - `"element_edge_area"` - considered above of the other element if element's bounding box intersects with an area between the left and the right edge of the other element
+     * - `"display_edge_area"` - considered above of the other element no matter where it is placed horizontally on the screen (y-axis)
      *
      * **Examples:**
      * ```typescript
@@ -622,9 +661,12 @@ export declare class FluentFiltersOrRelations extends FluentFilters {
      * ```
      * ![](https://docs.askui.com/img/gif/above.gif)
      *
+     * @param {number} [index=0] - Index of element to filter for going into the direction specified. Defaults to `0` which is the first element (zero-indexed) found in that direction.
+     * @param {INTERSECTION_AREA} [intersection_area="element_edge_area"] - Intersecting with either `"element_center_line"`, `"element_edge_area"` or `"display_edge_area"`. Defaults to `"element_edge_area"`.
+     *
      * @return {FluentFilters}
      */
-    above(optionalIndex?: number, intersecting?: INTERSECTING_OPTION): FluentFilters;
+    above(index?: number, intersection_area?: INTERSECTION_AREA): FluentFilters;
     /**
      * Filters for an element nearest to another element.
      *
@@ -767,6 +809,7 @@ export declare class FluentFiltersCondition extends FluentBase {
      */
     cell(row_index: number, column_index: number): FluentFiltersOrRelationsCondition;
     /**
+     * Filters for a UI element 'table'.
      *
      * @return {FluentFiltersOrRelationsCondition}
      */
@@ -791,6 +834,8 @@ export declare class FluentFiltersCondition extends FluentBase {
      * await aui.click().text().withTextRegex('\b[Ss]\w+').exec();
      * ```
      *
+     * @param {string} [text] - A text to be matched.
+     *
      * @return {FluentFiltersOrRelationsCondition}
      */
     text(text?: string): FluentFiltersOrRelationsCondition;
@@ -812,9 +857,9 @@ export declare class FluentFiltersCondition extends FluentBase {
      */
     icon(): FluentFiltersOrRelationsCondition;
     /**
-     * Filters for a 'custom element', that is a UI element which is defined by providing an image and other parameters such as degree of rotation. It allows filtering for a UI element based on an image instead of using text or element descriptions like `button().withText('Submit')` in `await aui.click().button().withText('Submit').exec()`.
+     * Filters for a 'custom element', that is a UI element that is defined by providing an image and other parameters such as degree of rotation. It allows filtering for a UI element based on an image instead of using text or element descriptions like `button().withText('Submit')` in `await aui.click().button().withText('Submit').exec()`.
      *
-     * See the tutorial - [Custom Element](https://docs.askui.com/docs/general/Tutorials/custom-element) for more detail.
+     * See the tutorial - [Custom Element](https://docs.askui.com/docs/general/Element%20Selection/custom-elements) for more details.
      *
      * **Example**
      * ```typescript
@@ -845,7 +890,7 @@ export declare class FluentFiltersCondition extends FluentBase {
      * - **rotationDegreePerStep** (*`number`, optional*):
      *     - Step size in rotation degree. Rotates the custom image by this step size until 360° is exceeded. The range is from `0` to `360`. Defaults to `0`.
      * - **imageCompareFormat** (*`'RGB' | 'grayscale' | 'edges'`, optional*):
-     *     - The color compare style. 'edges' compares only edges, 'greyscale' compares the brightness of each pixel whereas 'RGB' compares all three colors (red, green, blue). Defaults to 'grayscale'.
+     *     - The color compare style. `'edges'` compares only edges, `'greyscale'` compares the brightness of each pixel whereas `'RGB'` compares all three colors (red, green, blue). Defaults to `'grayscale'`.
      *
      *
      * @param {CustomElementJson} customElement - The custom element to filter for.
@@ -854,7 +899,13 @@ export declare class FluentFiltersCondition extends FluentBase {
      */
     customElement(customElement: CustomElementJson): FluentFiltersOrRelationsCondition;
     /**
-     * Detects an AI Element created with the workflow creator.
+     * Detects an AI Element created with the [snipping workflow](https://docs.askui.com/docs/general/Components/aielement#snipping-workflow).
+     *
+     * **Examples:**
+     *
+     * ```typescript
+     * await aui.click().aiElement('askui-logo').exec();
+     * ```
      *
      * @param {string} aiElementName - Name of the AI Element.
      *
@@ -925,12 +976,13 @@ export declare class FluentFiltersCondition extends FluentBase {
      * 'other' === withText('text') => false
      *
      * // optional parameter: similarity_score
-     * '978-0-201-00650-6' == withText('978-0-201-00') => true with 82.76 similarity
-     * '978-0-201-00650-6' == withText('978-0-201-00650', 90) => true with 93.75 < 90 similarity
+     * '978-0-201-00650-6' == withText("978-0-201-00", 90) => false with 82.76 < 90 similarity
+     * '978-0-201-00650-6' == withText("978-0-201-00650", 90) => true with 93.75 > 90 similarity
      * ```
      * ![](https://docs.askui.com/img/gif/withText.gif)
      *
      * @param {string} text - A text to be matched.
+     * @param {number} [similarityScore=70] - Similarity score minimum value, it should be between `0` and `100`.
      *
      * @return {FluentFiltersOrRelationsCondition}
      */
@@ -1012,7 +1064,7 @@ export declare class FluentFiltersCondition extends FluentBase {
      * E.g., `puzzle piece` can fail while `an icon showing a puzzle piece` might work.
      * Generally, the more detail the better.
      *
-     * We also recommend to not restrict the type of element by using the generalselector `element()` as shown in the examples below.
+     * We also recommend to not restrict the type of element by using the general selector `element()` as shown in the examples below.
      *
      * **Examples:**
      * ```typescript
@@ -1166,7 +1218,12 @@ export declare class FluentFiltersOrRelationsCondition extends FluentFiltersCond
     /**
      * Filters for an element right of another element.
      *
-     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     * Takes an optional parameter `index` to select the nth element (defaults to `0`).
+     *
+     * Takes an optional parameter `intersection_area` to specify which elements right of the other element are filtered for based on their vertical position (y-coordinates of bounding box):
+     * - `"element_center_line"` - considered right of the other element if element's bounding box intersects with a horizontal line passing through the center of the other element
+     * - `"element_edge_area"` - considered right of the other element if element's bounding box intersects with an area between the top and the bottom edge of the other element
+     * - `"display_edge_area"` - considered right of the other element no matter where it is placed vertically on the screen (y-axis)
      *
      * **Examples:**
      * ```typescript
@@ -1184,13 +1241,21 @@ export declare class FluentFiltersOrRelationsCondition extends FluentFiltersCond
      * ```
      * ![](https://docs.askui.com/img/gif/rightOf.gif)
      *
+     * @param {number} [index=0] - Index of element to filter for going into the direction specified. Defaults to `0` which is the first element (zero-indexed) found in that direction.
+     * @param {INTERSECTION_AREA} [intersection_area="element_edge_area"] - Intersecting with either `"element_center_line"`, `"element_edge_area"` or `"display_edge_area"`. Defaults to `"element_edge_area"`.
+     *
      * @return {FluentFiltersCondition}
      */
-    rightOf(optionalIndex?: number, intersecting?: INTERSECTING_OPTION): FluentFiltersCondition;
+    rightOf(index?: number, intersection_area?: INTERSECTION_AREA): FluentFiltersCondition;
     /**
      * Filters for an element left of another element.
      *
-     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     * Takes an optional parameter `index` to select the nth element (defaults to `0`).
+     *
+     * Takes an optional parameter `intersection_area` to specify which elements left of the other element are filtered for based on their vertical position (y-coordinates of bounding box):
+     * - `"element_center_line"` - considered left of the other element if element's bounding box intersects with a horizontal line passing through the center of the other element
+     * - `"element_edge_area"` - considered left of the other element if element's bounding box intersects with an area between the top and the bottom edge of the other element
+     * - `"display_edge_area"` - considered left of the other element no matter where it is placed vertically on the screen (y-axis)
      *
      * **Examples:**
      * ```typescript
@@ -1208,13 +1273,21 @@ export declare class FluentFiltersOrRelationsCondition extends FluentFiltersCond
      * ```
      * ![](https://docs.askui.com/img/gif/leftOf.gif)
      *
+     * @param {number} [index=0] - Index of element to filter for going into the direction specified. Defaults to `0` which is the first element (zero-indexed) found in that direction.
+     * @param {INTERSECTION_AREA} [intersection_area="element_edge_area"] - Intersecting with either `"element_center_line"`, `"element_edge_area"` or `"display_edge_area"`. Defaults to `"element_edge_area"`.
+     *
      * @return {FluentFiltersCondition}
      */
-    leftOf(optionalIndex?: number, intersecting?: INTERSECTING_OPTION): FluentFiltersCondition;
+    leftOf(index?: number, intersection_area?: INTERSECTION_AREA): FluentFiltersCondition;
     /**
      * Filters for an element below another element.
      *
-     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     * Takes an optional parameter `index` to select the nth element (defaults to `0`).
+     *
+     * Takes an optional parameter `intersection_area` to specify which elements below of the other element are filtered for based on their horizontal position (y-coordinates of bounding box):
+     * - `"element_center_line"` - considered below of the other element if element's bounding box intersects with a vertical line passing through the center of the other element
+     * - `"element_edge_area"` - considered below of the other element if element's bounding box intersects with an area between the left and the right edge of the other element
+     * - `"display_edge_area"` - considered below of the other element no matter where it is placed horizontally on the screen (y-axis)
      *
      * **Examples:**
      * ```typescript
@@ -1238,13 +1311,21 @@ export declare class FluentFiltersOrRelationsCondition extends FluentFiltersCond
      * ```
      * ![](https://docs.askui.com/img/gif/below.gif)
      *
+     * @param {number} [index=0] - Index of element to filter for going into the direction specified. Defaults to `0` which is the first element (zero-indexed) found in that direction.
+     * @param {INTERSECTION_AREA} [intersection_area="element_edge_area"] - Intersecting with either `"element_center_line"`, `"element_edge_area"` or `"display_edge_area"`. Defaults to `"element_edge_area"`.
+     *
      * @return {FluentFiltersCondition}
      */
-    below(optionalIndex?: number, intersecting?: INTERSECTING_OPTION): FluentFiltersCondition;
+    below(index?: number, intersection_area?: INTERSECTION_AREA): FluentFiltersCondition;
     /**
      * Filters for an element above another element.
      *
-     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     * Takes an optional parameter `index` to select the nth element (defaults to `0`).
+     *
+     * Takes an optional parameter `intersection_area` to specify which elements above of the other element are filtered for based on their horizontal position (y-coordinates of bounding box):
+     * - `"element_center_line"` - considered above of the other element if element's bounding box intersects with a vertical line passing through the center of the other element
+     * - `"element_edge_area"` - considered above of the other element if element's bounding box intersects with an area between the left and the right edge of the other element
+     * - `"display_edge_area"` - considered above of the other element no matter where it is placed horizontally on the screen (y-axis)
      *
      * **Examples:**
      * ```typescript
@@ -1268,9 +1349,12 @@ export declare class FluentFiltersOrRelationsCondition extends FluentFiltersCond
      * ```
      * ![](https://docs.askui.com/img/gif/above.gif)
      *
+     * @param {number} [index=0] - Index of element to filter for going into the direction specified. Defaults to `0` which is the first element (zero-indexed) found in that direction.
+     * @param {INTERSECTION_AREA} [intersection_area="element_edge_area"] - Intersecting with either `"element_center_line"`, `"element_edge_area"` or `"display_edge_area"`. Defaults to `"element_edge_area"`.
+     *
      * @return {FluentFiltersCondition}
      */
-    above(optionalIndex?: number, intersecting?: INTERSECTING_OPTION): FluentFiltersCondition;
+    above(index?: number, intersection_area?: INTERSECTION_AREA): FluentFiltersCondition;
     /**
      * Filters for an element nearest to another element.
      *
@@ -1568,7 +1652,7 @@ export declare abstract class FluentCommand extends FluentBase {
      */
     scroll(x_offset: number, y_offset: number): Exec;
     /**
-     * Executes a shell command on the device your UiController is connected to.
+     * Executes a shell command on the device your AskUI Controller is connected to.
      *
      * **Example:**
      * ```typescript
@@ -1916,6 +2000,7 @@ export declare class FluentFiltersGetter extends FluentBase {
      */
     cell(row_index: number, column_index: number): FluentFiltersOrRelationsGetter;
     /**
+     * Filters for a UI element 'table'.
      *
      * @return {FluentFiltersOrRelationsGetter}
      */
@@ -1940,6 +2025,8 @@ export declare class FluentFiltersGetter extends FluentBase {
      * await aui.click().text().withTextRegex('\b[Ss]\w+').exec();
      * ```
      *
+     * @param {string} [text] - A text to be matched.
+     *
      * @return {FluentFiltersOrRelationsGetter}
      */
     text(text?: string): FluentFiltersOrRelationsGetter;
@@ -1961,9 +2048,9 @@ export declare class FluentFiltersGetter extends FluentBase {
      */
     icon(): FluentFiltersOrRelationsGetter;
     /**
-     * Filters for a 'custom element', that is a UI element which is defined by providing an image and other parameters such as degree of rotation. It allows filtering for a UI element based on an image instead of using text or element descriptions like `button().withText('Submit')` in `await aui.click().button().withText('Submit').exec()`.
+     * Filters for a 'custom element', that is a UI element that is defined by providing an image and other parameters such as degree of rotation. It allows filtering for a UI element based on an image instead of using text or element descriptions like `button().withText('Submit')` in `await aui.click().button().withText('Submit').exec()`.
      *
-     * See the tutorial - [Custom Element](https://docs.askui.com/docs/general/Tutorials/custom-element) for more detail.
+     * See the tutorial - [Custom Element](https://docs.askui.com/docs/general/Element%20Selection/custom-elements) for more details.
      *
      * **Example**
      * ```typescript
@@ -1994,7 +2081,7 @@ export declare class FluentFiltersGetter extends FluentBase {
      * - **rotationDegreePerStep** (*`number`, optional*):
      *     - Step size in rotation degree. Rotates the custom image by this step size until 360° is exceeded. The range is from `0` to `360`. Defaults to `0`.
      * - **imageCompareFormat** (*`'RGB' | 'grayscale' | 'edges'`, optional*):
-     *     - The color compare style. 'edges' compares only edges, 'greyscale' compares the brightness of each pixel whereas 'RGB' compares all three colors (red, green, blue). Defaults to 'grayscale'.
+     *     - The color compare style. `'edges'` compares only edges, `'greyscale'` compares the brightness of each pixel whereas `'RGB'` compares all three colors (red, green, blue). Defaults to `'grayscale'`.
      *
      *
      * @param {CustomElementJson} customElement - The custom element to filter for.
@@ -2003,7 +2090,13 @@ export declare class FluentFiltersGetter extends FluentBase {
      */
     customElement(customElement: CustomElementJson): FluentFiltersOrRelationsGetter;
     /**
-     * Detects an AI Element created with the workflow creator.
+     * Detects an AI Element created with the [snipping workflow](https://docs.askui.com/docs/general/Components/aielement#snipping-workflow).
+     *
+     * **Examples:**
+     *
+     * ```typescript
+     * await aui.click().aiElement('askui-logo').exec();
+     * ```
      *
      * @param {string} aiElementName - Name of the AI Element.
      *
@@ -2074,12 +2167,13 @@ export declare class FluentFiltersGetter extends FluentBase {
      * 'other' === withText('text') => false
      *
      * // optional parameter: similarity_score
-     * '978-0-201-00650-6' == withText('978-0-201-00') => true with 82.76 similarity
-     * '978-0-201-00650-6' == withText('978-0-201-00650', 90) => true with 93.75 < 90 similarity
+     * '978-0-201-00650-6' == withText("978-0-201-00", 90) => false with 82.76 < 90 similarity
+     * '978-0-201-00650-6' == withText("978-0-201-00650", 90) => true with 93.75 > 90 similarity
      * ```
      * ![](https://docs.askui.com/img/gif/withText.gif)
      *
      * @param {string} text - A text to be matched.
+     * @param {number} [similarityScore=70] - Similarity score minimum value, it should be between `0` and `100`.
      *
      * @return {FluentFiltersOrRelationsGetter}
      */
@@ -2161,7 +2255,7 @@ export declare class FluentFiltersGetter extends FluentBase {
      * E.g., `puzzle piece` can fail while `an icon showing a puzzle piece` might work.
      * Generally, the more detail the better.
      *
-     * We also recommend to not restrict the type of element by using the generalselector `element()` as shown in the examples below.
+     * We also recommend to not restrict the type of element by using the general selector `element()` as shown in the examples below.
      *
      * **Examples:**
      * ```typescript
@@ -2315,7 +2409,12 @@ export declare class FluentFiltersOrRelationsGetter extends FluentFiltersGetter
     /**
      * Filters for an element right of another element.
      *
-     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     * Takes an optional parameter `index` to select the nth element (defaults to `0`).
+     *
+     * Takes an optional parameter `intersection_area` to specify which elements right of the other element are filtered for based on their vertical position (y-coordinates of bounding box):
+     * - `"element_center_line"` - considered right of the other element if element's bounding box intersects with a horizontal line passing through the center of the other element
+     * - `"element_edge_area"` - considered right of the other element if element's bounding box intersects with an area between the top and the bottom edge of the other element
+     * - `"display_edge_area"` - considered right of the other element no matter where it is placed vertically on the screen (y-axis)
      *
      * **Examples:**
      * ```typescript
@@ -2333,13 +2432,21 @@ export declare class FluentFiltersOrRelationsGetter extends FluentFiltersGetter
      * ```
      * ![](https://docs.askui.com/img/gif/rightOf.gif)
      *
+     * @param {number} [index=0] - Index of element to filter for going into the direction specified. Defaults to `0` which is the first element (zero-indexed) found in that direction.
+     * @param {INTERSECTION_AREA} [intersection_area="element_edge_area"] - Intersecting with either `"element_center_line"`, `"element_edge_area"` or `"display_edge_area"`. Defaults to `"element_edge_area"`.
+     *
      * @return {FluentFiltersGetter}
      */
-    rightOf(optionalIndex?: number, intersecting?: INTERSECTING_OPTION): FluentFiltersGetter;
+    rightOf(index?: number, intersection_area?: INTERSECTION_AREA): FluentFiltersGetter;
     /**
      * Filters for an element left of another element.
      *
-     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     * Takes an optional parameter `index` to select the nth element (defaults to `0`).
+     *
+     * Takes an optional parameter `intersection_area` to specify which elements left of the other element are filtered for based on their vertical position (y-coordinates of bounding box):
+     * - `"element_center_line"` - considered left of the other element if element's bounding box intersects with a horizontal line passing through the center of the other element
+     * - `"element_edge_area"` - considered left of the other element if element's bounding box intersects with an area between the top and the bottom edge of the other element
+     * - `"display_edge_area"` - considered left of the other element no matter where it is placed vertically on the screen (y-axis)
      *
      * **Examples:**
      * ```typescript
@@ -2357,13 +2464,21 @@ export declare class FluentFiltersOrRelationsGetter extends FluentFiltersGetter
      * ```
      * ![](https://docs.askui.com/img/gif/leftOf.gif)
      *
+     * @param {number} [index=0] - Index of element to filter for going into the direction specified. Defaults to `0` which is the first element (zero-indexed) found in that direction.
+     * @param {INTERSECTION_AREA} [intersection_area="element_edge_area"] - Intersecting with either `"element_center_line"`, `"element_edge_area"` or `"display_edge_area"`. Defaults to `"element_edge_area"`.
+     *
      * @return {FluentFiltersGetter}
      */
-    leftOf(optionalIndex?: number, intersecting?: INTERSECTING_OPTION): FluentFiltersGetter;
+    leftOf(index?: number, intersection_area?: INTERSECTION_AREA): FluentFiltersGetter;
     /**
      * Filters for an element below another element.
      *
-     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     * Takes an optional parameter `index` to select the nth element (defaults to `0`).
+     *
+     * Takes an optional parameter `intersection_area` to specify which elements below of the other element are filtered for based on their horizontal position (y-coordinates of bounding box):
+     * - `"element_center_line"` - considered below of the other element if element's bounding box intersects with a vertical line passing through the center of the other element
+     * - `"element_edge_area"` - considered below of the other element if element's bounding box intersects with an area between the left and the right edge of the other element
+     * - `"display_edge_area"` - considered below of the other element no matter where it is placed horizontally on the screen (y-axis)
      *
      * **Examples:**
      * ```typescript
@@ -2387,13 +2502,21 @@ export declare class FluentFiltersOrRelationsGetter extends FluentFiltersGetter
      * ```
      * ![](https://docs.askui.com/img/gif/below.gif)
      *
+     * @param {number} [index=0] - Index of element to filter for going into the direction specified. Defaults to `0` which is the first element (zero-indexed) found in that direction.
+     * @param {INTERSECTION_AREA} [intersection_area="element_edge_area"] - Intersecting with either `"element_center_line"`, `"element_edge_area"` or `"display_edge_area"`. Defaults to `"element_edge_area"`.
+     *
      * @return {FluentFiltersGetter}
      */
-    below(optionalIndex?: number, intersecting?: INTERSECTING_OPTION): FluentFiltersGetter;
+    below(index?: number, intersection_area?: INTERSECTION_AREA): FluentFiltersGetter;
     /**
      * Filters for an element above another element.
      *
-     * Takes an optional parameter `index` to select the `nth` element (starting with 0)
+     * Takes an optional parameter `index` to select the nth element (defaults to `0`).
+     *
+     * Takes an optional parameter `intersection_area` to specify which elements above of the other element are filtered for based on their horizontal position (y-coordinates of bounding box):
+     * - `"element_center_line"` - considered above of the other element if element's bounding box intersects with a vertical line passing through the center of the other element
+     * - `"element_edge_area"` - considered above of the other element if element's bounding box intersects with an area between the left and the right edge of the other element
+     * - `"display_edge_area"` - considered above of the other element no matter where it is placed horizontally on the screen (y-axis)
      *
      * **Examples:**
      * ```typescript
@@ -2417,9 +2540,12 @@ export declare class FluentFiltersOrRelationsGetter extends FluentFiltersGetter
      * ```
      * ![](https://docs.askui.com/img/gif/above.gif)
      *
+     * @param {number} [index=0] - Index of element to filter for going into the direction specified. Defaults to `0` which is the first element (zero-indexed) found in that direction.
+     * @param {INTERSECTION_AREA} [intersection_area="element_edge_area"] - Intersecting with either `"element_center_line"`, `"element_edge_area"` or `"display_edge_area"`. Defaults to `"element_edge_area"`.
+     *
      * @return {FluentFiltersGetter}
      */
-    above(optionalIndex?: number, intersecting?: INTERSECTING_OPTION): FluentFiltersGetter;
+    above(index?: number, intersection_area?: INTERSECTION_AREA): FluentFiltersGetter;
     /**
      * Filters for an element nearest to another element.
      *
@@ -2507,6 +2633,7 @@ export declare abstract class Getter extends FluentCommand {
      * ]
      * ```
      *
+     * ```typescript
      * // *************************************************** //
      * // Examples on how to work with the returned elements  //
      * // *************************************************** //
@@ -2585,6 +2712,7 @@ export declare abstract class Getter extends FluentCommand {
      *         xmax: 1178.8204241071428,
      *         ymax: 180.83512834821428
      *      },
+     *   },
      *   DetectedElement {
      *      name: 'ICON',
      *      text: 'search',
@@ -2594,8 +2722,8 @@ export declare abstract class Getter extends FluentCommand {
      *         xmax: 450.6304241071428,
      *         ymax: 950.47812834821428
      *      },
-     *      ... 381 more items
-     *    }
+     *    },
+     *   ... 381 more items
      *  ]
      * ```
      *