# Vision AI V1 API - Class Google::Cloud::VisionAI::V1::Criteria (v1.5.0)

1.5.0 (latest) 1.4.1 1.3.1 1.2.0 1.1.1 1.0.1 0.4.0 0.3.0 0.2.0 0.1.0 Reference documentation and code samples for the Vision AI V1 API class Google::Cloud::VisionAI::V1::Criteria.

Filter criteria applied to current search results.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #bool_value

    def bool_value() -> ::Google::Cloud::VisionAI::V1::BoolValue

**Returns**

- ([::Google::Cloud::VisionAI::V1::BoolValue](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision_ai-v1/latest/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.

### #bool_value=

    def bool_value=(value) -> ::Google::Cloud::VisionAI::V1::BoolValue

**Parameter**

- **value** ([::Google::Cloud::VisionAI::V1::BoolValue](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision_ai-v1/latest/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.
**Returns**

- ([::Google::Cloud::VisionAI::V1::BoolValue](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision_ai-v1/latest/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.

### #date_time_range_array

    def date_time_range_array() -> ::Google::Cloud::VisionAI::V1::DateTimeRangeArray

**Returns**

- ([::Google::Cloud::VisionAI::V1::DateTimeRangeArray](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision_ai-v1/latest/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.

### #date_time_range_array=

    def date_time_range_array=(value) -> ::Google::Cloud::VisionAI::V1::DateTimeRangeArray

**Parameter**

- **value** ([::Google::Cloud::VisionAI::V1::DateTimeRangeArray](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision_ai-v1/latest/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.
**Returns**

- ([::Google::Cloud::VisionAI::V1::DateTimeRangeArray](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision_ai-v1/latest/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.

### #fetch_matched_annotations

    def fetch_matched_annotations() -> ::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

### #fetch_matched_annotations=

    def fetch_matched_annotations=(value) -> ::Boolean

**Parameter**

- **value** (::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
**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

### #field

    def field() -> ::String

**Returns**

- (::String) --- The UGA field or ML field to apply filtering criteria.

### #field=

    def field=(value) -> ::String

**Parameter**

- **value** (::String) --- The UGA field or ML field to apply filtering criteria.
**Returns**

- (::String) --- The UGA field or ML field to apply filtering criteria.

### #float_range_array

    def float_range_array() -> ::Google::Cloud::VisionAI::V1::FloatRangeArray

**Returns**

- ([::Google::Cloud::VisionAI::V1::FloatRangeArray](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision_ai-v1/latest/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.

### #float_range_array=

    def float_range_array=(value) -> ::Google::Cloud::VisionAI::V1::FloatRangeArray

**Parameter**

- **value** ([::Google::Cloud::VisionAI::V1::FloatRangeArray](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision_ai-v1/latest/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.
**Returns**

- ([::Google::Cloud::VisionAI::V1::FloatRangeArray](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision_ai-v1/latest/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.

### #geo_location_array

    def geo_location_array() -> ::Google::Cloud::VisionAI::V1::GeoLocationArray

**Returns**

- ([::Google::Cloud::VisionAI::V1::GeoLocationArray](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision_ai-v1/latest/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.

### #geo_location_array=

    def geo_location_array=(value) -> ::Google::Cloud::VisionAI::V1::GeoLocationArray

**Parameter**

- **value** ([::Google::Cloud::VisionAI::V1::GeoLocationArray](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision_ai-v1/latest/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.
**Returns**

- ([::Google::Cloud::VisionAI::V1::GeoLocationArray](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision_ai-v1/latest/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.

### #int_range_array

    def int_range_array() -> ::Google::Cloud::VisionAI::V1::IntRangeArray

**Returns**

- ([::Google::Cloud::VisionAI::V1::IntRangeArray](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision_ai-v1/latest/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.

### #int_range_array=

    def int_range_array=(value) -> ::Google::Cloud::VisionAI::V1::IntRangeArray

**Parameter**

- **value** ([::Google::Cloud::VisionAI::V1::IntRangeArray](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision_ai-v1/latest/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.
**Returns**

- ([::Google::Cloud::VisionAI::V1::IntRangeArray](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision_ai-v1/latest/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.

### #text_array

    def text_array() -> ::Google::Cloud::VisionAI::V1::StringArray

**Returns**

- ([::Google::Cloud::VisionAI::V1::StringArray](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision_ai-v1/latest/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.

### #text_array=

    def text_array=(value) -> ::Google::Cloud::VisionAI::V1::StringArray

**Parameter**

- **value** ([::Google::Cloud::VisionAI::V1::StringArray](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision_ai-v1/latest/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.
**Returns**

- ([::Google::Cloud::VisionAI::V1::StringArray](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision_ai-v1/latest/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.