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

Inherits:
Object
  • Object
show all
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 collapse

Instance Attribute Details

#namespace ⇒ ::String

Returns The namespace of this restriction. e.g.: cost.

Returns:

  • (::String) —

    The namespace of this restriction. e.g.: cost.



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'proto_docs/google/cloud/aiplatform/v1/index.rb', line 216

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

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

Returns:



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'proto_docs/google/cloud/aiplatform/v1/index.rb', line 216

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

Returns Represents 64 bit float.

Note: The following fields are mutually exclusive: value_double, value_int, value_float. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Float) —

    Represents 64 bit float.

    Note: The following fields are mutually exclusive: value_double, value_int, value_float. If a field in that set is populated, all other fields in the set will automatically be cleared.



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'proto_docs/google/cloud/aiplatform/v1/index.rb', line 216

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

Returns Represents 32 bit float.

Note: The following fields are mutually exclusive: value_float, value_int, value_double. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Float) —

    Represents 32 bit float.

    Note: The following fields are mutually exclusive: value_float, value_int, value_double. If a field in that set is populated, all other fields in the set will automatically be cleared.



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'proto_docs/google/cloud/aiplatform/v1/index.rb', line 216

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

Returns Represents 64 bit integer.

Note: The following fields are mutually exclusive: value_int, value_float, value_double. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Integer) —

    Represents 64 bit integer.

    Note: The following fields are mutually exclusive: value_int, value_float, value_double. If a field in that set is populated, all other fields in the set will automatically be cleared.



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'proto_docs/google/cloud/aiplatform/v1/index.rb', line 216

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