Google Cloud Ai Platform V1 Client - Class CrowdingTag (0.13.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class CrowdingTag.

Crowding tag is a constraint on a neighbor list produced by nearest neighbor search requiring that no more than some value k' of the k neighbors returned have the same value of crowding_attribute.

Generated from protobuf message google.cloud.aiplatform.v1.IndexDatapoint.CrowdingTag

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ crowding_attribute string

The attribute value used for crowding. The maximum number of neighbors to return per crowding attribute value (per_crowding_attribute_num_neighbors) is configured per-query. This field is ignored if per_crowding_attribute_num_neighbors is larger than the total number of neighbors to return for a given query.

getCrowdingAttribute

The attribute value used for crowding. The maximum number of neighbors to return per crowding attribute value (per_crowding_attribute_num_neighbors) is configured per-query. This field is ignored if per_crowding_attribute_num_neighbors is larger than the total number of neighbors to return for a given query.

Returns
TypeDescription
string

setCrowdingAttribute

The attribute value used for crowding. The maximum number of neighbors to return per crowding attribute value (per_crowding_attribute_num_neighbors) is configured per-query. This field is ignored if per_crowding_attribute_num_neighbors is larger than the total number of neighbors to return for a given query.

Parameter
NameDescription
var string
Returns
TypeDescription
$this