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

Version 1.7.0

• 1.11.0 (latest)
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.39.0
• 0.38.0
• 0.37.1
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.2
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.13.0
• 0.12.0
• 0.11.1
• 0.10.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
Name	Description
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 for dense index. An array of numbers with the length of [NearestNeighborSearchConfig.dimensions].
↳ sparse_embedding	Google\Cloud\AIPlatform\V1\IndexDatapoint\SparseEmbedding Optional. Feature embedding vector for sparse index.
↳ 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
Type	Description
string

setDatapointId

Required. Unique identifier of the datapoint.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getFeatureVector

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

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setFeatureVector

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

Parameter
Name	Description
var	float[]

Returns
Type	Description
$this

getSparseEmbedding

Optional. Feature embedding vector for sparse index.

Returns
Type	Description
Google\Cloud\AIPlatform\V1\IndexDatapoint\SparseEmbedding|null

hasSparseEmbedding

clearSparseEmbedding

setSparseEmbedding

Optional. Feature embedding vector for sparse index.

Parameter
Name	Description
var	Google\Cloud\AIPlatform\V1\IndexDatapoint\SparseEmbedding

Returns
Type	Description
$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
Type	Description
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
Name	Description
var	array<Google\Cloud\AIPlatform\V1\IndexDatapoint\Restriction>

Returns
Type	Description
$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
Type	Description
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
Name	Description
var	array<Google\Cloud\AIPlatform\V1\IndexDatapoint\NumericRestriction>

Returns
Type	Description
$this

getCrowdingTag

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

Returns
Type	Description
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
Name	Description
var	Google\Cloud\AIPlatform\V1\IndexDatapoint\CrowdingTag

Returns
Type	Description
$this