Class GoogleCloudAiplatformV1NearestNeighborQuery

A query to find a number of similar entities.

Inheritance

object

GoogleCloudAiplatformV1NearestNeighborQuery

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Aiplatform.v1.Data

Assembly: Google.Apis.Aiplatform.v1.dll

Syntax

public class GoogleCloudAiplatformV1NearestNeighborQuery : IDirectResponseSchema

Properties

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

Embedding

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

Declaration

[JsonProperty("embedding")]
public virtual GoogleCloudAiplatformV1NearestNeighborQueryEmbedding Embedding { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1NearestNeighborQueryEmbedding

EntityId

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

Declaration

[JsonProperty("entityId")]
public virtual string EntityId { get; set; }

Property Value

Type	Description
string

NeighborCount

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

Declaration

[JsonProperty("neighborCount")]
public virtual int? NeighborCount { get; set; }

Property Value

Type	Description
int?

NumericFilters

Optional. The list of numeric filters.

Declaration

[JsonProperty("numericFilters")]
public virtual IList<GoogleCloudAiplatformV1NearestNeighborQueryNumericFilter> NumericFilters { get; set; }

Property Value

Type	Description
IList<GoogleCloudAiplatformV1NearestNeighborQueryNumericFilter>

Parameters

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

Declaration

[JsonProperty("parameters")]
public virtual GoogleCloudAiplatformV1NearestNeighborQueryParameters Parameters { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1NearestNeighborQueryParameters

PerCrowdingAttributeNeighborCount

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.

Declaration

[JsonProperty("perCrowdingAttributeNeighborCount")]
public virtual int? PerCrowdingAttributeNeighborCount { get; set; }

Property Value

Type	Description
int?

StringFilters

Optional. The list of string filters.

Declaration

[JsonProperty("stringFilters")]
public virtual IList<GoogleCloudAiplatformV1NearestNeighborQueryStringFilter> StringFilters { get; set; }

Property Value

Type	Description
IList<GoogleCloudAiplatformV1NearestNeighborQueryStringFilter>

Implements

IDirectResponseSchema