HnswParameters Class
Definition
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 the parameters specific to the HNSW algorithm.
public class HnswParameterspublic class HnswParameters : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Indexes.Models.HnswParameters>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Indexes.Models.HnswParameters>type HnswParameters = classtype HnswParameters = class
interface IJsonModel<HnswParameters>
interface IPersistableModel<HnswParameters>Public Class HnswParametersPublic Class HnswParameters
Implements IJsonModel(Of HnswParameters), IPersistableModel(Of HnswParameters)- Inheritance
-
HnswParameters
- Implements
Constructors
| HnswParameters() |
Initializes a new instance of HnswParameters. |
Properties
| EfConstruction |
The size of the dynamic list containing the nearest neighbors, which is used during index time. Increasing this parameter may improve index quality, at the expense of increased indexing time. At a certain point, increasing this parameter leads to diminishing returns. |
| EfSearch |
The size of the dynamic list containing the nearest neighbors, which is used during search time. Increasing this parameter may improve search results, at the expense of slower search. At a certain point, increasing this parameter leads to diminishing returns. |
| M |
The number of bi-directional links created for every new element during construction. Increasing this parameter value may improve recall and reduce retrieval times for datasets with high intrinsic dimensionality at the expense of increased memory consumption and longer indexing time. |
| Metric |
The similarity metric to use for vector comparisons. |
Methods
| JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) |
Explicit Interface Implementations
| IJsonModel<HnswParameters>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<HnswParameters>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<HnswParameters>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<HnswParameters>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<HnswParameters>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
