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

Class VectorSearchAlgorithmConfiguration

java.lang.Object

com.azure.search.documents.indexes.models.VectorSearchAlgorithmConfiguration

All Implemented Interfaces:

com.azure.json.JsonSerializable<VectorSearchAlgorithmConfiguration>

Direct Known Subclasses:

ExhaustiveKnnAlgorithmConfiguration, HnswAlgorithmConfiguration

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

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VectorSearchAlgorithmConfiguration	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of VectorSearchAlgorithmConfiguration from the JsonReader.
VectorSearchAlgorithmKind	getKind()	Get the kind property: The name of the kind of algorithm being configured for use with vector search.
String	getName()	Get the name property: The name to associate with this particular configuration.
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

VectorSearchAlgorithmConfiguration

public VectorSearchAlgorithmConfiguration(String name)

Creates an instance of VectorSearchAlgorithmConfiguration class.

Parameters:

name - the name value to set.

Method Details

getKind

public VectorSearchAlgorithmKind getKind()

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

Returns:

the kind value.

getName

public String getName()

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

Returns:

the name value.

toJson

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

Specified by:

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

Throws:

IOException

fromJson

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

Reads an instance of VectorSearchAlgorithmConfiguration from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

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

IOException - If an error occurs while reading the VectorSearchAlgorithmConfiguration.