Package org.apache.beam.sdk.extensions.ml

Class AnnotateText

  • All Implemented Interfaces:
    java.io.Serializable, org.apache.beam.sdk.transforms.display.HasDisplayData
    public abstract class AnnotateText
extends org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PCollection<com.google.cloud.language.v1.Document>,​org.apache.beam.sdk.values.PCollection<com.google.cloud.language.v1.AnnotateTextResponse>>
    A PTransform using the Cloud AI Natural language processing capability. Takes an input PCollection of Documents and converts them to AnnotateTextResponses.

    It is possible to provide a language hint to the API. A AnnotateTextRequest.Features object is required to configure analysis types to be done on the data.

    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  AnnotateText.Builder  

    • Field Summary

      • Fields inherited from class org.apache.beam.sdk.transforms.PTransform

        annotations, displayData, name, resourceHints

    • Constructor Summary

      Constructors 
      Constructor Description
      AnnotateText()  

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      org.apache.beam.sdk.values.PCollection<com.google.cloud.language.v1.AnnotateTextResponse> expand​(org.apache.beam.sdk.values.PCollection<com.google.cloud.language.v1.Document> input)  
      abstract com.google.cloud.language.v1.AnnotateTextRequest.Features features()  
      abstract @Nullable java.lang.String languageHint()  
      static AnnotateText.Builder newBuilder()  

      • Methods inherited from class org.apache.beam.sdk.transforms.PTransform

        addAnnotation, compose, compose, getAdditionalInputs, getAnnotations, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, getResourceHints, populateDisplayData, setDisplayData, setResourceHints, toString, validate, validate

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • AnnotateText

        public AnnotateText()

    • Method Detail

      • languageHint

        public abstract @Nullable java.lang.String languageHint()

      • features

        public abstract com.google.cloud.language.v1.AnnotateTextRequest.Features features()

      • expand

        public org.apache.beam.sdk.values.PCollection<com.google.cloud.language.v1.AnnotateTextResponse> expand​(org.apache.beam.sdk.values.PCollection<com.google.cloud.language.v1.Document> input)
        Specified by:
        expand in class org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PCollection<com.google.cloud.language.v1.Document>,​org.apache.beam.sdk.values.PCollection<com.google.cloud.language.v1.AnnotateTextResponse>>