Cloud AI Platform v1 API - Class NearestNeighborQuery (2.23.0)

Version 2.23.0

• 3.11.0 (latest)
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.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

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

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

A query to find a number of similar entities.

Inheritance

object > NearestNeighborQuery

Implements

IMessageNearestNeighborQuery, IEquatableNearestNeighborQuery, IDeepCloneableNearestNeighborQuery, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

NearestNeighborQuery()

public NearestNeighborQuery()

NearestNeighborQuery(NearestNeighborQuery)

public NearestNeighborQuery(NearestNeighborQuery other)

Parameter
Name	Description
other	NearestNeighborQuery

Properties

Embedding

public NearestNeighborQuery.Types.Embedding Embedding { get; set; }

Optional. The embedding vector that be used for similar search.

Property Value
Type	Description
NearestNeighborQueryTypesEmbedding

EntityId

public string EntityId { get; set; }

Optional. The entity id whose similar entities should be searched for. If embedding is set, search will use embedding instead of entity_id.

Property Value
Type	Description
string

HasEntityId

public bool HasEntityId { get; }

Gets whether the "entity_id" field is set

Property Value
Type	Description
bool

InstanceCase

public NearestNeighborQuery.InstanceOneofCase InstanceCase { get; }

Property Value
Type	Description
NearestNeighborQueryInstanceOneofCase

NeighborCount

public int NeighborCount { get; set; }

Optional. The number of similar entities to be retrieved from feature view for each query.

Property Value
Type	Description
int

Parameters

public NearestNeighborQuery.Types.Parameters Parameters { get; set; }

Optional. Parameters that can be set to tune query on the fly.

Property Value
Type	Description
NearestNeighborQueryTypesParameters

PerCrowdingAttributeNeighborCount

public int PerCrowdingAttributeNeighborCount { get; set; }

Optional. Crowding is a constraint on a neighbor list produced by nearest neighbor search requiring that no more than sper_crowding_attribute_neighbor_count of the k neighbors returned have the same value of crowding_attribute. It's used for improving result diversity.

Property Value
Type	Description
int

StringFilters

public RepeatedField<NearestNeighborQuery.Types.StringFilter> StringFilters { get; }

Optional. The list of string filters.

Property Value
Type	Description
RepeatedFieldNearestNeighborQueryTypesStringFilter