Google Cloud Ai Platform V1 Client - Class IndexDatapoint (0.27.0)

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

A datapoint of Index.

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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ datapoint_id string

Required. Unique identifier of the datapoint.

↳ feature_vector array

Required. Feature embedding vector. An array of numbers with the length of [NearestNeighborSearchConfig.dimensions].

↳ restricts array<Google\Cloud\AIPlatform\V1\IndexDatapoint\Restriction>

Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. This uses categorical tokens. See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering

↳ numeric_restricts array<Google\Cloud\AIPlatform\V1\IndexDatapoint\NumericRestriction>

Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. This uses numeric comparisons.

↳ crowding_tag Google\Cloud\AIPlatform\V1\IndexDatapoint\CrowdingTag

Optional. CrowdingTag of the datapoint, the number of neighbors to return in each crowding can be configured during query.

getDatapointId

Required. Unique identifier of the datapoint.

Returns
TypeDescription
string

setDatapointId

Required. Unique identifier of the datapoint.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFeatureVector

Required. Feature embedding vector. An array of numbers with the length of [NearestNeighborSearchConfig.dimensions].

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setFeatureVector

Required. Feature embedding vector. An array of numbers with the length of [NearestNeighborSearchConfig.dimensions].

Parameter
NameDescription
var float[]
Returns
TypeDescription
$this

getRestricts

Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. This uses categorical tokens. See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setRestricts

Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. This uses categorical tokens. See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering

Parameter
NameDescription
var array<Google\Cloud\AIPlatform\V1\IndexDatapoint\Restriction>
Returns
TypeDescription
$this

getNumericRestricts

Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. This uses numeric comparisons.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setNumericRestricts

Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. This uses numeric comparisons.

Parameter
NameDescription
var array<Google\Cloud\AIPlatform\V1\IndexDatapoint\NumericRestriction>
Returns
TypeDescription
$this

getCrowdingTag

Optional. CrowdingTag of the datapoint, the number of neighbors to return in each crowding can be configured during query.

Returns
TypeDescription
Google\Cloud\AIPlatform\V1\IndexDatapoint\CrowdingTag|null

hasCrowdingTag

clearCrowdingTag

setCrowdingTag

Optional. CrowdingTag of the datapoint, the number of neighbors to return in each crowding can be configured during query.

Parameter
NameDescription
var Google\Cloud\AIPlatform\V1\IndexDatapoint\CrowdingTag
Returns
TypeDescription
$this