Interface NearestNeighborQueryOrBuilder (3.48.0) 

public interface NearestNeighborQueryOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getEmbedding()

public abstract NearestNeighborQuery.Embedding getEmbedding()

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

.google.cloud.aiplatform.v1.NearestNeighborQuery.Embedding embedding = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
NearestNeighborQuery.Embedding

The embedding.

getEmbeddingOrBuilder()

public abstract NearestNeighborQuery.EmbeddingOrBuilder getEmbeddingOrBuilder()

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

.google.cloud.aiplatform.v1.NearestNeighborQuery.Embedding embedding = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
NearestNeighborQuery.EmbeddingOrBuilder

getEntityId()

public abstract String getEntityId()

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

string entity_id = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The entityId.

getEntityIdBytes()

public abstract ByteString getEntityIdBytes()

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

string entity_id = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for entityId.

getInstanceCase()

public abstract NearestNeighborQuery.InstanceCase getInstanceCase()
Returns
Type Description
NearestNeighborQuery.InstanceCase

getNeighborCount()

public abstract int getNeighborCount()

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

int32 neighbor_count = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The neighborCount.

getNumericFilters(int index)

public abstract NearestNeighborQuery.NumericFilter getNumericFilters(int index)

Optional. The list of numeric filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.NumericFilter numeric_filters = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
NearestNeighborQuery.NumericFilter

getNumericFiltersCount()

public abstract int getNumericFiltersCount()

Optional. The list of numeric filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.NumericFilter numeric_filters = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getNumericFiltersList()

public abstract List<NearestNeighborQuery.NumericFilter> getNumericFiltersList()

Optional. The list of numeric filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.NumericFilter numeric_filters = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<NumericFilter>

getNumericFiltersOrBuilder(int index)

public abstract NearestNeighborQuery.NumericFilterOrBuilder getNumericFiltersOrBuilder(int index)

Optional. The list of numeric filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.NumericFilter numeric_filters = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
NearestNeighborQuery.NumericFilterOrBuilder

getNumericFiltersOrBuilderList()

public abstract List<? extends NearestNeighborQuery.NumericFilterOrBuilder> getNumericFiltersOrBuilderList()

Optional. The list of numeric filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.NumericFilter numeric_filters = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.aiplatform.v1.NearestNeighborQuery.NumericFilterOrBuilder>

getParameters()

public abstract NearestNeighborQuery.Parameters getParameters()

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

.google.cloud.aiplatform.v1.NearestNeighborQuery.Parameters parameters = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
NearestNeighborQuery.Parameters

The parameters.

getParametersOrBuilder()

public abstract NearestNeighborQuery.ParametersOrBuilder getParametersOrBuilder()

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

.google.cloud.aiplatform.v1.NearestNeighborQuery.Parameters parameters = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
NearestNeighborQuery.ParametersOrBuilder

getPerCrowdingAttributeNeighborCount()

public abstract int getPerCrowdingAttributeNeighborCount()

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.

int32 per_crowding_attribute_neighbor_count = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The perCrowdingAttributeNeighborCount.

getStringFilters(int index)

public abstract NearestNeighborQuery.StringFilter getStringFilters(int index)

Optional. The list of string filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.StringFilter string_filters = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
NearestNeighborQuery.StringFilter

getStringFiltersCount()

public abstract int getStringFiltersCount()

Optional. The list of string filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.StringFilter string_filters = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getStringFiltersList()

public abstract List<NearestNeighborQuery.StringFilter> getStringFiltersList()

Optional. The list of string filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.StringFilter string_filters = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<StringFilter>

getStringFiltersOrBuilder(int index)

public abstract NearestNeighborQuery.StringFilterOrBuilder getStringFiltersOrBuilder(int index)

Optional. The list of string filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.StringFilter string_filters = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
NearestNeighborQuery.StringFilterOrBuilder

getStringFiltersOrBuilderList()

public abstract List<? extends NearestNeighborQuery.StringFilterOrBuilder> getStringFiltersOrBuilderList()

Optional. The list of string filters.

repeated .google.cloud.aiplatform.v1.NearestNeighborQuery.StringFilter string_filters = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.aiplatform.v1.NearestNeighborQuery.StringFilterOrBuilder>

hasEmbedding()

public abstract boolean hasEmbedding()

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

.google.cloud.aiplatform.v1.NearestNeighborQuery.Embedding embedding = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the embedding field is set.

hasEntityId()

public abstract boolean hasEntityId()

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

string entity_id = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the entityId field is set.

hasParameters()

public abstract boolean hasParameters()

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

.google.cloud.aiplatform.v1.NearestNeighborQuery.Parameters parameters = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the parameters field is set.