Change UpsertAsync return type to IReadOnlyList<TKey>

Closes microsoft#10692

Author: roji

dotnet/samples/Concepts/Memory/VectorStoreEmbeddingGeneration/TextEmbeddingVectorStoreRecordCollection.cs

@@ -2,7 +2,6 @@
 
 using System.Linq.Expressions;
 using System.Reflection;
-using System.Runtime.CompilerServices;
 using Microsoft.Extensions.VectorData;
 using Microsoft.SemanticKernel.Embeddings;
 
@@ -110,15 +109,11 @@ public async Task<TKey> UpsertAsync(TRecord record, CancellationToken cancellati
     }
 
     /// <inheritdoc />
-    public async IAsyncEnumerable<TKey> UpsertAsync(IEnumerable<TRecord> records, [EnumeratorCancellation] CancellationToken cancellationToken = default)
+    public async Task<IReadOnlyList<TKey>> UpsertAsync(IEnumerable<TRecord> records, CancellationToken cancellationToken = default)
     {
         var recordWithEmbeddingsTasks = records.Select(r => this.AddEmbeddingsAsync(r, cancellationToken));
         var recordWithEmbeddings = await Task.WhenAll(recordWithEmbeddingsTasks).ConfigureAwait(false);
-        var upsertResults = this._decoratedVectorStoreRecordCollection.UpsertAsync(recordWithEmbeddings, cancellationToken);
-        await foreach (var upsertResult in upsertResults.ConfigureAwait(false))
-        {
-            yield return upsertResult;
-        }
+        return await this._decoratedVectorStoreRecordCollection.UpsertAsync(recordWithEmbeddings, cancellationToken);
     }
 
     /// <inheritdoc />

dotnet/samples/Concepts/Memory/VectorStore_EmbeddingGeneration.cs

@@ -45,7 +45,7 @@ public async Task UseEmbeddingGenerationViaDecoratorAsync()
         await collection.CreateCollectionIfNotExistsAsync();
 
         // Create and upsert glossary entries into the collection.
-        await collection.UpsertAsync(CreateGlossaryEntries()).ToListAsync();
+        await collection.UpsertAsync(CreateGlossaryEntries());
 
         // Search the collection using a vectorizable text search.
         var search = collection as IVectorizableTextSearch<Glossary>;

dotnet/samples/Concepts/Optimization/FrugalGPTWithFilters.cs

@@ -210,7 +210,7 @@ public async Task OnPromptRenderAsync(PromptRenderContext context, Func<PromptRe
                 var collection = vectorStore.GetCollection<string, ExampleRecord>(CollectionName);
                 await collection.CreateCollectionIfNotExistsAsync(context.CancellationToken);
 
-                await collection.UpsertAsync(exampleRecords, cancellationToken: context.CancellationToken).ToListAsync(context.CancellationToken);
+                await collection.UpsertAsync(exampleRecords, cancellationToken: context.CancellationToken);
 
                 // Generate embedding for original request.
                 var requestEmbedding = await textEmbeddingGenerationService.GenerateEmbeddingAsync(request, cancellationToken: context.CancellationToken);

dotnet/samples/Concepts/Optimization/PluginSelectionWithFilters.cs

@@ -341,7 +341,7 @@ public async Task SaveAsync(string collectionName, KernelPluginCollection plugin
             var collection = vectorStore.GetCollection<string, FunctionRecord>(collectionName);
             await collection.CreateCollectionIfNotExistsAsync(cancellationToken);
 
-            await collection.UpsertAsync(functionRecords, cancellationToken: cancellationToken).ToListAsync(cancellationToken);
+            await collection.UpsertAsync(functionRecords, cancellationToken: cancellationToken);
         }
 
         private static List<(KernelFunction Function, string TextToVectorize)> GetFunctionsData(KernelPluginCollection plugins)

dotnet/samples/Demos/VectorStoreRAG/DataLoader.cs

@@ -66,8 +66,8 @@ public async Task LoadPdf(string pdfPath, int batchSize, int betweenBatchDelayIn
 
             // Upsert the records into the vector store.
             var records = await Task.WhenAll(recordTasks).ConfigureAwait(false);
-            var upsertedKeys = vectorStoreRecordCollection.UpsertAsync(records, cancellationToken: cancellationToken);
-            await foreach (var key in upsertedKeys.ConfigureAwait(false))
+            var upsertedKeys = await vectorStoreRecordCollection.UpsertAsync(records, cancellationToken: cancellationToken).ConfigureAwait(false);
+            foreach (var key in upsertedKeys)
             {
                 Console.WriteLine($"Upserted record '{key}' into VectorDB");
             }

dotnet/src/Connectors/Connectors.AzureAISearch.UnitTests/AzureAISearchVectorStoreRecordCollectionTests.cs

@@ -458,7 +458,7 @@ public async Task CanUpsertManyRecordsAsync(bool useDefinition)
         // Act.
         var actual = await sut.UpsertAsync(
             [model1, model2],
-            cancellationToken: this._testCancellationToken).ToListAsync();
+            cancellationToken: this._testCancellationToken);
 
         // Assert.
         Assert.NotNull(actual);

dotnet/src/Connectors/Connectors.AzureCosmosDBMongoDB.UnitTests/AzureCosmosDBMongoDBVectorStoreRecordCollectionTests.cs

@@ -418,7 +418,7 @@ public async Task UpsertBatchReturnsRecordKeysAsync()
             "collection");
 
         // Act
-        var results = await sut.UpsertAsync([hotel1, hotel2, hotel3]).ToListAsync();
+        var results = await sut.UpsertAsync([hotel1, hotel2, hotel3]);
 
         // Assert
         Assert.NotNull(results);

dotnet/src/Connectors/Connectors.AzureCosmosDBNoSQL.UnitTests/AzureCosmosDBNoSQLVectorStoreRecordCollectionTests.cs

@@ -469,7 +469,7 @@ public async Task UpsertBatchReturnsRecordKeysAsync()
             "collection");
 
         // Act
-        var results = await sut.UpsertAsync([hotel1, hotel2, hotel3]).ToListAsync();
+        var results = await sut.UpsertAsync([hotel1, hotel2, hotel3]);
 
         // Assert
         Assert.NotNull(results);

dotnet/src/Connectors/Connectors.InMemory.UnitTests/InMemoryVectorStoreRecordCollectionTests.cs

@@ -257,7 +257,7 @@ public async Task CanUpsertManyRecordsAsync<TKey>(bool useDefinition, TKey testK
         // Act
         var actual = await sut.UpsertAsync(
             [record1, record2],
-            cancellationToken: this._testCancellationToken).ToListAsync();
+            cancellationToken: this._testCancellationToken);
 
         // Assert
         Assert.NotNull(actual);

dotnet/src/Connectors/Connectors.Memory.AzureAISearch/AzureAISearchVectorStoreRecordCollection.cs

@@ -283,12 +283,12 @@ public async Task<TKey> UpsertAsync(TRecord record, CancellationToken cancellati
     }
 
     /// <inheritdoc />
-    public async IAsyncEnumerable<TKey> UpsertAsync(IEnumerable<TRecord> records, [EnumeratorCancellation] CancellationToken cancellationToken = default)
+    public async Task<IReadOnlyList<TKey>> UpsertAsync(IEnumerable<TRecord> records, CancellationToken cancellationToken = default)
     {
         Verify.NotNull(records);
         if (!records.Any())
         {
-            yield break;
+            return [];
         }
 
         // Create Options
@@ -297,11 +297,7 @@ public async IAsyncEnumerable<TKey> UpsertAsync(IEnumerable<TRecord> records, [E
         // Upsert records
         var results = await this.MapToStorageModelAndUploadDocumentAsync(records, innerOptions, cancellationToken).ConfigureAwait(false);
 
-        // Get results
-        foreach (var key in results.Value.Results.Select(x => x.Key))
-        {
-            yield return (TKey)(object)key;
-        }
+        return results.Value.Results.Select(x => (TKey)(object)x.Key).ToList();
     }
 
     /// <inheritdoc />

dotnet/src/Connectors/Connectors.Memory.AzureCosmosDBMongoDB/AzureCosmosDBMongoDBVectorStoreRecordCollection.cs

@@ -247,20 +247,13 @@ await this._mongoCollection
     }
 
     /// <inheritdoc />
-    public async IAsyncEnumerable<TKey> UpsertAsync(IEnumerable<TRecord> records, [EnumeratorCancellation] CancellationToken cancellationToken = default)
+    public async Task<IReadOnlyList<TKey>> UpsertAsync(IEnumerable<TRecord> records, CancellationToken cancellationToken = default)
     {
         Verify.NotNull(records);
 
         var tasks = records.Select(record => this.UpsertAsync(record, cancellationToken));
         var results = await Task.WhenAll(tasks).ConfigureAwait(false);
-
-        foreach (var result in results)
-        {
-            if (result is not null)
-            {
-                yield return (TKey)(object)result;
-            }
-        }
+        return results.Where(r => r is not null).ToList();
     }
 
     /// <inheritdoc />

dotnet/src/Connectors/Connectors.Memory.AzureCosmosDBNoSQL/AzureCosmosDBNoSQLVectorStoreRecordCollection.cs

@@ -286,22 +286,14 @@ await this.RunOperationAsync(OperationName, () =>
     }
 
     /// <inheritdoc />
-    public async IAsyncEnumerable<TKey> UpsertAsync(IEnumerable<TRecord> records, [EnumeratorCancellation] CancellationToken cancellationToken = default)
+    public async Task<IReadOnlyList<TKey>> UpsertAsync(IEnumerable<TRecord> records, CancellationToken cancellationToken = default)
     {
         Verify.NotNull(records);
 
         // TODO: Do proper bulk upsert rather than parallel single inserts, #11350
         var tasks = records.Select(record => this.UpsertAsync(record, cancellationToken));
-
         var keys = await Task.WhenAll(tasks).ConfigureAwait(false);
-
-        foreach (var key in keys)
-        {
-            if (key is not null)
-            {
-                yield return key;
-            }
-        }
+        return keys.Where(k => k is not null).ToList();
     }
 
     /// <inheritdoc />

dotnet/src/Connectors/Connectors.Memory.InMemory/InMemoryVectorStoreRecordCollection.cs

@@ -232,6 +232,17 @@ public Task DeleteAsync(IEnumerable<TKey> keys, CancellationToken cancellationTo
 
     /// <inheritdoc />
     public Task<TKey> UpsertAsync(TRecord record, CancellationToken cancellationToken = default)
+        => Task.FromResult(this.Upsert(record));
+
+    /// <inheritdoc />
+    public Task<IReadOnlyList<TKey>> UpsertAsync(IEnumerable<TRecord> records, CancellationToken cancellationToken = default)
+    {
+        Verify.NotNull(records);
+
+        return Task.FromResult<IReadOnlyList<TKey>>(records.Select(this.Upsert).ToList());
+    }
+
+    private TKey Upsert(TRecord record)
     {
         Verify.NotNull(record);
 
@@ -240,24 +251,11 @@ public Task<TKey> UpsertAsync(TRecord record, CancellationToken cancellationToke
         var key = (TKey)this._keyResolver(record)!;
         collectionDictionary.AddOrUpdate(key!, record, (key, currentValue) => record);
 
-        return Task.FromResult(key!);
-    }
-
-    /// <inheritdoc />
-    public async IAsyncEnumerable<TKey> UpsertAsync(IEnumerable<TRecord> records, [EnumeratorCancellation] CancellationToken cancellationToken = default)
-    {
-        Verify.NotNull(records);
-
-        foreach (var record in records)
-        {
-            yield return await this.UpsertAsync(record, cancellationToken).ConfigureAwait(false);
-        }
+        return key!;
     }
 
     /// <inheritdoc />
-#pragma warning disable CS1998 // Async method lacks 'await' operators and will run synchronously - Need to satisfy the interface which returns IAsyncEnumerable
-    public async Task<VectorSearchResults<TRecord>> VectorizedSearchAsync<TVector>(TVector vector, int top, VectorSearchOptions<TRecord>? options = null, CancellationToken cancellationToken = default)
-#pragma warning restore CS1998
+    public Task<VectorSearchResults<TRecord>> VectorizedSearchAsync<TVector>(TVector vector, int top, VectorSearchOptions<TRecord>? options = null, CancellationToken cancellationToken = default)
     {
         Verify.NotNull(vector);
         Verify.NotLessThan(top, 1);
@@ -315,7 +313,7 @@ public async Task<VectorSearchResults<TRecord>> VectorizedSearchAsync<TVector>(T
 
         // Build the response.
         var vectorSearchResultList = resultsPage.Select(x => new VectorSearchResult<TRecord>((TRecord)x.record, x.score)).ToAsyncEnumerable();
-        return new VectorSearchResults<TRecord>(vectorSearchResultList) { TotalCount = count };
+        return Task.FromResult(new VectorSearchResults<TRecord>(vectorSearchResultList) { TotalCount = count });
     }
 
     /// <inheritdoc />

dotnet/src/Connectors/Connectors.Memory.MongoDB/MongoDBVectorStoreRecordCollection.cs

@@ -253,20 +253,13 @@ await this._mongoCollection
     }
 
     /// <inheritdoc />
-    public async IAsyncEnumerable<TKey> UpsertAsync(IEnumerable<TRecord> records, [EnumeratorCancellation] CancellationToken cancellationToken = default)
+    public async Task<IReadOnlyList<TKey>> UpsertAsync(IEnumerable<TRecord> records, CancellationToken cancellationToken = default)
     {
         Verify.NotNull(records);
 
         var tasks = records.Select(record => this.UpsertAsync(record, cancellationToken));
         var results = await Task.WhenAll(tasks).ConfigureAwait(false);
-
-        foreach (var result in results)
-        {
-            if (result is not null)
-            {
-                yield return (TKey)(object)result;
-            }
-        }
+        return results.Where(r => r is not null).ToList();
     }
 
     /// <inheritdoc />

dotnet/src/Connectors/Connectors.Memory.Pinecone/PineconeVectorStoreRecordCollection.cs

@@ -303,7 +303,7 @@ await this.RunIndexOperationAsync(
     }
 
     /// <inheritdoc />
-    public async IAsyncEnumerable<TKey> UpsertAsync(IEnumerable<TRecord> records, [EnumeratorCancellation] CancellationToken cancellationToken = default)
+    public async Task<IReadOnlyList<TKey>> UpsertAsync(IEnumerable<TRecord> records, CancellationToken cancellationToken = default)
     {
         Verify.NotNull(records);
 
@@ -316,7 +316,7 @@ public async IAsyncEnumerable<TKey> UpsertAsync(IEnumerable<TRecord> records, [E
 
         if (vectors.Count == 0)
         {
-            yield break;
+            return [];
         }
 
         Sdk.UpsertRequest request = new()
@@ -329,10 +329,7 @@ await this.RunIndexOperationAsync(
             "UpsertBatch",
             indexClient => indexClient.UpsertAsync(request, cancellationToken: cancellationToken)).ConfigureAwait(false);
 
-        foreach (var vector in vectors)
-        {
-            yield return (TKey)(object)vector.Id;
-        }
+        return vectors.Select(x => (TKey)(object)x.Id).ToList();
     }
 
     /// <inheritdoc />

dotnet/src/Connectors/Connectors.Memory.Postgres/PostgresVectorStoreRecordCollection.cs

@@ -156,7 +156,7 @@ public Task<TKey> UpsertAsync(TRecord record, CancellationToken cancellationToke
     }
 
     /// <inheritdoc/>
-    public async IAsyncEnumerable<TKey> UpsertAsync(IEnumerable<TRecord> records, [EnumeratorCancellation] CancellationToken cancellationToken = default)
+    public async Task<IReadOnlyList<TKey>> UpsertAsync(IEnumerable<TRecord> records, CancellationToken cancellationToken = default)
     {
         Verify.NotNull(records);
 
@@ -171,7 +171,7 @@ public async IAsyncEnumerable<TKey> UpsertAsync(IEnumerable<TRecord> records, [E
 
         if (storageModels.Count == 0)
         {
-            yield break;
+            return [];
         }
 
         var keys = storageModels.Select(model => model[this._model.KeyProperty.StorageName]!).ToList();
@@ -180,7 +180,7 @@ await this.RunOperationAsync(OperationName, () =>
             this._client.UpsertBatchAsync(this.CollectionName, storageModels, this._model.KeyProperty.StorageName, cancellationToken)
         ).ConfigureAwait(false);
 
-        foreach (var key in keys) { yield return (TKey)key!; }
+        return keys.Select(key => (TKey)key!).ToList();
     }
 
     /// <inheritdoc/>

dotnet/src/Connectors/Connectors.Memory.Qdrant/QdrantVectorStoreRecordCollection.cs

@@ -454,7 +454,7 @@ await this.RunOperationAsync(
     }
 
     /// <inheritdoc />
-    public async IAsyncEnumerable<TKey> UpsertAsync(IEnumerable<TRecord> records, [EnumeratorCancellation] CancellationToken cancellationToken = default)
+    public async Task<IReadOnlyList<TKey>> UpsertAsync(IEnumerable<TRecord> records, CancellationToken cancellationToken = default)
     {
         Verify.NotNull(records);
 
@@ -471,28 +471,14 @@ await this.RunOperationAsync(
             UpsertName,
             () => this._qdrantClient.UpsertAsync(this._collectionName, pointStructs, true, cancellationToken: cancellationToken)).ConfigureAwait(false);
 
-        if (pointStructs.Count > 0)
-        {
-            switch (pointStructs[0].Id)
+        return pointStructs.Count == 0
+            ? []
+            : pointStructs[0].Id switch
             {
-                case { HasNum: true }:
-                    foreach (var pointStruct in pointStructs)
-                    {
-                        yield return (TKey)(object)pointStruct.Id.Num;
-                    }
-                    break;
-
-                case { HasUuid: true }:
-                    foreach (var pointStruct in pointStructs)
-                    {
-                        yield return (TKey)(object)Guid.Parse(pointStruct.Id.Uuid);
-                    }
-                    break;
-
-                default:
-                    throw new UnreachableException("The Qdrant point ID is neither a number nor a UUID.");
-            }
-        }
+                { HasNum: true } => pointStructs.Select(pointStruct => (TKey)(object)pointStruct.Id.Num).ToList(),
+                { HasUuid: true } => pointStructs.Select(pointStruct => (TKey)(object)Guid.Parse(pointStruct.Id.Uuid)).ToList(),
+                _ => throw new UnreachableException("The Qdrant point ID is neither a number nor a UUID.")
+            };
     }
 
     /// <inheritdoc />

dotnet/src/Connectors/Connectors.Memory.Redis/RedisHashSetVectorStoreRecordCollection.cs

@@ -320,20 +320,14 @@ await this.RunOperationAsync(
     }
 
     /// <inheritdoc />
-    public async IAsyncEnumerable<TKey> UpsertAsync(IEnumerable<TRecord> records, [EnumeratorCancellation] CancellationToken cancellationToken = default)
+    public async Task<IReadOnlyList<TKey>> UpsertAsync(IEnumerable<TRecord> records, CancellationToken cancellationToken = default)
     {
         Verify.NotNull(records);
 
         // Upsert records in parallel.
         var tasks = records.Select(x => this.UpsertAsync(x, cancellationToken));
         var results = await Task.WhenAll(tasks).ConfigureAwait(false);
-        foreach (var result in results)
-        {
-            if (result is not null)
-            {
-                yield return (TKey)(object)result;
-            }
-        }
+        return results.Where(r => r is not null).ToList();
     }
 
     /// <inheritdoc />

dotnet/src/Connectors/Connectors.Memory.Redis/RedisJsonVectorStoreRecordCollection.cs

@@ -375,7 +375,7 @@ await this.RunOperationAsync(
     }
 
     /// <inheritdoc />
-    public async IAsyncEnumerable<TKey> UpsertAsync(IEnumerable<TRecord> records, [EnumeratorCancellation] CancellationToken cancellationToken = default)
+    public async Task<IReadOnlyList<TKey>> UpsertAsync(IEnumerable<TRecord> records, CancellationToken cancellationToken = default)
     {
         Verify.NotNull(records);
 
@@ -407,11 +407,7 @@ await this.RunOperationAsync(
                 .JSON()
                 .MSetAsync(keyPathValues)).ConfigureAwait(false);
 
-        // Return keys of upserted records.
-        foreach (var record in redisRecords)
-        {
-            yield return (TKey)(object)record.originalKey;
-        }
+        return redisRecords.Select(x => (TKey)(object)x.originalKey).ToList();
     }
 
     /// <inheritdoc />