Package version:

Interface VectorizableImageUrlQuery<TModel>

The query parameters to use for vector search when an url that represents an image value that needs to be vectorized is provided.

interface VectorizableImageUrlQuery<TModel> {
    exhaustive?: boolean;
    fields?: SearchFieldArray<TModel>;
    filterOverride?: string;
    kind: "imageUrl";
    kNearestNeighborsCount?: number;
    perDocumentVectorLimit?: number;
    threshold?: VectorThreshold;
    url: string;
    weight?: number;
}

Type Parameters

  • TModel extends object

Hierarchy (view full)

Properties

exhaustive? fields? filterOverride? kind kNearestNeighborsCount? perDocumentVectorLimit? threshold? url 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.

OptionalfilterOverride

filterOverride?: string

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.

kind

kind

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

OptionalkNearestNeighborsCount

kNearestNeighborsCount?: number

Number of nearest neighbors to return as top hits.

OptionalperDocumentVectorLimit

perDocumentVectorLimit?: number

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.

Optionalthreshold

threshold?: VectorThreshold

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

url

url: string

The URL of an image 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