Class: Google::Cloud::VisionAI::V1::Criteria

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/visionai/v1/warehouse.rb

Overview

Filter criteria applied to current search results.

Instance Attribute Summary collapse

Instance Attribute Details

#bool_value ⇒ ::Google::Cloud::VisionAI::V1::BoolValue

Returns A Boolean value.

Note: The following fields are mutually exclusive: bool_value, text_array, int_range_array, float_range_array, date_time_range_array, geo_location_array. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::VisionAI::V1::BoolValue) —

    A Boolean value.

    Note: The following fields are mutually exclusive: bool_value, text_array, int_range_array, float_range_array, date_time_range_array, geo_location_array. If a field in that set is populated, all other fields in the set will automatically be cleared.



3034
3035
3036
3037
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 3034

class Criteria
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#date_time_range_array ⇒ ::Google::Cloud::VisionAI::V1::DateTimeRangeArray

Returns The datetime ranges associated with the field.

Note: The following fields are mutually exclusive: date_time_range_array, text_array, int_range_array, float_range_array, geo_location_array, bool_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::VisionAI::V1::DateTimeRangeArray) —

    The datetime ranges associated with the field.

    Note: The following fields are mutually exclusive: date_time_range_array, text_array, int_range_array, float_range_array, geo_location_array, bool_value. If a field in that set is populated, all other fields in the set will automatically be cleared.



3034
3035
3036
3037
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 3034

class Criteria
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#fetch_matched_annotations ⇒ ::Boolean

Returns If true, return query matched annotations for this criteria. This option is only applicable for inclusion criteria, i.e., not exclusion criteria, with partition level annotations. It supports the following data types:

  • INTEGER
  • FLOAT
  • STRING (DataSchema.SearchStrategy.EXACT_SEARCH only)
  • BOOLEAN.

Returns:

  • (::Boolean) —

    If true, return query matched annotations for this criteria. This option is only applicable for inclusion criteria, i.e., not exclusion criteria, with partition level annotations. It supports the following data types:

    • INTEGER
    • FLOAT
    • STRING (DataSchema.SearchStrategy.EXACT_SEARCH only)
    • BOOLEAN


3034
3035
3036
3037
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 3034

class Criteria
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#field ⇒ ::String

Returns The UGA field or ML field to apply filtering criteria.

Returns:

  • (::String) —

    The UGA field or ML field to apply filtering criteria.



3034
3035
3036
3037
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 3034

class Criteria
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#float_range_array ⇒ ::Google::Cloud::VisionAI::V1::FloatRangeArray

Returns The float ranges associated with the field.

Note: The following fields are mutually exclusive: float_range_array, text_array, int_range_array, date_time_range_array, geo_location_array, bool_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::VisionAI::V1::FloatRangeArray) —

    The float ranges associated with the field.

    Note: The following fields are mutually exclusive: float_range_array, text_array, int_range_array, date_time_range_array, geo_location_array, bool_value. If a field in that set is populated, all other fields in the set will automatically be cleared.



3034
3035
3036
3037
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 3034

class Criteria
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#geo_location_array ⇒ ::Google::Cloud::VisionAI::V1::GeoLocationArray

Returns Geo Location array.

Note: The following fields are mutually exclusive: geo_location_array, text_array, int_range_array, float_range_array, date_time_range_array, bool_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::VisionAI::V1::GeoLocationArray) —

    Geo Location array.

    Note: The following fields are mutually exclusive: geo_location_array, text_array, int_range_array, float_range_array, date_time_range_array, bool_value. If a field in that set is populated, all other fields in the set will automatically be cleared.



3034
3035
3036
3037
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 3034

class Criteria
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#int_range_array ⇒ ::Google::Cloud::VisionAI::V1::IntRangeArray

Returns The integer ranges associated with the field.

Note: The following fields are mutually exclusive: int_range_array, text_array, float_range_array, date_time_range_array, geo_location_array, bool_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::VisionAI::V1::IntRangeArray) —

    The integer ranges associated with the field.

    Note: The following fields are mutually exclusive: int_range_array, text_array, float_range_array, date_time_range_array, geo_location_array, bool_value. If a field in that set is populated, all other fields in the set will automatically be cleared.



3034
3035
3036
3037
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 3034

class Criteria
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#text_array ⇒ ::Google::Cloud::VisionAI::V1::StringArray

Returns The text values associated with the field.

Note: The following fields are mutually exclusive: text_array, int_range_array, float_range_array, date_time_range_array, geo_location_array, bool_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::VisionAI::V1::StringArray) —

    The text values associated with the field.

    Note: The following fields are mutually exclusive: text_array, int_range_array, float_range_array, date_time_range_array, geo_location_array, bool_value. If a field in that set is populated, all other fields in the set will automatically be cleared.



3034
3035
3036
3037
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 3034

class Criteria
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end