VectorQuery Class

  • Reference
Package:
com.azure.search.documents.models
Maven Artifact:
com.azure:azure-search-documents:11.7.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.
Integer getKNearestNeighborsCount()

Get the kNearestNeighborsCount property: Number of nearest neighbors to return as top hits.
VectorQueryKind getKind()

Get the kind property: The kind of vector query being performed.
Double getOversampling()

Get the oversampling property: Oversampling factor.
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 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 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.

getKNearestNeighborsCount

public Integer getKNearestNeighborsCount()

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

Returns:

the kNearestNeighborsCount value.

getKind

public VectorQueryKind getKind()

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

Returns:

the kind 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.

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.

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.

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:

Applies to