VectorQuery Class

Package:

com.azure.search.documents.models

Maven Artifact:

com.azure:azure-search-documents:11.9.0-beta.1

• java.lang.Object
• • com.azure.search.documents.models.VectorQuery

Implements

JsonSerializable<VectorQuery>

public class VectorQuery
implements JsonSerializable<VectorQuery>

The query parameters for vector and hybrid search queries.

Constructor Summary

Constructor	Description
VectorQuery()	Creates an instance of VectorQuery class.

Method Summary

Modifier and Type	Method and Description
static VectorQuery	fromJson(JsonReader jsonReader) Reads an instance of VectorQuery from the JsonReader.
String	getFields() Get the fields property: Vector Fields of type Collection(Edm.Single) to be included in the vector searched.
String	getFilterOverride() Get the filterOverride property: The OData filter expression to apply to this specific vector query.
VectorQueryKind	getKind() Get the kind property: The kind of vector query being performed.
Integer	getKNearestNeighborsCount() Get the kNearestNeighborsCount property: Number of nearest neighbors to return as top hits.
Double	getOversampling() Get the oversampling property: Oversampling factor.
Integer	getPerDocumentVectorLimit() Get the perDocumentVectorLimit property: Controls how many vectors can be matched from each document in a vector search query.
VectorThreshold	getThreshold() Get the threshold property: The threshold used for vector queries.
Float	getWeight() Get the weight property: Relative weight of the vector query when compared to other vector query and/or the text query within the same search request.
Boolean	isExhaustive() Get the exhaustive property: When true, triggers an exhaustive k-nearest neighbor search across all vectors within the vector index.
VectorQuery	setExhaustive(Boolean exhaustive) Set the exhaustive property: When true, triggers an exhaustive k-nearest neighbor search across all vectors within the vector index.
VectorQuery	setFields(String[] fields) Set the fields property: Vector Fields of type Collection(Edm.Single) to be included in the vector searched.
VectorQuery	setFilterOverride(String filterOverride) Set the filterOverride property: The OData filter expression to apply to this specific vector query.
VectorQuery	setKNearestNeighborsCount(Integer kNearestNeighborsCount) Set the kNearestNeighborsCount property: Number of nearest neighbors to return as top hits.
VectorQuery	setOversampling(Double oversampling) Set the oversampling property: Oversampling factor.
VectorQuery	setPerDocumentVectorLimit(Integer perDocumentVectorLimit) Set the perDocumentVectorLimit property: Controls how many vectors can be matched from each document in a vector search query.
VectorQuery	setThreshold(VectorThreshold threshold) Set the threshold property: The threshold used for vector queries.
VectorQuery	setWeight(Float weight) Set the weight property: Relative weight of the vector query when compared to other vector query and/or the text query within the same search request.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

VectorQuery

public VectorQuery()

Creates an instance of VectorQuery class.

Method Details

fromJson

public static VectorQuery fromJson(JsonReader jsonReader)

Reads an instance of VectorQuery from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of VectorQuery if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the VectorQuery.

getFields

public String getFields()

Get the fields property: Vector Fields of type Collection(Edm.Single) to be included in the vector searched.

Returns:

the fields value.

getFilterOverride

public String getFilterOverride()

Get the filterOverride property: The OData filter expression to apply to this specific vector query. If no filter expression is defined at the vector level, the expression defined in the top level filter parameter is used instead.

Returns:

the filterOverride value.

getKind

public VectorQueryKind getKind()

Get the kind property: The kind of vector query being performed.

Returns:

the kind value.

getKNearestNeighborsCount

public Integer getKNearestNeighborsCount()

Get the kNearestNeighborsCount property: Number of nearest neighbors to return as top hits.

Returns:

the kNearestNeighborsCount value.

getOversampling

public Double getOversampling()

Get the oversampling property: Oversampling factor. Minimum value is 1. It overrides the 'defaultOversampling' parameter configured in the index definition. It can be set only when 'rerankWithOriginalVectors' is true. This parameter is only permitted when a compression method is used on the underlying vector field.

Returns:

the oversampling value.

getPerDocumentVectorLimit

public Integer getPerDocumentVectorLimit()

Get the perDocumentVectorLimit property: Controls how many vectors can be matched from each document in a vector search query. Setting it to 1 ensures at most one vector per document is matched, guaranteeing results come from distinct documents. Setting it to 0 (unlimited) allows multiple relevant vectors from the same document to be matched. Default is 0.

Returns:

the perDocumentVectorLimit value.

getThreshold

public VectorThreshold getThreshold()

Get the threshold property: The threshold used for vector queries. Note this can only be set if all 'fields' use the same similarity metric.

Returns:

the threshold value.

getWeight

public Float getWeight()

Get the weight property: Relative weight of the vector query when compared to other vector query and/or the text query within the same search request. This value is used when combining the results of multiple ranking lists produced by the different vector queries and/or the results retrieved through the text query. The higher the weight, the higher the documents that matched that query will be in the final ranking. Default is 1.0 and the value needs to be a positive number larger than zero.

Returns:

the weight value.

isExhaustive

public Boolean isExhaustive()

Get the exhaustive property: When true, triggers an exhaustive k-nearest neighbor search across all vectors within the vector index. Useful for scenarios where exact matches are critical, such as determining ground truth values.

Returns:

the exhaustive value.

setExhaustive

public VectorQuery setExhaustive(Boolean exhaustive)

Set the exhaustive property: When true, triggers an exhaustive k-nearest neighbor search across all vectors within the vector index. Useful for scenarios where exact matches are critical, such as determining ground truth values.

Parameters:

exhaustive - the exhaustive value to set.

Returns:

the VectorQuery object itself.

setFields

public VectorQuery setFields(String[] fields)

Set the fields property: Vector Fields of type Collection(Edm.Single) to be included in the vector searched.

Parameters:

fields - the fields value to set.

Returns:

the VectorQuery object itself.

setFilterOverride

public VectorQuery setFilterOverride(String filterOverride)

Set the filterOverride property: The OData filter expression to apply to this specific vector query. If no filter expression is defined at the vector level, the expression defined in the top level filter parameter is used instead.

Parameters:

filterOverride - the filterOverride value to set.

Returns:

the VectorQuery object itself.

setKNearestNeighborsCount

public VectorQuery setKNearestNeighborsCount(Integer kNearestNeighborsCount)

Set the kNearestNeighborsCount property: Number of nearest neighbors to return as top hits.

Parameters:

kNearestNeighborsCount - the kNearestNeighborsCount value to set.

Returns:

the VectorQuery object itself.

setOversampling

public VectorQuery setOversampling(Double oversampling)

Set the oversampling property: Oversampling factor. Minimum value is 1. It overrides the 'defaultOversampling' parameter configured in the index definition. It can be set only when 'rerankWithOriginalVectors' is true. This parameter is only permitted when a compression method is used on the underlying vector field.

Parameters:

oversampling - the oversampling value to set.

Returns:

the VectorQuery object itself.

setPerDocumentVectorLimit

public VectorQuery setPerDocumentVectorLimit(Integer perDocumentVectorLimit)

Set the perDocumentVectorLimit property: Controls how many vectors can be matched from each document in a vector search query. Setting it to 1 ensures at most one vector per document is matched, guaranteeing results come from distinct documents. Setting it to 0 (unlimited) allows multiple relevant vectors from the same document to be matched. Default is 0.

Parameters:

perDocumentVectorLimit - the perDocumentVectorLimit value to set.

Returns:

the VectorQuery object itself.

setThreshold

public VectorQuery setThreshold(VectorThreshold threshold)

Set the threshold property: The threshold used for vector queries. Note this can only be set if all 'fields' use the same similarity metric.

Parameters:

threshold - the threshold value to set.

Returns:

the VectorQuery object itself.

setWeight

public VectorQuery setWeight(Float weight)

Set the weight property: Relative weight of the vector query when compared to other vector query and/or the text query within the same search request. This value is used when combining the results of multiple ranking lists produced by the different vector queries and/or the results retrieved through the text query. The higher the weight, the higher the documents that matched that query will be in the final ranking. Default is 1.0 and the value needs to be a positive number larger than zero.

Parameters:

weight - the weight value to set.

Returns:

the VectorQuery object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException