ExhaustiveKnnAlgorithmConfiguration Class

Package:

com.azure.search.documents.indexes.models

Maven Artifact:

com.azure:azure-search-documents:11.8.1

• java.lang.Object
• • com.azure.search.documents.indexes.models.VectorSearchAlgorithmConfiguration
  • • com.azure.search.documents.indexes.models.ExhaustiveKnnAlgorithmConfiguration

public final class ExhaustiveKnnAlgorithmConfiguration
extends VectorSearchAlgorithmConfiguration

Contains configuration options specific to the exhaustive KNN algorithm used during querying, which will perform brute-force search across the entire vector index.

Constructor Summary

Constructor	Description
ExhaustiveKnnAlgorithmConfiguration(String name)	Creates an instance of ExhaustiveKnnAlgorithmConfiguration class.

Method Summary

Modifier and Type	Method and Description
static ExhaustiveKnnAlgorithmConfiguration	fromJson(JsonReader jsonReader) Reads an instance of ExhaustiveKnnAlgorithmConfiguration from the JsonReader.
VectorSearchAlgorithmKind	getKind() Get the kind property: The name of the kind of algorithm being configured for use with vector search.
ExhaustiveKnnParameters	getParameters() Get the parameters property: Contains the parameters specific to exhaustive KNN algorithm.
ExhaustiveKnnAlgorithmConfiguration	setParameters(ExhaustiveKnnParameters parameters) Set the parameters property: Contains the parameters specific to exhaustive KNN algorithm.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from VectorSearchAlgorithmConfiguration

fromJson getKind getName toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ExhaustiveKnnAlgorithmConfiguration

public ExhaustiveKnnAlgorithmConfiguration(String name)

Creates an instance of ExhaustiveKnnAlgorithmConfiguration class.

Parameters:

name - the name value to set.

Method Details

fromJson

public static ExhaustiveKnnAlgorithmConfiguration fromJson(JsonReader jsonReader)

Reads an instance of ExhaustiveKnnAlgorithmConfiguration from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getKind

public VectorSearchAlgorithmKind getKind()

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

Overrides:

ExhaustiveKnnAlgorithmConfiguration.getKind()

Returns:

the kind value.

getParameters

public ExhaustiveKnnParameters getParameters()

Get the parameters property: Contains the parameters specific to exhaustive KNN algorithm.

Returns:

the parameters value.

setParameters

public ExhaustiveKnnAlgorithmConfiguration setParameters(ExhaustiveKnnParameters parameters)

Set the parameters property: Contains the parameters specific to exhaustive KNN algorithm.

Parameters:

parameters - the parameters value to set.

Returns:

the ExhaustiveKnnAlgorithmConfiguration object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ExhaustiveKnnAlgorithmConfiguration.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException