nlp_chunk_filterer: Spark NLP ChunkFilterer

View source: R/chunk_filterer.R

nlp_chunk_filtererR Documentation

Spark NLP ChunkFilterer

Description

Spark ML transformer that will filter out named entities by some conditions or predefined look-up lists, so that you can feed these entities to other annotators like Assertion Status or Entity Resolvers. It can be used with two criteria: isin and regex. See https://nlp.johnsnowlabs.com/docs/en/licensed_release_notes#2-chunkfilterer

Usage

nlp_chunk_filterer(
  x,
  input_cols,
  output_col,
  criteria = NULL,
  whitelist = NULL,
  regex = NULL,
  uid = random_string("chunk_filterer_")
)

Arguments

x

A spark_connection, ml_pipeline, or a tbl_spark.

input_cols

Input columns. String array.

output_col

Output column. String.

criteria

isin or regex

whitelist

If defined, list of entities to process.

regex

If defined, list of entities to process.

uid

A character string used to uniquely identify the ML estimator.

Value

The object returned depends on the class of x.

  • spark_connection: When x is a spark_connection, the function returns an instance of a ml_estimator object. The object contains a pointer to a Spark Estimator object and can be used to compose Pipeline objects.

  • ml_pipeline: When x is a ml_pipeline, the function returns a ml_pipeline with the NLP estimator appended to the pipeline.

  • tbl_spark: When x is a tbl_spark, an estimator is constructed then immediately fit with the input tbl_spark, returning an NLP model.


r-spark/sparknlp documentation built on Oct. 15, 2022, 10:50 a.m.