BaseVectorQuery interface
The query parameters for vector and hybrid search queries.
Properties
exhaustive | 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. |
fields | Vector Fields of type Collection(Edm.Single) to be included in the vector searched. |
kind | Known values supported by the servicevector: Vector query where a raw vector value is provided. text: Vector query where a text value that needs to be vectorized is provided. |
k |
Number of nearest neighbors to return as top hits. |
oversampling | 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. |
weight | 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. |
Property Details
exhaustive
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.
exhaustive?: boolean
Property Value
boolean
fields
Vector Fields of type Collection(Edm.Single) to be included in the vector searched.
fields?: SearchFieldArray<TModel>
Property Value
SearchFieldArray<TModel>
kind
Known values supported by the service
vector: Vector query where a raw vector value is provided. text: Vector query where a text value that needs to be vectorized is provided.
kind: "vector" | "text"
Property Value
"vector" | "text"
kNearestNeighborsCount
Number of nearest neighbors to return as top hits.
kNearestNeighborsCount?: number
Property Value
number
oversampling
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.
oversampling?: number
Property Value
number
weight
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.
weight?: number
Property Value
number