Package org.opensearch.protobufs

Interface KnnQueryOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
KnnQuery, KnnQuery.Builder
public interface KnnQueryOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    float
    getBoost()
    optional float boost = 7 [json_name = "boost"];
    boolean
    getExpandNestedDocs()
    optional bool expand_nested_docs = 11 [json_name = "expandNestedDocs"];
    String
    getField()
    string field = 1 [json_name = "field"];
    com.google.protobuf.ByteString
    getFieldBytes()
    string field = 1 [json_name = "field"];
    QueryContainer
    getFilter()
    optional .org.opensearch.protobufs.QueryContainer filter = 6 [json_name = "filter"];
    QueryContainerOrBuilder
    getFilterOrBuilder()
    optional .org.opensearch.protobufs.QueryContainer filter = 6 [json_name = "filter"];
    int
    getK()
    optional int32 k = 3 [json_name = "k"];
    float
    getMaxDistance()
    optional float max_distance = 5 [json_name = "maxDistance"];
    ObjectMap
    getMethodParameters()
    optional .org.opensearch.protobufs.ObjectMap method_parameters = 9 [json_name = "methodParameters"];
    ObjectMapOrBuilder
    getMethodParametersOrBuilder()
    optional .org.opensearch.protobufs.ObjectMap method_parameters = 9 [json_name = "methodParameters"];
    float
    getMinScore()
    optional float min_score = 4 [json_name = "minScore"];
    KnnQueryRescore
    getRescore()
    optional .org.opensearch.protobufs.KnnQueryRescore rescore = 10 [json_name = "rescore"];
    KnnQueryRescoreOrBuilder
    getRescoreOrBuilder()
    optional .org.opensearch.protobufs.KnnQueryRescore rescore = 10 [json_name = "rescore"];
    float
    getVector(int index)
    repeated float vector = 2 [json_name = "vector"];
    int
    getVectorCount()
    repeated float vector = 2 [json_name = "vector"];
    List<Float>
    getVectorList()
    repeated float vector = 2 [json_name = "vector"];
    String
    getXName()
    optional string x_name = 8 [json_name = "xName"];
    com.google.protobuf.ByteString
    getXNameBytes()
    optional string x_name = 8 [json_name = "xName"];
    boolean
    hasBoost()
    optional float boost = 7 [json_name = "boost"];
    boolean
    hasExpandNestedDocs()
    optional bool expand_nested_docs = 11 [json_name = "expandNestedDocs"];
    boolean
    hasFilter()
    optional .org.opensearch.protobufs.QueryContainer filter = 6 [json_name = "filter"];
    boolean
    hasK()
    optional int32 k = 3 [json_name = "k"];
    boolean
    hasMaxDistance()
    optional float max_distance = 5 [json_name = "maxDistance"];
    boolean
    hasMethodParameters()
    optional .org.opensearch.protobufs.ObjectMap method_parameters = 9 [json_name = "methodParameters"];
    boolean
    hasMinScore()
    optional float min_score = 4 [json_name = "minScore"];
    boolean
    hasRescore()
    optional .org.opensearch.protobufs.KnnQueryRescore rescore = 10 [json_name = "rescore"];
    boolean
    hasXName()
    optional string x_name = 8 [json_name = "xName"];

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getField

      String getField()
      string field = 1 [json_name = "field"];
      Returns:
      The field.

    • getFieldBytes

      com.google.protobuf.ByteString getFieldBytes()
      string field = 1 [json_name = "field"];
      Returns:
      The bytes for field.

    • getVectorList

      List<Float> getVectorList()
      repeated float vector = 2 [json_name = "vector"];
      Returns:
      A list containing the vector.

    • getVectorCount

      int getVectorCount()
      repeated float vector = 2 [json_name = "vector"];
      Returns:
      The count of vector.

    • getVector

      float getVector(int index)
      repeated float vector = 2 [json_name = "vector"];
      Parameters:
      index - The index of the element to return.
      Returns:
      The vector at the given index.

    • hasK

      boolean hasK()
      optional int32 k = 3 [json_name = "k"];
      Returns:
      Whether the k field is set.

    • getK

      int getK()
      optional int32 k = 3 [json_name = "k"];
      Returns:
      The k.

    • hasMinScore

      boolean hasMinScore()
      optional float min_score = 4 [json_name = "minScore"];
      Returns:
      Whether the minScore field is set.

    • getMinScore

      float getMinScore()
      optional float min_score = 4 [json_name = "minScore"];
      Returns:
      The minScore.

    • hasMaxDistance

      boolean hasMaxDistance()
      optional float max_distance = 5 [json_name = "maxDistance"];
      Returns:
      Whether the maxDistance field is set.

    • getMaxDistance

      float getMaxDistance()
      optional float max_distance = 5 [json_name = "maxDistance"];
      Returns:
      The maxDistance.

    • hasFilter

      boolean hasFilter()
      optional .org.opensearch.protobufs.QueryContainer filter = 6 [json_name = "filter"];
      Returns:
      Whether the filter field is set.

    • getFilter

      QueryContainer getFilter()
      optional .org.opensearch.protobufs.QueryContainer filter = 6 [json_name = "filter"];
      Returns:
      The filter.

    • getFilterOrBuilder

      QueryContainerOrBuilder getFilterOrBuilder()
      optional .org.opensearch.protobufs.QueryContainer filter = 6 [json_name = "filter"];

    • hasBoost

      boolean hasBoost()
      optional float boost = 7 [json_name = "boost"];
      Returns:
      Whether the boost field is set.

    • getBoost

      float getBoost()
      optional float boost = 7 [json_name = "boost"];
      Returns:
      The boost.

    • hasXName

      boolean hasXName()
      optional string x_name = 8 [json_name = "xName"];
      Returns:
      Whether the xName field is set.

    • getXName

      String getXName()
      optional string x_name = 8 [json_name = "xName"];
      Returns:
      The xName.

    • getXNameBytes

      com.google.protobuf.ByteString getXNameBytes()
      optional string x_name = 8 [json_name = "xName"];
      Returns:
      The bytes for xName.

    • hasMethodParameters

      boolean hasMethodParameters()
      optional .org.opensearch.protobufs.ObjectMap method_parameters = 9 [json_name = "methodParameters"];
      Returns:
      Whether the methodParameters field is set.

    • getMethodParameters

      ObjectMap getMethodParameters()
      optional .org.opensearch.protobufs.ObjectMap method_parameters = 9 [json_name = "methodParameters"];
      Returns:
      The methodParameters.

    • getMethodParametersOrBuilder

      ObjectMapOrBuilder getMethodParametersOrBuilder()
      optional .org.opensearch.protobufs.ObjectMap method_parameters = 9 [json_name = "methodParameters"];

    • hasRescore

      boolean hasRescore()
      optional .org.opensearch.protobufs.KnnQueryRescore rescore = 10 [json_name = "rescore"];
      Returns:
      Whether the rescore field is set.

    • getRescore

      KnnQueryRescore getRescore()
      optional .org.opensearch.protobufs.KnnQueryRescore rescore = 10 [json_name = "rescore"];
      Returns:
      The rescore.

    • getRescoreOrBuilder

      KnnQueryRescoreOrBuilder getRescoreOrBuilder()
      optional .org.opensearch.protobufs.KnnQueryRescore rescore = 10 [json_name = "rescore"];

    • hasExpandNestedDocs

      boolean hasExpandNestedDocs()
      optional bool expand_nested_docs = 11 [json_name = "expandNestedDocs"];
      Returns:
      Whether the expandNestedDocs field is set.

    • getExpandNestedDocs

      boolean getExpandNestedDocs()
      optional bool expand_nested_docs = 11 [json_name = "expandNestedDocs"];
      Returns:
      The expandNestedDocs.