VectorStoreCollection<TKey,TRecord>.GetAsync Método
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Sobrecargas
| Nome | Description |
|---|---|
| GetAsync(IEnumerable<TKey>, RecordRetrievalOptions, CancellationToken) |
Obtém um lote de registros do repositório de vetores. Não garante que a coleção exista. |
| GetAsync(TKey, RecordRetrievalOptions, CancellationToken) |
Obtém um registro do repositório de vetores. Não garante que a coleção exista. Retornará nulo se o registro não for encontrado. |
| GetAsync(Expression<Func<TRecord,Boolean>>, Int32, FilteredRecordRetrievalOptions<TRecord>, CancellationToken) |
Obtém registros correspondentes do repositório de vetores. Não garante que a coleção exista. |
GetAsync(IEnumerable<TKey>, RecordRetrievalOptions, CancellationToken)
Obtém um lote de registros do repositório de vetores. Não garante que a coleção exista.
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)Parâmetros
- keys
- IEnumerable<TKey>
As IDs exclusivas associadas ao registro a ser obtido.
- options
- RecordRetrievalOptions
Opções opcionais para recuperar os registros.
- cancellationToken
- CancellationToken
O CancellationToken para monitorar solicitações de cancelamento. O padrão é None.
Retornos
Os registros associados às chaves exclusivas especificadas.
Exceções
O comando falha ao ser executado por qualquer motivo.
Comentários
O método exato de recuperação é específico da implementação e pode variar com base no suporte ao banco de dados. A implementação padrão desse método recupera os registros um após o outro, mas implementações que dão suporte ao envio em lote podem substituir para fornecer uma implementação mais eficiente.
Somente registros encontrados são retornados, portanto, o conjunto de resultados pode ser menor do que as chaves solicitadas.
Esse método é gerado para quaisquer problemas que não sejam registros não encontrados.
Aplica-se a
GetAsync(TKey, RecordRetrievalOptions, CancellationToken)
Obtém um registro do repositório de vetores. Não garante que a coleção exista. Retornará nulo se o registro não for encontrado.
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)Parâmetros
- key
- TKey
A ID exclusiva associada ao registro a ser obtido.
- options
- RecordRetrievalOptions
Opções opcionais para recuperar o registro.
- cancellationToken
- CancellationToken
O CancellationToken para monitorar solicitações de cancelamento. O padrão é None.
Retornos
O registro, se encontrado, caso contrário, nulo.
Exceções
O comando falha ao ser executado por qualquer motivo.
Aplica-se a
GetAsync(Expression<Func<TRecord,Boolean>>, Int32, FilteredRecordRetrievalOptions<TRecord>, CancellationToken)
Obtém registros correspondentes do repositório de vetores. Não garante que a coleção exista.
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)Parâmetros
- filter
- Expression<Func<TRecord,Boolean>>
O predicado para filtrar os registros.
- top
- Int32
O número máximo de resultados a serem detidos.
Opções para recuperar os registros.
- cancellationToken
- CancellationToken
O CancellationToken para monitorar solicitações de cancelamento. O padrão é None.
Retornos
Os registros que correspondem ao predicado fornecido.
Exceções
O comando falha ao ser executado por qualquer motivo.
