HnswAlgorithmConfiguration 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.HnswAlgorithmConfiguration

public final class HnswAlgorithmConfiguration
extends VectorSearchAlgorithmConfiguration

Contains configuration options specific to the HNSW approximate nearest neighbors algorithm used during indexing and querying. The HNSW algorithm offers a tunable trade-off between search speed and accuracy.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
static HnswAlgorithmConfiguration	fromJson(JsonReader jsonReader) Reads an instance of HnswAlgorithmConfiguration from the JsonReader.
VectorSearchAlgorithmKind	getKind() Get the kind property: The name of the kind of algorithm being configured for use with vector search.
HnswParameters	getParameters() Get the parameters property: Contains the parameters specific to HNSW algorithm.
HnswAlgorithmConfiguration	setParameters(HnswParameters parameters) Set the parameters property: Contains the parameters specific to HNSW 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

HnswAlgorithmConfiguration

public HnswAlgorithmConfiguration(String name)

Creates an instance of HnswAlgorithmConfiguration class.

Parameters:

name - the name value to set.

Method Details

fromJson

public static HnswAlgorithmConfiguration fromJson(JsonReader jsonReader)

Reads an instance of HnswAlgorithmConfiguration from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of HnswAlgorithmConfiguration 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:

HnswAlgorithmConfiguration.getKind()

Returns:

the kind value.

getParameters

public HnswParameters getParameters()

Get the parameters property: Contains the parameters specific to HNSW algorithm.

Returns:

the parameters value.

setParameters

public HnswAlgorithmConfiguration setParameters(HnswParameters parameters)

Set the parameters property: Contains the parameters specific to HNSW algorithm.

Parameters:

parameters - the parameters value to set.

Returns:

the HnswAlgorithmConfiguration object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

HnswAlgorithmConfiguration.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException