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

Source:: VectorSearch.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 related to vector search.

public class VectorSearch

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

type VectorSearch = class

type VectorSearch = class
    interface IJsonModel<VectorSearch>
    interface IPersistableModel<VectorSearch>

Public Class VectorSearch

Public Class VectorSearch
Implements IJsonModel(Of VectorSearch), IPersistableModel(Of VectorSearch)

Inheritance: Object
VectorSearch

Implements: IJsonModel<VectorSearch> IPersistableModel<VectorSearch> IPersistableModel<T>

Constructors

VectorSearch()

Initializes a new instance of VectorSearch.

Properties

Algorithms	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.
Compressions	Contains configuration options specific to the compression method used during indexing or querying. Please note VectorSearchCompression 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 BinaryQuantizationCompression and ScalarQuantizationCompression.
Profiles	Defines combinations of configurations to use with vector search.
Vectorizers	Contains configuration options on how to vectorize text vector queries. Please note VectorSearchVectorizer 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 AIServicesVisionVectorizer, AzureMachineLearningVectorizer, AzureOpenAIVectorizer and WebApiVectorizer.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

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

Applies to