VectorizableImageUrlQuery Class

Package:
com.azure.search.documents.models
Maven Artifact:
com.azure:azure-search-documents:12.0.0

public final class VectorizableImageUrlQuery
extends VectorQuery

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

Constructor Summary

Constructor Description
VectorizableImageUrlQuery()

Creates an instance of VectorizableImageUrlQuery class.

Method Summary

Modifier and Type Method and Description
static VectorizableImageUrlQuery fromJson(JsonReader jsonReader)

Reads an instance of VectorizableImageUrlQuery from the JsonReader.
VectorQueryKind getKind()

Get the kind property: Type of query.
String getUrl()

Get the url property: The URL of an image to be vectorized to perform a vector search query.
VectorizableImageUrlQuery setExhaustive(Boolean exhaustive)

Set the exhaustive property: When true, triggers an exhaustive k-nearest neighbor search across all vectors within the vector index.
VectorizableImageUrlQuery setFields(String fields)

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

Set the kNearestNeighbors property: Number of nearest neighbors to return as top hits.
VectorizableImageUrlQuery setOversampling(Double oversampling)

Set the oversampling property: Oversampling factor.
VectorizableImageUrlQuery setUrl(String url)

Set the url property: The URL of an image to be vectorized to perform a vector search query.
VectorizableImageUrlQuery 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 VectorQuery

fromJson getFields getKNearestNeighbors getKind getOversampling getWeight isExhaustive setExhaustive setFields setKNearestNeighbors setOversampling setWeight toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

VectorizableImageUrlQuery

public VectorizableImageUrlQuery()

Creates an instance of VectorizableImageUrlQuery class.

Method Details

fromJson

public static VectorizableImageUrlQuery fromJson(JsonReader jsonReader)

Reads an instance of VectorizableImageUrlQuery from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of VectorizableImageUrlQuery 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 VectorizableImageUrlQuery.

getKind

public VectorQueryKind getKind()

Get the kind property: Type of query.

Overrides:

VectorizableImageUrlQuery.getKind()

Returns:

the kind value.

getUrl

public String getUrl()

Get the url property: The URL of an image to be vectorized to perform a vector search query.

Returns:

the url value.

setExhaustive

public VectorizableImageUrlQuery 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.

Overrides:

VectorizableImageUrlQuery.setExhaustive(Boolean exhaustive)

Parameters:

exhaustive

setFields

public VectorizableImageUrlQuery setFields(String fields)

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

Overrides:

VectorizableImageUrlQuery.setFields(String fields)

Parameters:

fields

setKNearestNeighbors

public VectorizableImageUrlQuery setKNearestNeighbors(Integer kNearestNeighbors)

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

Overrides:

VectorizableImageUrlQuery.setKNearestNeighbors(Integer kNearestNeighbors)

Parameters:

kNearestNeighbors

setOversampling

public VectorizableImageUrlQuery 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.

Overrides:

VectorizableImageUrlQuery.setOversampling(Double oversampling)

Parameters:

oversampling

setUrl

public VectorizableImageUrlQuery setUrl(String url)

Set the url property: The URL of an image to be vectorized to perform a vector search query.

Parameters:

url - the url value to set.

Returns:

the VectorizableImageUrlQuery object itself.

setWeight

public VectorizableImageUrlQuery 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.

Overrides:

VectorizableImageUrlQuery.setWeight(Float weight)

Parameters:

weight

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

VectorizableImageUrlQuery.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to