Package org.elasticsearch.client.ml.inference.preprocessing

Class NGram

java.lang.Object
org.elasticsearch.client.ml.inference.preprocessing.NGram
All Implemented Interfaces:
NamedXContentObject, PreProcessor, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject
public class NGram extends Object implements PreProcessor
PreProcessor for n-gram encoding a string

  • Nested Class Summary

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

    Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

    org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.elasticsearch.xcontent.ParseField
    CUSTOM
     
    static final org.elasticsearch.xcontent.ParseField
    FEATURE_PREFIX
     
    static final org.elasticsearch.xcontent.ParseField
    FIELD
     
    static final org.elasticsearch.xcontent.ParseField
    LENGTH
     
    static final String
    NAME
     
    static final org.elasticsearch.xcontent.ParseField
    NGRAMS
     
    static final org.elasticsearch.xcontent.ParseField
    START
     

    Fields inherited from interface org.elasticsearch.xcontent.ToXContent

    EMPTY_PARAMS

  • Method Summary

    Modifier and Type
    Method
    Description
    static NGram.Builder
    builder(String field)
     
    boolean
    equals(Object o)
     
    static NGram
    fromXContent(org.elasticsearch.xcontent.XContentParser parser)
     
    Boolean
    getCustom()
     
    String
    getFeaturePrefix()
     
    String
    getField()
     
    Integer
    getLength()
     
    String
    getName()
     
    List<Integer>
    getnGrams()
     
    Integer
    getStart()
     
    int
    hashCode()
     
    List<String>
    outputFields()
     
    org.elasticsearch.xcontent.XContentBuilder
    toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

    isFragment

  • Field Details

    • NAME

      public static final String NAME
      See Also:

    • FIELD

      public static final org.elasticsearch.xcontent.ParseField FIELD

    • FEATURE_PREFIX

      public static final org.elasticsearch.xcontent.ParseField FEATURE_PREFIX

    • NGRAMS

      public static final org.elasticsearch.xcontent.ParseField NGRAMS

    • START

      public static final org.elasticsearch.xcontent.ParseField START

    • LENGTH

      public static final org.elasticsearch.xcontent.ParseField LENGTH

    • CUSTOM

      public static final org.elasticsearch.xcontent.ParseField CUSTOM

  • Method Details

    • fromXContent

      public static NGram fromXContent(org.elasticsearch.xcontent.XContentParser parser)

    • getName

      public String getName()
      Specified by:
      getName in interface NamedXContentObject
      Specified by:
      getName in interface PreProcessor
      Returns:
      The name of the pre-processor

    • toXContent

      public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.elasticsearch.xcontent.ToXContent
      Throws:
      IOException

    • getField

      public String getField()

    • getFeaturePrefix

      public String getFeaturePrefix()

    • getnGrams

      public List<Integer> getnGrams()

    • getStart

      public Integer getStart()

    • getLength

      public Integer getLength()

    • getCustom

      public Boolean getCustom()

    • outputFields

      public List<String> outputFields()

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • builder

      public static NGram.Builder builder(String field)