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.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public class NGram
extends java.lang.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.common.xcontent.ToXContent

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

  • Field Summary

    Fields
    Modifier and Type Field Description
    static org.elasticsearch.common.ParseField CUSTOM  
    static org.elasticsearch.common.ParseField FEATURE_PREFIX  
    static org.elasticsearch.common.ParseField FIELD  
    static org.elasticsearch.common.ParseField LENGTH  
    static java.lang.String NAME  
    static org.elasticsearch.common.ParseField NGRAMS  
    static org.elasticsearch.common.ParseField START  

    Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

    EMPTY_PARAMS

  • Method Summary

    Modifier and Type Method Description
    static NGram.Builder builder​(java.lang.String field)  
    boolean equals​(java.lang.Object o)  
    static NGram fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser)  
    java.lang.Boolean getCustom()  
    java.lang.String getFeaturePrefix()  
    java.lang.String getField()  
    java.lang.Integer getLength()  
    java.lang.String getName()  
    java.util.List<java.lang.Integer> getnGrams()  
    java.lang.Integer getStart()  
    int hashCode()  
    java.util.List<java.lang.String> outputFields()  
    org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.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.common.xcontent.ToXContentObject

    isFragment

  • Field Details

    • NAME

      public static final java.lang.String NAME
      See Also:
      Constant Field Values

    • FIELD

      public static final org.elasticsearch.common.ParseField FIELD

    • FEATURE_PREFIX

      public static final org.elasticsearch.common.ParseField FEATURE_PREFIX

    • NGRAMS

      public static final org.elasticsearch.common.ParseField NGRAMS

    • START

      public static final org.elasticsearch.common.ParseField START

    • LENGTH

      public static final org.elasticsearch.common.ParseField LENGTH

    • CUSTOM

      public static final org.elasticsearch.common.ParseField CUSTOM

  • Method Details

    • fromXContent

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

    • getName

      public java.lang.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.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      java.io.IOException

    • getField

      public java.lang.String getField()

    • getFeaturePrefix

      public java.lang.String getFeaturePrefix()

    • getnGrams

      public java.util.List<java.lang.Integer> getnGrams()

    • getStart

      public java.lang.Integer getStart()

    • getLength

      public java.lang.Integer getLength()

    • getCustom

      public java.lang.Boolean getCustom()

    • outputFields

      public java.util.List<java.lang.String> outputFields()

    • equals

      public boolean equals​(java.lang.Object o)
      Overrides:
      equals in class java.lang.Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • builder

      public static NGram.Builder builder​(java.lang.String field)