Partager via

VectorSearchCompression Class

  • Reference
Package:
com.azure.search.documents.indexes.models
Maven Artifact:
com.azure:azure-search-documents:11.7.3
  • java.lang.Object
    • com.azure.search.documents.indexes.models.VectorSearchCompression

Implements

JsonSerializable<VectorSearchCompression>

public class VectorSearchCompression
implements JsonSerializable<VectorSearchCompression>

Contains configuration options specific to the compression method used during indexing or querying.

Constructor Summary

Constructor Description
VectorSearchCompression(String compressionName)

Creates an instance of VectorSearchCompression class.

Method Summary

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

Reads an instance of VectorSearchCompression from the JsonReader.
String getCompressionName()

Get the compressionName property: The name to associate with this particular configuration.
Double getDefaultOversampling()

Get the defaultOversampling property: Default oversampling factor.
VectorSearchCompressionKind getKind()

Get the kind property: The name of the kind of compression method being configured for use with vector search.
Boolean isRerankWithOriginalVectors()

Get the rerankWithOriginalVectors property: If set to true, once the ordered set of results calculated using compressed vectors are obtained, they will be reranked again by recalculating the full-precision similarity scores.
VectorSearchCompression setDefaultOversampling(Double defaultOversampling)

Set the defaultOversampling property: Default oversampling factor.
VectorSearchCompression setRerankWithOriginalVectors(Boolean rerankWithOriginalVectors)

Set the rerankWithOriginalVectors property: If set to true, once the ordered set of results calculated using compressed vectors are obtained, they will be reranked again by recalculating the full-precision similarity scores.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

VectorSearchCompression

public VectorSearchCompression(String compressionName)

Creates an instance of VectorSearchCompression class.

Parameters:

compressionName - the compressionName value to set.

Method Details

fromJson

public static VectorSearchCompression fromJson(JsonReader jsonReader)

Reads an instance of VectorSearchCompression from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of VectorSearchCompression if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

getCompressionName

public String getCompressionName()

Get the compressionName property: The name to associate with this particular configuration.

Returns:

the compressionName value.

getDefaultOversampling

public Double getDefaultOversampling()

Get the defaultOversampling property: Default oversampling factor. Oversampling will internally request more documents (specified by this multiplier) in the initial search. This increases the set of results that will be reranked using recomputed similarity scores from full-precision vectors. Minimum value is 1, meaning no oversampling (1x). This parameter can only be set when rerankWithOriginalVectors is true. Higher values improve recall at the expense of latency.

Returns:

the defaultOversampling value.

getKind

public VectorSearchCompressionKind getKind()

Get the kind property: The name of the kind of compression method being configured for use with vector search.

Returns:

the kind value.

isRerankWithOriginalVectors

public Boolean isRerankWithOriginalVectors()

Get the rerankWithOriginalVectors property: If set to true, once the ordered set of results calculated using compressed vectors are obtained, they will be reranked again by recalculating the full-precision similarity scores. This will improve recall at the expense of latency.

Returns:

the rerankWithOriginalVectors value.

setDefaultOversampling

public VectorSearchCompression setDefaultOversampling(Double defaultOversampling)

Set the defaultOversampling property: Default oversampling factor. Oversampling will internally request more documents (specified by this multiplier) in the initial search. This increases the set of results that will be reranked using recomputed similarity scores from full-precision vectors. Minimum value is 1, meaning no oversampling (1x). This parameter can only be set when rerankWithOriginalVectors is true. Higher values improve recall at the expense of latency.

Parameters:

defaultOversampling - the defaultOversampling value to set.

Returns:

the VectorSearchCompression object itself.

setRerankWithOriginalVectors

public VectorSearchCompression setRerankWithOriginalVectors(Boolean rerankWithOriginalVectors)

Set the rerankWithOriginalVectors property: If set to true, once the ordered set of results calculated using compressed vectors are obtained, they will be reranked again by recalculating the full-precision similarity scores. This will improve recall at the expense of latency.

Parameters:

rerankWithOriginalVectors - the rerankWithOriginalVectors value to set.

Returns:

the VectorSearchCompression object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to