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

Source:: VectorSearchAlgorithmConfiguration.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 algorithm used during indexing or querying. Please note VectorSearchAlgorithmConfiguration is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include ExhaustiveKnnAlgorithmConfiguration and HnswAlgorithmConfiguration.

public abstract class VectorSearchAlgorithmConfiguration

[System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.Search.Documents.Models.UnknownVectorSearchAlgorithmConfiguration))]
public abstract class VectorSearchAlgorithmConfiguration : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Indexes.Models.VectorSearchAlgorithmConfiguration>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Indexes.Models.VectorSearchAlgorithmConfiguration>

type VectorSearchAlgorithmConfiguration = class

[<System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.Search.Documents.Models.UnknownVectorSearchAlgorithmConfiguration))>]
type VectorSearchAlgorithmConfiguration = class
    interface IJsonModel<VectorSearchAlgorithmConfiguration>
    interface IPersistableModel<VectorSearchAlgorithmConfiguration>

Public MustInherit Class VectorSearchAlgorithmConfiguration

Public MustInherit Class VectorSearchAlgorithmConfiguration
Implements IJsonModel(Of VectorSearchAlgorithmConfiguration), IPersistableModel(Of VectorSearchAlgorithmConfiguration)

Inheritance: Object
VectorSearchAlgorithmConfiguration

Derived: Azure.Search.Documents.Indexes.Models.ExhaustiveKnnAlgorithmConfiguration

Azure.Search.Documents.Indexes.Models.HnswAlgorithmConfiguration

Attributes: PersistableModelProxyAttribute

Implements: IJsonModel<VectorSearchAlgorithmConfiguration> IPersistableModel<VectorSearchAlgorithmConfiguration> IPersistableModel<T>

Constructors

VectorSearchAlgorithmConfiguration(String)

Initializes a new instance of VectorSearchAlgorithmConfiguration.

Properties

Name	The name to associate with this particular configuration.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

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

Applies to