GetAsync(Object , RecordRetrieveOptions?, CancellationToken)

This method retrieves a single record 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 Task<Dictionary<string, object?>?> GetAsync(Object key, RecordRetrieveOptions? options = null,  CancellationToken cancellationToken = default);

Parameters

key
The unique ID associated with the record to retrieve.
options
Optional options for retrieving the record.
cancellationToken
The cancellation token.

Return Value

Task<Dictionary<string, object?>> representing the record if found, or null if not found.

Implements

Microsoft.Extensions.VectorData.VectorStoreCollection

Exceptions

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

Remarks

Unlike OracleCollection, OracleDynamicColloection uses Object as TKey, and Dictionary<string, object?> as TRecord. Please make sure to use the correct parameter types.