Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::NearestNeighborQuery::StringFilter.
String filter is used to search a subset of the entities by using boolean rules on string columns. For example: if a query specifies string filter with 'name = color, allow_tokens = {red, blue}, deny_tokens = {purple}',' then that query will match entities that are red or blue, but if those points are also purple, then they will be excluded even if they are red/blue. Only string filter is supported for now, numeric filter will be supported in the near future.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#allow_tokens
def allow_tokens() -> ::Array<::String>
Returns
- (::Array<::String>) — Optional. The allowed tokens.
#allow_tokens=
def allow_tokens=(value) -> ::Array<::String>
Parameter
- value (::Array<::String>) — Optional. The allowed tokens.
Returns
- (::Array<::String>) — Optional. The allowed tokens.
#deny_tokens
def deny_tokens() -> ::Array<::String>
Returns
- (::Array<::String>) — Optional. The denied tokens.
#deny_tokens=
def deny_tokens=(value) -> ::Array<::String>
Parameter
- value (::Array<::String>) — Optional. The denied tokens.
Returns
- (::Array<::String>) — Optional. The denied tokens.
#name
def name() -> ::String
Returns
- (::String) — Required. Column names in BigQuery that used as filters.
#name=
def name=(value) -> ::String
Parameter
- value (::String) — Required. Column names in BigQuery that used as filters.
Returns
- (::String) — Required. Column names in BigQuery that used as filters.