Package version:

Interface VectorizableTextQuery<TModel>

The query parameters to use for vector search when a text value that needs to be vectorized is provided.

interface VectorizableTextQuery<TModel> {
    exhaustive?: boolean;
    fields?: SearchFieldArray<TModel>;
    kNearestNeighborsCount?: number;
    kind: "text";
    oversampling?: number;
    text: string;
    weight?: number;
}

Type Parameters

  • TModel extends object

Hierarchy (view full)

Properties

exhaustive? fields? kNearestNeighborsCount? kind oversampling? text weight?

Properties

Optionalexhaustive

exhaustive?: boolean

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.

Optionalfields

fields?: SearchFieldArray<TModel>

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

OptionalkNearestNeighborsCount

kNearestNeighborsCount?: number

Number of nearest neighbors to return as top hits.

kind

kind: "text"

Polymorphic discriminator, which specifies the different types this object can be

Optionaloversampling

oversampling?: number

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.

text

text: string

The text to be vectorized to perform a vector search query.

Optionalweight

weight?: number

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.

Settings

Member Visibility