Package com.yahoo.prelude.query

Class NearestNeighborItem

java.lang.Object

com.yahoo.prelude.query.Item

com.yahoo.prelude.query.SimpleTaggableItem

com.yahoo.prelude.query.NearestNeighborItem

All Implemented Interfaces:

TaggableItem, Cloneable

public class NearestNeighborItem
extends SimpleTaggableItem

Represent a query item matching the K nearest neighbors in a multi-dimensional vector space. The query point vector is referenced by the name of a tensor passed as a query rank feature; specifying "myvector" as the name means the query must set "ranking.features.query(myvector)". This rank feature must be configured with the correct tensor type in the active query profile. The field name (AKA the index name) given must be an attribute, with the exact same tensor type.

Author:

arnej

Nested Class Summary

Nested classes/interfaces inherited from class com.yahoo.prelude.query.Item

Item.ItemCreator, Item.ItemType

Field Summary

Fields inherited from class com.yahoo.prelude.query.Item

connectedBacklink, connectedItem, connectivity, DEFAULT_WEIGHT, explicitSignificance, significance, uniqueID

Constructor Summary

Constructors

Constructor	Description
NearestNeighborItem(String fieldName, String queryTensorName)

Method Summary

Modifier and Type	Method	Description
protected void	appendBodyString(StringBuilder buffer)	Override to append the item body in the canonical query language of this item.
void	disclose(Discloser discloser)
int	encode(ByteBuffer buffer)
boolean	equals(Object o)	Returns whether this item is of the same class and contains the same state as the given item.
boolean	getAllowApproximate()	Returns whether approximation is allowed
double	getDistanceThreshold()	Returns the distance threshold for nearest-neighbor hits
int	getHnswExploreAdditionalHits()	Returns the number of extra hits to explore in HNSW algorithm
String	getIndexName()	Returns the name of the index (field) to be searched
Item.ItemType	getItemType()	Return the enumerated type of this item.
String	getName()	Returns the name of this item
String	getQueryTensorName()	Returns the name of the query tensor
int	getTargetNumHits()	Returns the K number of hits to produce
int	getTermCount()
int	hashCode()
void	setAllowApproximate(boolean value)	Set whether approximation is allowed
void	setDistanceThreshold(double threshold)	Set the distance threshold for nearest-neighbor hits
void	setHnswExploreAdditionalHits(int num)	Set the number of extra hits to explore in HNSW algorithm
void	setIndexName(String index)	Sets the index name of this item
void	setTargetNumHits(int target)	Set the K number of hits to produce

Methods inherited from class com.yahoo.prelude.query.SimpleTaggableItem

getConnectedItem, getConnectivity, getSignificance, getUniqueID, hasExplicitSignificance, hasUniqueID, setConnectivity, setExplicitSignificance, setSignificance, setUniqueID

Methods inherited from class com.yahoo.prelude.query.Item

addAnnotation, appendHeadingString, clone, encodeThis, getAnnotation, getBytes, getCode, getCreator, getLabel, getLanguage, getParent, getWeight, hasAnnotation, hasConnectivityBackLink, isFilter, isFromSpecialToken, isProtected, isRanked, isRoot, putBytes, putString, setCreator, setFilter, setFromSpecialToken, setHasUniqueID, setLabel, setLanguage, setParent, setPositionData, setProtected, setRanked, setWeight, shouldParenthesize, toString, usePositionData

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

NearestNeighborItem

public NearestNeighborItem(String fieldName,
 String queryTensorName)

Method Details

getTargetNumHits

public int getTargetNumHits()

Returns the K number of hits to produce

getIndexName

public String getIndexName()

Returns the name of the index (field) to be searched

getDistanceThreshold

public double getDistanceThreshold()

Returns the distance threshold for nearest-neighbor hits

getHnswExploreAdditionalHits

public int getHnswExploreAdditionalHits()

Returns the number of extra hits to explore in HNSW algorithm

getAllowApproximate

public boolean getAllowApproximate()

Returns whether approximation is allowed

getQueryTensorName

public String getQueryTensorName()

Returns the name of the query tensor

setTargetNumHits

public void setTargetNumHits(int target)

Set the K number of hits to produce

setDistanceThreshold

public void setDistanceThreshold(double threshold)

Set the distance threshold for nearest-neighbor hits

setHnswExploreAdditionalHits

public void setHnswExploreAdditionalHits(int num)

Set the number of extra hits to explore in HNSW algorithm

setAllowApproximate

public void setAllowApproximate(boolean value)

Set whether approximation is allowed

setIndexName

public void setIndexName(String index)

Description copied from class: Item

Sets the index name of this item

Specified by:

setIndexName in class Item

getItemType

public Item.ItemType getItemType()

Description copied from class: Item

Return the enumerated type of this item.

Specified by:

getItemType in class Item

getName

public String getName()

Description copied from class: Item

Returns the name of this item

Specified by:

getName in class Item

getTermCount

public int getTermCount()

Specified by:

getTermCount in class Item

encode

public int encode(ByteBuffer buffer)

Specified by:

encode in class Item

appendBodyString

protected void appendBodyString(StringBuilder buffer)

Description copied from class: Item

Override to append the item body in the canonical query language of this item. An item is usually represented by the string

 ([itemName] [body])
 

The body must be appended appended by this method.

Specified by:

appendBodyString in class Item

disclose

public void disclose(Discloser discloser)

Overrides:

disclose in class Item

equals

public boolean equals(Object o)

Description copied from class: Item

Returns whether this item is of the same class and contains the same state as the given item.

Overrides:

equals in class Item

hashCode

public int hashCode()

Overrides:

hashCode in class Item