GetAsync(Expression<Func<TRecord, bool>>, int, FilteredRecordRetrievalOptions<TRecord>?, CancellationToken)

This method retrieves from the vector store records matching a filter expression. It does not guarantee the existence of the collection.

Declaration

// C#
 public async IAsyncEnumerable<TRecord?> GetAsync( Expression<Func<TRecord, bool>> filter, int top, FilteredRecordRetrievalOptions<TRecord>? options = null, CancellationToken cancellationToken = default);

Parameter

filter
Predicate for filtering the records.
top
Maximum number of results to return.
options
Optional options for retrieving the records.
cancellationToken
The cancellation token.

Return Value

IAsyncEnumerable<TRecord?> object representing the records matching the provided predicate.

Implements

Microsoft.Extensions.VectorData.VectorStoreCollection

Exceptions

VectorStoreException: The command fails to execute for any reason other than the absence of a record.

Remarks

The filter cannot compare the following unsupported columns types:

BFile
Blob
Clob
Json
NClob
Vector
Vector_Binary
Vector_Float32
Vector_Float64
Vector_Int8
XmlType