From 705021caa58944ae045ed2d6bec7382ddbc9c6a6 Mon Sep 17 00:00:00 2001 From: Nate Anderson Date: Tue, 31 Oct 2023 15:11:06 -0700 Subject: [PATCH] Fix doc errors --- src/Momento.Sdk/IPreviewVectorIndexClient.cs | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/src/Momento.Sdk/IPreviewVectorIndexClient.cs b/src/Momento.Sdk/IPreviewVectorIndexClient.cs index ba19a019..c7c7b9b9 100644 --- a/src/Momento.Sdk/IPreviewVectorIndexClient.cs +++ b/src/Momento.Sdk/IPreviewVectorIndexClient.cs @@ -110,7 +110,7 @@ public interface IPreviewVectorIndexClient : IDisposable /// If an item with the same ID already exists in the index, it will be replaced. /// Otherwise, it will be added to the index. /// - /// The name of the vector index to delete. + /// The name of the vector index to upsert the items into. /// The items to upsert into the index. /// /// Task representing the result of the upsert operation. The @@ -133,9 +133,9 @@ public Task UpsertItemBatchAsync(string indexName, IEnumerable items); /// - /// Deletes all items with the given IDs from the index. + /// Deletes all items with the given IDs from the index. Returns success if for items that do not exist. /// - /// The name of the vector index to delete. + /// The name of the vector index to delete the items from. /// The IDs of the items to delete from the index. /// /// Task representing the result of the upsert operation. The @@ -161,7 +161,7 @@ public Task UpsertItemBatchAsync(string indexName, /// Ranks the vectors according to the similarity metric specified when the /// index was created. /// - /// The name of the vector index to delete. + /// The name of the vector index to search in. /// The vector to search for. /// The number of results to return. Defaults to 10. /// A list of metadata fields to return with each result. @@ -170,13 +170,13 @@ public Task UpsertItemBatchAsync(string indexName, /// response object is resolved to a type-safe object of one of /// the following subtypes: /// - /// DeleteItemBatchResponse.Success - /// DeleteItemBatchResponse.Error + /// SearchResponse.Success + /// SearchResponse.Error /// /// Pattern matching can be used to operate on the appropriate subtype. /// For example: /// - /// if (response is DeleteItemBatchResponse.Error errorResponse) + /// if (response is SearchResponse.Error errorResponse) /// { /// // handle error as appropriate /// }