Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NaturalLanguageResult

Array of Natural Language Understanding results

Hierarchy

Indexable

Array of Natural Language Understanding results

Index

Properties

Static Array

Array: ArrayConstructor

Static length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Methods

add

indexIncludes

  • Helper to see if a result has the properties of a matching element. Check for matching subset (id/name) ignoring score unless only score given.

    Parameters

    • index: number

      Array index in NLU result set

    • criteria: INaturalLanguageCriteria

      NLU criteria or result subset to match on (ignores score)

    Returns undefined | INaturalLanguageResult

match

  • Match NLU results by optional operator. Default uses score as threshold, matching if greater than or equal to (gte) comparison score. If no score given, it matches if the result has (includes) the given id and/or name. When comparing score, the array is first filtered against other criteria.

    Parameters

    Returns undefined | INaturalLanguageResult[]

sortByScore

  • sortByScore(): void
  • Sort results by their score (DESC). Results that don't have a score will come before those that do (assuming that no score relates full confidence). Order remains unchanged for whole sequences of results without score.

    Returns void

Static __@iterator

  • Iterator

    Returns IterableIterator<INaturalLanguageResult>

Static __@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

    • copyWithin: boolean
    • entries: boolean
    • fill: boolean
    • find: boolean
    • findIndex: boolean
    • keys: boolean
    • values: boolean

Static concat

  • Combines two or more arrays.

    Parameters

    Returns INaturalLanguageResult[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns INaturalLanguageResult[]

Static copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

Static entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, INaturalLanguageResult]>

Static every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

Static fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: INaturalLanguageResult

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

Static filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): INaturalLanguageResult[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns INaturalLanguageResult[]

Static find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): INaturalLanguageResult | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns INaturalLanguageResult | undefined

Static findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

Static forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

Static includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: INaturalLanguageResult

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

Static indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: INaturalLanguageResult

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

Static join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

Static keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

Static lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: INaturalLanguageResult

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

Static map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

Static pop

  • Removes the last element from an array and returns it.

    Returns INaturalLanguageResult | undefined

Static push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

Static reduce

Static reduceRight

Static reverse

  • Reverses the elements in an Array.

    Returns INaturalLanguageResult[]

Static shift

  • Removes the first element from an array and returns it.

    Returns INaturalLanguageResult | undefined

Static slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns INaturalLanguageResult[]

Static some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

Static sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

Static splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns INaturalLanguageResult[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: INaturalLanguageResult[]

      Elements to insert into the array in place of the deleted elements.

    Returns INaturalLanguageResult[]

Static toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using thier toLocalString methods.

    Returns string

Static toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

Static unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

Static values

  • Returns an iterable of values in the array

    Returns IterableIterator<INaturalLanguageResult>

Generated using TypeDoc