Cloud AI Platform v1 API - Class IndexDatapoint (3.13.0)

public sealed class IndexDatapoint : IMessage<IndexDatapoint>, IEquatable<IndexDatapoint>, IDeepCloneable<IndexDatapoint>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud AI Platform v1 API class IndexDatapoint.

A datapoint of Index.

Inheritance

object > IndexDatapoint

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

IndexDatapoint()

public IndexDatapoint()

IndexDatapoint(IndexDatapoint)

public IndexDatapoint(IndexDatapoint other)
Parameter
Name Description
other IndexDatapoint

Properties

CrowdingTag

public IndexDatapoint.Types.CrowdingTag CrowdingTag { get; set; }

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

Property Value
Type Description
IndexDatapointTypesCrowdingTag

DatapointId

public string DatapointId { get; set; }

Required. Unique identifier of the datapoint.

Property Value
Type Description
string

FeatureVector

public RepeatedField<float> FeatureVector { get; }

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

Property Value
Type Description
RepeatedFieldfloat

NumericRestricts

public RepeatedField<IndexDatapoint.Types.NumericRestriction> NumericRestricts { get; }

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.

Property Value
Type Description
RepeatedFieldIndexDatapointTypesNumericRestriction

Restricts

public RepeatedField<IndexDatapoint.Types.Restriction> Restricts { get; }

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

Property Value
Type Description
RepeatedFieldIndexDatapointTypesRestriction

SparseEmbedding

public IndexDatapoint.Types.SparseEmbedding SparseEmbedding { get; set; }

Optional. Feature embedding vector for sparse index.

Property Value
Type Description
IndexDatapointTypesSparseEmbedding