Share via

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

Implements

JsonSerializable<VectorSearchAlgorithmConfiguration>

public class VectorSearchAlgorithmConfiguration
implements JsonSerializable<VectorSearchAlgorithmConfiguration>

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

Constructor Summary

Constructor Description
VectorSearchAlgorithmConfiguration(String name)

Creates an instance of VectorSearchAlgorithmConfiguration class.

Method Summary

Modifier and Type Method and Description
static VectorSearchAlgorithmConfiguration fromJson(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.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

VectorSearchAlgorithmConfiguration

public VectorSearchAlgorithmConfiguration(String name)

Creates an instance of VectorSearchAlgorithmConfiguration class.

Parameters:

name - the name value to set.

Method Details

fromJson

public static VectorSearchAlgorithmConfiguration fromJson(JsonReader jsonReader)

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:

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.

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 JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to