Packages

case class ExternalResource(path: String, readAs: Format, options: Map[String, String]) extends WritableAnnotatorComponent with Product with Serializable

This represents an external source which contains information into how an external resource shall be read by Spark-NLP's Resource Helper.

  • ReadAs.TEXT will configure the file to be read locally as text
  • ReadAs.BINARY will configure the file to be read locally as binary
  • ReadAs.SPARK will configure the file to be read by Spark. "format" will need to be defined in options.

Example

ExternalResource(
  "src/test/resources/regex-matcher/rules.txt",
  ReadAs.TEXT,
  Map("delimiter" -> ",")
)

ExternalResource(
  "src/test/resources/regex-matcher/rules.txt",
  ReadAs.SPARK,
  Map("format" -> "text", "delimiter" -> ",")
)
path

Path to the resource

readAs

How to interpret the resource. Possible values are ReadAs.SPARK, ReadAs.TEXT, ReadAs.BINARY

options

Options for Spark. Option format needs to be set if readAs is set to ReadAs.SPARK

Linear Supertypes
Product, Equals, WritableAnnotatorComponent, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ExternalResource
  2. Product
  3. Equals
  4. WritableAnnotatorComponent
  5. Serializable
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ExternalResource(path: String, readAs: Format, options: Map[String, String])

    path

    Path to the resource

    readAs

    How to interpret the resource. Possible values are ReadAs.SPARK, ReadAs.TEXT, ReadAs.BINARY

    options

    Options for Spark. Option format needs to be set if readAs is set to ReadAs.SPARK

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  8. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  9. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  11. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  12. val options: Map[String, String]
  13. val path: String
  14. def productElementNames: Iterator[String]
    Definition Classes
    Product
  15. val readAs: Format
  16. def serialize: SerializedExternalResource
    Definition Classes
    ExternalResource → WritableAnnotatorComponent
  17. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Product

Inherited from Equals

Inherited from WritableAnnotatorComponent

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped