Reference documentation and code samples for the Google Cloud Vision Ai V1 Client class Criteria.
Filter criteria applied to current search results.
Generated from protobuf message google.cloud.visionai.v1.Criteria
Namespace
Google \ Cloud \ VisionAI \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ text_array |
StringArray
The text values associated with the field. |
↳ int_range_array |
IntRangeArray
The integer ranges associated with the field. |
↳ float_range_array |
FloatRangeArray
The float ranges associated with the field. |
↳ date_time_range_array |
DateTimeRangeArray
The datetime ranges associated with the field. |
↳ geo_location_array |
GeoLocationArray
Geo Location array. |
↳ bool_value |
BoolValue
A Boolean value. |
↳ field |
string
The UGA field or ML field to apply filtering criteria. |
↳ fetch_matched_annotations |
bool
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 |
getTextArray
The text values associated with the field.
| Returns | |
|---|---|
| Type | Description |
StringArray|null |
|
hasTextArray
setTextArray
The text values associated with the field.
| Parameter | |
|---|---|
| Name | Description |
var |
StringArray
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIntRangeArray
The integer ranges associated with the field.
| Returns | |
|---|---|
| Type | Description |
IntRangeArray|null |
|
hasIntRangeArray
setIntRangeArray
The integer ranges associated with the field.
| Parameter | |
|---|---|
| Name | Description |
var |
IntRangeArray
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFloatRangeArray
The float ranges associated with the field.
| Returns | |
|---|---|
| Type | Description |
FloatRangeArray|null |
|
hasFloatRangeArray
setFloatRangeArray
The float ranges associated with the field.
| Parameter | |
|---|---|
| Name | Description |
var |
FloatRangeArray
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDateTimeRangeArray
The datetime ranges associated with the field.
| Returns | |
|---|---|
| Type | Description |
DateTimeRangeArray|null |
|
hasDateTimeRangeArray
setDateTimeRangeArray
The datetime ranges associated with the field.
| Parameter | |
|---|---|
| Name | Description |
var |
DateTimeRangeArray
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGeoLocationArray
Geo Location array.
| Returns | |
|---|---|
| Type | Description |
GeoLocationArray|null |
|
hasGeoLocationArray
setGeoLocationArray
Geo Location array.
| Parameter | |
|---|---|
| Name | Description |
var |
GeoLocationArray
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBoolValue
A Boolean value.
| Returns | |
|---|---|
| Type | Description |
BoolValue|null |
|
hasBoolValue
setBoolValue
A Boolean value.
| Parameter | |
|---|---|
| Name | Description |
var |
BoolValue
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getField
The UGA field or ML field to apply filtering criteria.
| Returns | |
|---|---|
| Type | Description |
string |
|
setField
The UGA field or ML field to apply filtering criteria.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFetchMatchedAnnotations
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 | |
|---|---|
| Type | Description |
bool |
|
setFetchMatchedAnnotations
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
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getValue
| Returns | |
|---|---|
| Type | Description |
string |
|