Skip to content

Commit

Permalink
Fix doc errors
Browse files Browse the repository at this point in the history
  • Loading branch information
nand4011 committed Oct 31, 2023
1 parent bb410f3 commit 705021c
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions src/Momento.Sdk/IPreviewVectorIndexClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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.
/// </summary>
/// <param name="indexName">The name of the vector index to delete.</param>
/// <param name="indexName">The name of the vector index to upsert the items into.</param>
/// <param name="items">The items to upsert into the index.</param>
/// <returns>
/// Task representing the result of the upsert operation. The
Expand All @@ -133,9 +133,9 @@ public Task<UpsertItemBatchResponse> UpsertItemBatchAsync(string indexName,
IEnumerable<Item> items);

/// <summary>
/// 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.
/// </summary>
/// <param name="indexName">The name of the vector index to delete.</param>
/// <param name="indexName">The name of the vector index to delete the items from.</param>
/// <param name="ids">The IDs of the items to delete from the index.</param>
/// <returns>
/// Task representing the result of the upsert operation. The
Expand All @@ -161,7 +161,7 @@ public Task<UpsertItemBatchResponse> UpsertItemBatchAsync(string indexName,
/// Ranks the vectors according to the similarity metric specified when the
/// index was created.
/// </summary>
/// <param name="indexName">The name of the vector index to delete.</param>
/// <param name="indexName">The name of the vector index to search in.</param>
/// <param name="queryVector">The vector to search for.</param>
/// <param name="topK">The number of results to return. Defaults to 10.</param>
/// <param name="metadataFields">A list of metadata fields to return with each result.</param>
Expand All @@ -170,13 +170,13 @@ public Task<UpsertItemBatchResponse> UpsertItemBatchAsync(string indexName,
/// response object is resolved to a type-safe object of one of
/// the following subtypes:
/// <list type="bullet">
/// <item><description>DeleteItemBatchResponse.Success</description></item>
/// <item><description>DeleteItemBatchResponse.Error</description></item>
/// <item><description>SearchResponse.Success</description></item>
/// <item><description>SearchResponse.Error</description></item>
/// </list>
/// Pattern matching can be used to operate on the appropriate subtype.
/// For example:
/// <code>
/// if (response is DeleteItemBatchResponse.Error errorResponse)
/// if (response is SearchResponse.Error errorResponse)
/// {
/// // handle error as appropriate
/// }
Expand Down

0 comments on commit 705021c

Please sign in to comment.