Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class 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.
Generated from protobuf message google.cloud.aiplatform.v1.NearestNeighborQuery.StringFilter
Namespace
Google \ Cloud \ AIPlatform \ V1 \ NearestNeighborQueryMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. Column names in BigQuery that used as filters. |
↳ allow_tokens |
array
Optional. The allowed tokens. |
↳ deny_tokens |
array
Optional. The denied tokens. |
getName
Required. Column names in BigQuery that used as filters.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Required. Column names in BigQuery that used as filters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAllowTokens
Optional. The allowed tokens.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setAllowTokens
Optional. The allowed tokens.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDenyTokens
Optional. The denied tokens.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setDenyTokens
Optional. The denied tokens.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|