trait FilteringParams extends Params
- Grouped
- Alphabetic
- By Inheritance
- FilteringParams
- Params
- Serializable
- Serializable
- Identifiable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
$[T](param: Param[T]): T
- Attributes
- protected
- Definition Classes
- Params
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
val
blackList: StringArrayParam
If defined, list of entities to ignore.
If defined, list of entities to ignore. The rest will be processed
-
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
-
final
def
clear(param: Param[_]): FilteringParams.this
- Definition Classes
- Params
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
copyValues[T <: Params](to: T, extra: ParamMap): T
- Attributes
- protected
- Definition Classes
- Params
-
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
-
final
def
defaultCopy[T <: Params](extra: ParamMap): T
- Attributes
- protected
- Definition Classes
- Params
-
val
entitiesConfidence: MapFeature[String, Float]
Pairs (entity,confidenceThreshold).
Pairs (entity,confidenceThreshold). Filter the chunks with entities which have confidence lower than the confidence threshold.
- lazy val entitiesConfidenceMap: Map[String, Float]
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
explainParam(param: Param[_]): String
- Definition Classes
- Params
-
def
explainParams(): String
- Definition Classes
- Params
-
final
def
extractParamMap(): ParamMap
- Definition Classes
- Params
-
final
def
extractParamMap(extra: ParamMap): ParamMap
- Definition Classes
- Params
-
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.
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
get[T](param: Param[T]): Option[T]
- Definition Classes
- Params
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
getDefault[T](param: Param[T]): Option[T]
- Definition Classes
- Params
-
final
def
getOrDefault[T](param: Param[T]): T
- Definition Classes
- Params
-
def
getParam(paramName: String): Param[Any]
- Definition Classes
- Params
-
final
def
hasDefault[T](param: Param[T]): Boolean
- Definition Classes
- Params
-
def
hasParam(paramName: String): Boolean
- Definition Classes
- Params
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isDefined(param: Param[_]): Boolean
- Definition Classes
- Params
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
isSet(param: Param[_]): Boolean
- Definition Classes
- Params
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
lazy val
params: Array[Param[_]]
- Definition Classes
- Params
-
val
regex: StringArrayParam
If defined, list of regex to process the chunks (Default:
Array()
) -
def
resolveFilter(chunkerAnnotations: Seq[Annotation]): Seq[Annotation]
- Attributes
- protected
-
def
resolveMergeFilter(a: Annotation, entityValue: String, falsePositivesArray: Array[(String, String, String)], replaceDictMap: Map[String, String] = Map.empty): Option[Annotation]
- Attributes
- protected
-
def
resolveWhiteListBlackListFilter(annotations: Seq[Annotation]): Seq[Annotation]
- Attributes
- protected
-
final
def
set(paramPair: ParamPair[_]): FilteringParams.this
- Attributes
- protected
- Definition Classes
- Params
-
final
def
set(param: String, value: Any): FilteringParams.this
- Attributes
- protected
- Definition Classes
- Params
-
final
def
set[T](param: Param[T], value: T): FilteringParams.this
- Definition Classes
- Params
- def setAllowList(list: String*): FilteringParams.this
- def setAllowList(list: Array[String]): FilteringParams.this
- def setBlackList(list: String*): FilteringParams.this
-
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.
-
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
-
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.
- 'isin' : Filter by the chunk.
- 'regex' : Filter by using a regex.
- You can use 'assertion' in com.johnsnowlabs.nlp.annotators.chunker.AssertionFilterer and 'assertion' option is default value for com.johnsnowlabs.nlp.annotators.chunker.AssertionFilterer
-
final
def
setDefault(paramPairs: ParamPair[_]*): FilteringParams.this
- Attributes
- protected
- Definition Classes
- Params
-
final
def
setDefault[T](param: Param[T], value: T): FilteringParams.this
- Attributes
- protected
- Definition Classes
- Params
- def setDenyList(list: String*): FilteringParams.this
- def setDenyList(list: Array[String]): FilteringParams.this
- def setEntitiesConfidence(value: Map[String, Float]): FilteringParams.this
-
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.
-
def
setRegex(list: String*): FilteringParams.this
Sets the list of regexes to process the chunks.
- def setWhiteList(list: String*): FilteringParams.this
-
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.
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- Identifiable → AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
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()
)