VectorStoreCollection<TKey,TRecord>.GetAsync Método
Definição
Importante
Algumas informações dizem respeito a um produto pré-lançado que pode ser substancialmente modificado antes de ser lançado. A Microsoft não faz garantias, de forma expressa ou implícita, em relação à informação aqui apresentada.
Obtém registos correspondentes da loja vetorial. Não garante que a coleção exista.
Sobrecargas
| Name | Descrição |
|---|---|
| GetAsync(IEnumerable<TKey>, RecordRetrievalOptions, CancellationToken) |
Obtém um lote de registos do vector store. Não garante que a coleção exista. |
| GetAsync(TKey, RecordRetrievalOptions, CancellationToken) |
Obtém um registo da loja vetorial. Não garante que a coleção exista. Retorna nulo se o registo não for encontrado. |
| GetAsync(Expression<Func<TRecord,Boolean>>, Int32, FilteredRecordRetrievalOptions<TRecord>, CancellationToken) |
Obtém registos correspondentes da loja vetorial. Não garante que a coleção exista. |
GetAsync(IEnumerable<TKey>, RecordRetrievalOptions, CancellationToken)
- Origem:
- VectorStoreCollection.cs
Obtém um lote de registos do vector store. 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>
Os IDs únicos associados ao registo para obter.
- options
- RecordRetrievalOptions
Opções opcionais para recuperar os registos.
- cancellationToken
- CancellationToken
O CancellationToken para monitorizar pedidos de cancelamento. A predefinição é None.
Devoluções
Os registos associados às chaves únicas especificadas.
Exceções
O comando falha em executar por qualquer motivo.
Observações
O método exato de recuperação é específico da implementação e pode variar consoante o suporte da base de dados. A implementação padrão deste método recupera os registos um após o outro, mas implementações que suportam batching podem sobrepor para proporcionar uma implementação mais eficiente.
Apenas os registos encontrados são devolvidos, pelo que o conjunto de resultados pode ser menor do que as chaves solicitadas.
Este método lança para quaisquer problemas que não sejam encontrados registos.
Aplica-se a
GetAsync(TKey, RecordRetrievalOptions, CancellationToken)
- Origem:
- VectorStoreCollection.cs
Obtém um registo da loja vetorial. Não garante que a coleção exista. Retorna nulo se o registo 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
O ID único associado ao registo para obter.
- options
- RecordRetrievalOptions
Opções opcionais para recuperar o registo.
- cancellationToken
- CancellationToken
O CancellationToken para monitorizar pedidos de cancelamento. A predefinição é None.
Devoluções
O registo se encontrado, caso contrário é nulo.
Exceções
O comando falha em executar por qualquer motivo.
Aplica-se a
GetAsync(Expression<Func<TRecord,Boolean>>, Int32, FilteredRecordRetrievalOptions<TRecord>, CancellationToken)
- Origem:
- VectorStoreCollection.cs
Obtém registos correspondentes da loja vetorial. 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 registos.
- top
- Int32
O número máximo de resultados a serem retornados.
Opções para recuperar os registos.
- cancellationToken
- CancellationToken
O CancellationToken para monitorizar pedidos de cancelamento. A predefinição é None.
Devoluções
Os registos que correspondem ao predicado dado.
Exceções
O comando falha em executar por qualquer motivo.