Package com.azure.search.documents.indexes.models

Class ExhaustiveKnnParameters

java.lang.Object

com.azure.search.documents.indexes.models.ExhaustiveKnnParameters

All Implemented Interfaces:

com.azure.json.JsonSerializable<ExhaustiveKnnParameters>

public final class ExhaustiveKnnParameters
extends Object
implements com.azure.json.JsonSerializable<ExhaustiveKnnParameters>

Contains the parameters specific to exhaustive KNN algorithm.

Constructor Summary

Constructors

Constructor	Description
ExhaustiveKnnParameters()	Creates an instance of ExhaustiveKnnParameters class.

Method Summary

Modifier and Type	Method	Description
static ExhaustiveKnnParameters	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of ExhaustiveKnnParameters from the JsonReader.
VectorSearchAlgorithmMetric	getMetric()	Get the metric property: The similarity metric to use for vector comparisons.
ExhaustiveKnnParameters	setMetric(VectorSearchAlgorithmMetric metric)	Set the metric property: The similarity metric to use for vector comparisons.
com.azure.json.JsonWriter	toJson(com.azure.json.JsonWriter jsonWriter)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.azure.json.JsonSerializable

toJson, toJson, toJsonBytes, toJsonString

Constructor Details

ExhaustiveKnnParameters

public ExhaustiveKnnParameters()

Creates an instance of ExhaustiveKnnParameters class.

Method Details

getMetric

public VectorSearchAlgorithmMetric getMetric()

Get the metric property: The similarity metric to use for vector comparisons.

Returns:

the metric value.

setMetric

public ExhaustiveKnnParameters setMetric(VectorSearchAlgorithmMetric metric)

Set the metric property: The similarity metric to use for vector comparisons.

Parameters:

metric - the metric value to set.

Returns:

the ExhaustiveKnnParameters object itself.

toJson

public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter)
                                 throws IOException

Specified by:

toJson in interface com.azure.json.JsonSerializable<ExhaustiveKnnParameters>

Throws:

IOException

fromJson

public static ExhaustiveKnnParameters fromJson(com.azure.json.JsonReader jsonReader)
                                        throws IOException

Reads an instance of ExhaustiveKnnParameters from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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