Class: Google::Cloud::AIPlatform::V1::IndexDatapoint::NumericRestriction

Inherits:

Object

• Object
• Google::Cloud::AIPlatform::V1::IndexDatapoint::NumericRestriction

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/aiplatform/v1/index.rb

Overview

This field allows restricts to be based on numeric comparisons rather than categorical tokens.

Defined Under Namespace

Modules: Operator

Instance Attribute Summary

• #namespace ⇒ ::String

  The namespace of this restriction.

• #op ⇒ ::Google::Cloud::AIPlatform::V1::IndexDatapoint::NumericRestriction::Operator

  This MUST be specified for queries and must NOT be specified for datapoints.

• #value_double ⇒ ::Float

  Represents 64 bit float.

• #value_float ⇒ ::Float

  Represents 32 bit float.

• #value_int ⇒ ::Integer

  Represents 64 bit integer.

Instance Attribute Details

#namespace ⇒ ::String

# File 'proto_docs/google/cloud/aiplatform/v1/index.rb', line 213

class NumericRestriction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Which comparison operator to use.  Should be specified for queries only;
  # specifying this for a datapoint is an error.
  #
  # Datapoints for which Operator is true relative to the query's Value
  # field will be allowlisted.
  module Operator
    # Default value of the enum.
    OPERATOR_UNSPECIFIED = 0

    # Datapoints are eligible iff their value is < the query's.
    LESS = 1

    # Datapoints are eligible iff their value is <= the query's.
    LESS_EQUAL = 2

    # Datapoints are eligible iff their value is == the query's.
    EQUAL = 3

    # Datapoints are eligible iff their value is >= the query's.
    GREATER_EQUAL = 4

    # Datapoints are eligible iff their value is > the query's.
    GREATER = 5

    # Datapoints are eligible iff their value is != the query's.
    NOT_EQUAL = 6
  end
end

#op ⇒ ::Google::Cloud::AIPlatform::V1::IndexDatapoint::NumericRestriction::Operator

# File 'proto_docs/google/cloud/aiplatform/v1/index.rb', line 213

class NumericRestriction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Which comparison operator to use.  Should be specified for queries only;
  # specifying this for a datapoint is an error.
  #
  # Datapoints for which Operator is true relative to the query's Value
  # field will be allowlisted.
  module Operator
    # Default value of the enum.
    OPERATOR_UNSPECIFIED = 0

    # Datapoints are eligible iff their value is < the query's.
    LESS = 1

    # Datapoints are eligible iff their value is <= the query's.
    LESS_EQUAL = 2

    # Datapoints are eligible iff their value is == the query's.
    EQUAL = 3

    # Datapoints are eligible iff their value is >= the query's.
    GREATER_EQUAL = 4

    # Datapoints are eligible iff their value is > the query's.
    GREATER = 5

    # Datapoints are eligible iff their value is != the query's.
    NOT_EQUAL = 6
  end
end

#value_double ⇒ ::Float

# File 'proto_docs/google/cloud/aiplatform/v1/index.rb', line 213

class NumericRestriction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Which comparison operator to use.  Should be specified for queries only;
  # specifying this for a datapoint is an error.
  #
  # Datapoints for which Operator is true relative to the query's Value
  # field will be allowlisted.
  module Operator
    # Default value of the enum.
    OPERATOR_UNSPECIFIED = 0

    # Datapoints are eligible iff their value is < the query's.
    LESS = 1

    # Datapoints are eligible iff their value is <= the query's.
    LESS_EQUAL = 2

    # Datapoints are eligible iff their value is == the query's.
    EQUAL = 3

    # Datapoints are eligible iff their value is >= the query's.
    GREATER_EQUAL = 4

    # Datapoints are eligible iff their value is > the query's.
    GREATER = 5

    # Datapoints are eligible iff their value is != the query's.
    NOT_EQUAL = 6
  end
end

#value_float ⇒ ::Float

# File 'proto_docs/google/cloud/aiplatform/v1/index.rb', line 213

class NumericRestriction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Which comparison operator to use.  Should be specified for queries only;
  # specifying this for a datapoint is an error.
  #
  # Datapoints for which Operator is true relative to the query's Value
  # field will be allowlisted.
  module Operator
    # Default value of the enum.
    OPERATOR_UNSPECIFIED = 0

    # Datapoints are eligible iff their value is < the query's.
    LESS = 1

    # Datapoints are eligible iff their value is <= the query's.
    LESS_EQUAL = 2

    # Datapoints are eligible iff their value is == the query's.
    EQUAL = 3

    # Datapoints are eligible iff their value is >= the query's.
    GREATER_EQUAL = 4

    # Datapoints are eligible iff their value is > the query's.
    GREATER = 5

    # Datapoints are eligible iff their value is != the query's.
    NOT_EQUAL = 6
  end
end

#value_int ⇒ ::Integer

# File 'proto_docs/google/cloud/aiplatform/v1/index.rb', line 213

class NumericRestriction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Which comparison operator to use.  Should be specified for queries only;
  # specifying this for a datapoint is an error.
  #
  # Datapoints for which Operator is true relative to the query's Value
  # field will be allowlisted.
  module Operator
    # Default value of the enum.
    OPERATOR_UNSPECIFIED = 0

    # Datapoints are eligible iff their value is < the query's.
    LESS = 1

    # Datapoints are eligible iff their value is <= the query's.
    LESS_EQUAL = 2

    # Datapoints are eligible iff their value is == the query's.
    EQUAL = 3

    # Datapoints are eligible iff their value is >= the query's.
    GREATER_EQUAL = 4

    # Datapoints are eligible iff their value is > the query's.
    GREATER = 5

    # Datapoints are eligible iff their value is != the query's.
    NOT_EQUAL = 6
  end
end