Packages

trait FilteringParams extends Params

Self Type
FilteringParams with HasFeatures
Linear Supertypes
Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. FilteringParams
  2. Params
  3. Serializable
  4. Serializable
  5. Identifiable
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def copy(extra: ParamMap): Params
    Definition Classes
    Params
  2. abstract val uid: String
    Definition Classes
    Identifiable

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def $[T](param: Param[T]): T
    Attributes
    protected
    Definition Classes
    Params
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. val blackList: StringArrayParam

    If defined, list of entities to ignore.

    If defined, list of entities to ignore. The rest will be processed

  7. val caseSensitive: BooleanParam

    Determines whether the definitions of the white listed and black listed entities are case sensitive or not.

    Determines whether the definitions of the white listed and black listed entities are case sensitive or not. If the filterValue is 'entity', 'caseSensitive' is always false. The default value is true, except: com.johnsnowlabs.nlp.annotators.chunker.AssertionFilterer

  8. final def clear(param: Param[_]): FilteringParams.this
    Definition Classes
    Params
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  10. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  11. val criteria: Param[String]

    It is used to how to compare black and white listed values with the result of the Annotation.

    It is used to how to compare black and white listed values with the result of the Annotation. Possible values are the following: 'isin', 'regex'. Default: isin

    • isin : Filter by the chunk
    • regex : Filter by using a regex
  12. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  13. val entitiesConfidence: MapFeature[String, Float]

    Pairs (entity,confidenceThreshold).

    Pairs (entity,confidenceThreshold). Filter the chunks with entities which have confidence lower than the confidence threshold.

  14. lazy val entitiesConfidenceMap: Map[String, Float]
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  17. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  18. def explainParams(): String
    Definition Classes
    Params
  19. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  20. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  21. val filterValue: Param[String]

    Possible values are 'result' and 'entity'.

    Possible values are 'result' and 'entity'. If the value is 'entity', it filters the ner chunks by the ner label that you want to filter. If the value is 'result', it will filter chunks by the result of the Annotation.

  22. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  23. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  24. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  25. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  26. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  27. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  28. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  29. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  30. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  31. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  32. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  33. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  34. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  35. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  36. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  37. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  38. val regex: StringArrayParam

    If defined, list of regex to process the chunks (Default: Array())

  39. def resolveFilter(chunkerAnnotations: Seq[Annotation]): Seq[Annotation]
    Attributes
    protected
  40. def resolveMergeFilter(a: Annotation, entityValue: String, falsePositivesArray: Array[(String, String, String)], replaceDictMap: Map[String, String] = Map.empty): Option[Annotation]
    Attributes
    protected
  41. def resolveWhiteListBlackListFilter(annotations: Seq[Annotation]): Seq[Annotation]
    Attributes
    protected
  42. final def set(paramPair: ParamPair[_]): FilteringParams.this
    Attributes
    protected
    Definition Classes
    Params
  43. final def set(param: String, value: Any): FilteringParams.this
    Attributes
    protected
    Definition Classes
    Params
  44. final def set[T](param: Param[T], value: T): FilteringParams.this
    Definition Classes
    Params
  45. def setAllowList(list: String*): FilteringParams.this
  46. def setAllowList(list: Array[String]): FilteringParams.this
  47. def setBlackList(list: String*): FilteringParams.this
  48. def setBlackList(list: Array[String]): FilteringParams.this

    If defined, list of entities to ignore.

    If defined, list of entities to ignore. The rest will be processed.

  49. def setCaseSensitive(value: Boolean): FilteringParams.this

    Determines whether the definitions of the white listed and black listed entities are case sensitive or not.

    Determines whether the definitions of the white listed and black listed entities are case sensitive or not. If the filterValue is 'entity', 'caseSensitive' is always False. The default value is true, except: com.johnsnowlabs.nlp.annotators.chunker.AssertionFilterer

  50. def setCriteria(s: String): FilteringParams.this

    Sets criteria for how to compare black and white listed values with the result of the Annotation.

    Sets criteria for how to compare black and white listed values with the result of the Annotation. Possible values are the following: 'isin', 'regex'. Default: isin.

  51. final def setDefault(paramPairs: ParamPair[_]*): FilteringParams.this
    Attributes
    protected
    Definition Classes
    Params
  52. final def setDefault[T](param: Param[T], value: T): FilteringParams.this
    Attributes
    protected
    Definition Classes
    Params
  53. def setDenyList(list: String*): FilteringParams.this
  54. def setDenyList(list: Array[String]): FilteringParams.this
  55. def setEntitiesConfidence(value: Map[String, Float]): FilteringParams.this
  56. def setFilterEntity(v: String): FilteringParams.this

    Possible values are 'result' and 'entity'.

    Possible values are 'result' and 'entity'. If the value is 'entity', it filters the ner chunks by the ner label that you want to filter. If the value is 'result', it will filter chunks by the result of the Annotation.

  57. def setRegex(list: String*): FilteringParams.this

    Sets the list of regexes to process the chunks.

  58. def setWhiteList(list: String*): FilteringParams.this
  59. def setWhiteList(list: Array[String]): FilteringParams.this

    Sets the list of entities to process.

    Sets the list of entities to process. The rest will be ignored. Do not include IOB prefix on labels.

  60. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  61. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  62. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  63. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  64. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  65. val whiteList: StringArrayParam

    If defined, list of entities to process.

    If defined, list of entities to process. The rest will be ignored. Does not include IOB prefix on labels (Default: Array())

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

param

setParam

Ungrouped