Language

VectorSearchAlgorithmConfiguration Class

Definition

Namespace:
Azure.Search.Documents.Indexes.Models
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v12.0.0
Package:
Azure.Search.Documents v12.1.0-beta.2
Source:
VectorSearchAlgorithmConfiguration.cs
Source:
VectorSearchAlgorithmConfiguration.cs

Contains configuration options specific to the algorithm used during indexing or querying. Please note this is the abstract base class. The derived classes available for instantiation are: HnswAlgorithmConfiguration and ExhaustiveKnnAlgorithmConfiguration.

[System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.Search.Documents.Indexes.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>
[<System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.Search.Documents.Indexes.Models.UnknownVectorSearchAlgorithmConfiguration))>]
type VectorSearchAlgorithmConfiguration = class
    interface IJsonModel<VectorSearchAlgorithmConfiguration>
    interface IPersistableModel<VectorSearchAlgorithmConfiguration>
Public MustInherit Class VectorSearchAlgorithmConfiguration
Implements IJsonModel(Of VectorSearchAlgorithmConfiguration), IPersistableModel(Of VectorSearchAlgorithmConfiguration)
Inheritance
Object
VectorSearchAlgorithmConfiguration
Derived
Attributes
PersistableModelProxyAttribute
Implements
IJsonModel<VectorSearchAlgorithmConfiguration> IPersistableModel<VectorSearchAlgorithmConfiguration> IPersistableModel<T>

Constructors

Name Description
VectorSearchAlgorithmConfiguration(String)

Initializes a new instance of VectorSearchAlgorithmConfiguration.

Properties

Name Description
Name

The name to associate with this particular configuration.

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
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