VectorStoreCollection<TKey,TRecord>.GetAsync Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Перегрузки
| Имя | Описание |
|---|---|
| GetAsync(IEnumerable<TKey>, RecordRetrievalOptions, CancellationToken) |
Возвращает пакет записей из хранилища векторов. Не гарантирует, что коллекция существует. |
| GetAsync(TKey, RecordRetrievalOptions, CancellationToken) |
Получает запись из векторного хранилища. Не гарантирует, что коллекция существует. Возвращает значение NULL, если запись не найдена. |
| GetAsync(Expression<Func<TRecord,Boolean>>, Int32, FilteredRecordRetrievalOptions<TRecord>, CancellationToken) |
Возвращает соответствующие записи из хранилища векторов. Не гарантирует, что коллекция существует. |
GetAsync(IEnumerable<TKey>, RecordRetrievalOptions, CancellationToken)
- Исходный код:
- VectorStoreCollection.cs
Возвращает пакет записей из хранилища векторов. Не гарантирует, что коллекция существует.
public virtual System.Collections.Generic.IAsyncEnumerable<TRecord> GetAsync(System.Collections.Generic.IEnumerable<TKey> keys, Microsoft.Extensions.VectorData.RecordRetrievalOptions? options = default, System.Threading.CancellationToken cancellationToken = default);abstract member GetAsync : seq<'Key> * Microsoft.Extensions.VectorData.RecordRetrievalOptions * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<'Record (requires 'Record : null)>
override this.GetAsync : seq<'Key> * Microsoft.Extensions.VectorData.RecordRetrievalOptions * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<'Record (requires 'Record : null)>Public Overridable Function GetAsync (keys As IEnumerable(Of TKey), Optional options As RecordRetrievalOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of TRecord)Параметры
- keys
- IEnumerable<TKey>
Уникальные идентификаторы, связанные с записью для получения.
- options
- RecordRetrievalOptions
Необязательные параметры получения записей.
- cancellationToken
- CancellationToken
Мониторинг CancellationToken запросов на отмену. Значение по умолчанию — None.
Возвращаемое значение
Записи, связанные с указанными уникальными ключами.
Исключения
Команда не выполняется по какой-либо причине.
Комментарии
Точный метод извлечения зависит от реализации и может отличаться в зависимости от поддержки базы данных. Реализация этого метода по умолчанию извлекает записи, одну после другой, но реализации, поддерживающие пакетную обработку, могут переопределить, чтобы обеспечить более эффективную реализацию.
Возвращаются только найденные записи, поэтому результирующий набор может быть меньше запрошенных ключей.
Этот метод вызывает проблемы, отличные от записей, которые не найдены.
Применяется к
GetAsync(TKey, RecordRetrievalOptions, CancellationToken)
- Исходный код:
- VectorStoreCollection.cs
Получает запись из векторного хранилища. Не гарантирует, что коллекция существует. Возвращает значение NULL, если запись не найдена.
public abstract System.Threading.Tasks.Task<TRecord?> GetAsync(TKey key, Microsoft.Extensions.VectorData.RecordRetrievalOptions? options = default, System.Threading.CancellationToken cancellationToken = default);abstract member GetAsync : 'Key * Microsoft.Extensions.VectorData.RecordRetrievalOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'Record (requires 'Record : null)>Public MustOverride Function GetAsync (key As TKey, Optional options As RecordRetrievalOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of TRecord)Параметры
- key
- TKey
Уникальный идентификатор, связанный с записью для получения.
- options
- RecordRetrievalOptions
Необязательные параметры получения записи.
- cancellationToken
- CancellationToken
Мониторинг CancellationToken запросов на отмену. Значение по умолчанию — None.
Возвращаемое значение
Запись, если найдена, в противном случае — значение NULL.
Исключения
Команда не выполняется по какой-либо причине.
Применяется к
GetAsync(Expression<Func<TRecord,Boolean>>, Int32, FilteredRecordRetrievalOptions<TRecord>, CancellationToken)
- Исходный код:
- VectorStoreCollection.cs
Возвращает соответствующие записи из хранилища векторов. Не гарантирует, что коллекция существует.
public abstract System.Collections.Generic.IAsyncEnumerable<TRecord> GetAsync(System.Linq.Expressions.Expression<Func<TRecord,bool>> filter, int top, Microsoft.Extensions.VectorData.FilteredRecordRetrievalOptions<TRecord>? options = default, System.Threading.CancellationToken cancellationToken = default);abstract member GetAsync : System.Linq.Expressions.Expression<Func<'Record, bool>> * int * Microsoft.Extensions.VectorData.FilteredRecordRetrievalOptions<'Record (requires 'Record : null)> * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<'Record (requires 'Record : null)>Public MustOverride Function GetAsync (filter As Expression(Of Func(Of TRecord, Boolean)), top As Integer, Optional options As FilteredRecordRetrievalOptions(Of TRecord) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of TRecord)Параметры
- filter
- Expression<Func<TRecord,Boolean>>
Предикат для фильтрации записей.
- top
- Int32
Максимальное количество отображаемых результатов.
Параметры получения записей.
- cancellationToken
- CancellationToken
Мониторинг CancellationToken запросов на отмену. Значение по умолчанию — None.
Возвращаемое значение
Записи, соответствующие заданному предикату.
Исключения
Команда не выполняется по какой-либо причине.
