GetAsync(IEnumerable, RecordRetrieveOptions?, CancellationToken)

This method retrieves a batch of records from the vector store. It does not guarantee that the collection exists and returns null if the record is not found.

Declaration

// C#
public async IAsyncEnumerable<TRecord?> GetAsync(IEnumerable<TKey> keys, RecordRetrieveOptions? options = null, CancellationToken cancellationToken = default);

Parameters

• key

  The unique IDs associated with the records to retrieve.

• options

  Optional options for retrieving the records.

• cancellationToken

  The cancellation token.

Return Value

IAsyncEnumerable<TRecord?> object representing the result set of found records.

Implements

Microsoft.Extensions.VectorData.VectorStoreCollection

Exceptions

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

See Also:

• RecordRetrievalOptions