HnswAlgorithmConfiguration Class

Definition

Namespace:: Azure.Search.Documents.Indexes.Models

Assembly:: Azure.Search.Documents.dll

Package:: Azure.Search.Documents v11.6.1

Package:: Azure.Search.Documents v11.7.0-beta.6

Source:: HnswAlgorithmConfiguration.cs

Source:: HnswAlgorithmConfiguration.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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.

public class HnswAlgorithmConfiguration : Azure.Search.Documents.Indexes.Models.VectorSearchAlgorithmConfiguration

public class HnswAlgorithmConfiguration : Azure.Search.Documents.Indexes.Models.VectorSearchAlgorithmConfiguration, System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Indexes.Models.HnswAlgorithmConfiguration>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Indexes.Models.HnswAlgorithmConfiguration>

type HnswAlgorithmConfiguration = class
    inherit VectorSearchAlgorithmConfiguration

type HnswAlgorithmConfiguration = class
    inherit VectorSearchAlgorithmConfiguration
    interface IJsonModel<HnswAlgorithmConfiguration>
    interface IPersistableModel<HnswAlgorithmConfiguration>

Public Class HnswAlgorithmConfiguration
Inherits VectorSearchAlgorithmConfiguration

Public Class HnswAlgorithmConfiguration
Inherits VectorSearchAlgorithmConfiguration
Implements IJsonModel(Of HnswAlgorithmConfiguration), IPersistableModel(Of HnswAlgorithmConfiguration)

Inheritance: Object

VectorSearchAlgorithmConfiguration
HnswAlgorithmConfiguration

Implements: IJsonModel<HnswAlgorithmConfiguration> IPersistableModel<HnswAlgorithmConfiguration> IPersistableModel<T>

Constructors

HnswAlgorithmConfiguration(String)

Initializes a new instance of HnswAlgorithmConfiguration.

Properties

Name	The name to associate with this particular configuration. (Inherited from VectorSearchAlgorithmConfiguration)
Parameters	Contains the parameters specific to HNSW algorithm.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<HnswAlgorithmConfiguration>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<HnswAlgorithmConfiguration>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IJsonModel<VectorSearchAlgorithmConfiguration>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. (Inherited from VectorSearchAlgorithmConfiguration)
IJsonModel<VectorSearchAlgorithmConfiguration>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter. (Inherited from VectorSearchAlgorithmConfiguration)
IPersistableModel<HnswAlgorithmConfiguration>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<HnswAlgorithmConfiguration>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<HnswAlgorithmConfiguration>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.
IPersistableModel<VectorSearchAlgorithmConfiguration>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model. (Inherited from VectorSearchAlgorithmConfiguration)
IPersistableModel<VectorSearchAlgorithmConfiguration>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. (Inherited from VectorSearchAlgorithmConfiguration)
IPersistableModel<VectorSearchAlgorithmConfiguration>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData. (Inherited from VectorSearchAlgorithmConfiguration)

Applies to