AzureAISearchVectorStoreRecordCollection<TRecord> Class

Definition

Namespace:: Microsoft.SemanticKernel.Connectors.AzureAISearch

Assembly:: Microsoft.SemanticKernel.Connectors.AzureAISearch.dll

Package:: Microsoft.SemanticKernel.Connectors.AzureAISearch v1.45.0-preview

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.

Service for storing and retrieving vector records, that uses Azure AI Search as the underlying storage.

public class AzureAISearchVectorStoreRecordCollection<TRecord> : Microsoft.Extensions.VectorData.IKeywordHybridSearch<TRecord>, Microsoft.Extensions.VectorData.IVectorizableTextSearch<TRecord>, Microsoft.Extensions.VectorData.IVectorizedSearch<TRecord>, Microsoft.Extensions.VectorData.IVectorStoreRecordCollection<string,TRecord>

type AzureAISearchVectorStoreRecordCollection<'Record> = class
    interface IVectorStoreRecordCollection<string, 'Record>
    interface IVectorizedSearch<'Record>
    interface IVectorizableTextSearch<'Record>
    interface IKeywordHybridSearch<'Record>

Public Class AzureAISearchVectorStoreRecordCollection(Of TRecord)
Implements IKeywordHybridSearch(Of TRecord), IVectorizableTextSearch(Of TRecord), IVectorizedSearch(Of TRecord), IVectorStoreRecordCollection(Of String, TRecord)

Type Parameters

TRecord

The data model to use for adding, updating and retrieving data from storage.

Inheritance: Object
AzureAISearchVectorStoreRecordCollection<TRecord>

Implements: Microsoft.Extensions.VectorData.IKeywordHybridSearch<TRecord> Microsoft.Extensions.VectorData.IVectorizableTextSearch<TRecord> Microsoft.Extensions.VectorData.IVectorizedSearch<TRecord> Microsoft.Extensions.VectorData.IVectorStoreRecordCollection<String,TRecord>

Constructors

AzureAISearchVectorStoreRecordCollection<TRecord>(SearchIndexClient, String, AzureAISearchVectorStoreRecordCollectionOptions<TRecord>)

Initializes a new instance of the AzureAISearchVectorStoreRecordCollection<TRecord> class.

Properties

CollectionName

Microsoft.Extensions.VectorData.IVectorStoreRecordCollection`2.CollectionName

Methods

CollectionExistsAsync(CancellationToken)	Microsoft.Extensions.VectorData.IVectorStoreRecordCollection`2.CollectionExistsAsync(System.Threading.CancellationToken)
CreateCollectionAsync(CancellationToken)	Microsoft.Extensions.VectorData.IVectorStoreRecordCollection`2.CreateCollectionAsync(System.Threading.CancellationToken)
CreateCollectionIfNotExistsAsync(CancellationToken)	Microsoft.Extensions.VectorData.IVectorStoreRecordCollection`2.CreateCollectionIfNotExistsAsync(System.Threading.CancellationToken)
DeleteAsync(String, CancellationToken)	Microsoft.Extensions.VectorData.IVectorStoreRecordCollection`2.DeleteAsync(`0,System.Threading.CancellationToken)
DeleteBatchAsync(IEnumerable<String>, CancellationToken)	Microsoft.Extensions.VectorData.IVectorStoreRecordCollection`2.DeleteBatchAsync(System.Collections.Generic.IEnumerable{`0},System.Threading.CancellationToken)
DeleteCollectionAsync(CancellationToken)	Microsoft.Extensions.VectorData.IVectorStoreRecordCollection`2.DeleteCollectionAsync(System.Threading.CancellationToken)
GetAsync(String, GetRecordOptions, CancellationToken)	Microsoft.Extensions.VectorData.IVectorStoreRecordCollection`2.GetAsync(`0,Microsoft.Extensions.VectorData.GetRecordOptions,System.Threading.CancellationToken)
GetBatchAsync(IEnumerable<String>, GetRecordOptions, CancellationToken)	Microsoft.Extensions.VectorData.IVectorStoreRecordCollection`2.GetBatchAsync(System.Collections.Generic.IEnumerable{`0},Microsoft.Extensions.VectorData.GetRecordOptions,System.Threading.CancellationToken)
HybridSearchAsync<TVector>(TVector, ICollection<String>, HybridSearchOptions<TRecord>, CancellationToken)	Microsoft.Extensions.VectorData.IKeywordHybridSearch`1.HybridSearchAsync``1(``0,System.Collections.Generic.ICollection{System.String},Microsoft.Extensions.VectorData.HybridSearchOptions{`0},System.Threading.CancellationToken)
UpsertAsync(TRecord, CancellationToken)	Microsoft.Extensions.VectorData.IVectorStoreRecordCollection`2.UpsertAsync(`1,System.Threading.CancellationToken)
UpsertBatchAsync(IEnumerable<TRecord>, CancellationToken)	Microsoft.Extensions.VectorData.IVectorStoreRecordCollection`2.UpsertBatchAsync(System.Collections.Generic.IEnumerable{`1},System.Threading.CancellationToken)
VectorizableTextSearchAsync(String, VectorSearchOptions<TRecord>, CancellationToken)	Microsoft.Extensions.VectorData.IVectorizableTextSearch`1.VectorizableTextSearchAsync(System.String,Microsoft.Extensions.VectorData.VectorSearchOptions{`0},System.Threading.CancellationToken)
VectorizedSearchAsync<TVector>(TVector, VectorSearchOptions<TRecord>, CancellationToken)	Microsoft.Extensions.VectorData.IVectorizedSearch`1.VectorizedSearchAsync``1(``0,Microsoft.Extensions.VectorData.VectorSearchOptions{`0},System.Threading.CancellationToken)

Applies to

Share via