fix code examples for merge

danFbach · danFbach · commit 700e0539bacf · 2024-12-03T15:37:10.000-06:00
diff --git a/src/Meilisearch/Index.Dictionary.cs b/src/Meilisearch/Index.Dictionary.cs
@@ -0,0 +1,46 @@
+using System.Collections.Generic;
+using System.Net.Http.Json;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace Meilisearch
+{
+    public partial class Index
+    {
+        /// <summary>
+        /// Gets the dictionary of an index.
+        /// </summary>
+        /// <param name="cancellationToken">The cancellation token for this call.</param>
+        /// <returns>Returns the dictionary.</returns>
+        public async Task<IEnumerable<string>> GetDictionaryAsync(CancellationToken cancellationToken = default)
+        {
+            return await _http.GetFromJsonAsync<string[]>($"indexes/{Uid}/settings/dictionary", cancellationToken: cancellationToken)
+                .ConfigureAwait(false);
+        }
+
+        /// <summary>
+        /// Updates the dictionary of an index.
+        /// </summary>
+        /// <param name="dictionary">Dictionary object.</param>
+        /// <param name="cancellationToken">The cancellation token for this call.</param>
+        /// <returns>Returns the task info of the asynchronous task.</returns>
+        public async Task<TaskInfo> UpdateDictionaryAsync(IEnumerable<string> dictionary, CancellationToken cancellationToken = default)
+        {
+            var responseMessage =
+                await _http.PutAsJsonAsync($"indexes/{Uid}/settings/dictionary", dictionary, cancellationToken: cancellationToken)
+                    .ConfigureAwait(false);
+            return await responseMessage.Content.ReadFromJsonAsync<TaskInfo>(cancellationToken: cancellationToken).ConfigureAwait(false);
+        }
+
+        /// <summary>
+        /// Resets the dictionary to their default values.
+        /// </summary>
+        /// <param name="cancellationToken">The cancellation token for this call.</param>
+        /// <returns>Returns the task info of the asynchronous task.</returns>
+        public async Task<TaskInfo> ResetDictionaryAsync(CancellationToken cancellationToken = default)
+        {
+            var httpResponse = await _http.DeleteAsync($"indexes/{Uid}/settings/dictionary", cancellationToken).ConfigureAwait(false);
+            return await httpResponse.Content.ReadFromJsonAsync<TaskInfo>(cancellationToken: cancellationToken).ConfigureAwait(false);
+        }
+    }
+}
diff --git a/src/Meilisearch/Meilisearch.csproj b/src/Meilisearch/Meilisearch.csproj
@@ -4,7 +4,7 @@
         <TargetFramework>netstandard2.0</TargetFramework>
         <OutputType>Library</OutputType>
         <PackageId>MeiliSearch</PackageId>
-        <Version>0.15.3</Version>
+        <Version>0.15.5</Version>
         <Description>.NET wrapper for Meilisearch, an open-source search engine</Description>
         <RepositoryUrl>https://github.com/meilisearch/meilisearch-dotnet</RepositoryUrl>
         <PackageTags>meilisearch;dotnet;sdk;search-engine;search;instant-search</PackageTags>
@@ -22,7 +22,7 @@
 
     <ItemGroup>
       <PackageReference Include="System.IdentityModel.Tokens.Jwt" Version="7.6.2" />
-      <PackageReference Include="System.Net.Http.Json" Version="6.0.0" />
+      <PackageReference Include="System.Net.Http.Json" Version="6.0.2" />
     </ItemGroup>
 
     <ItemGroup>
@@ -39,6 +39,9 @@
       <Compile Update="Index.Documents.cs">
         <DependentUpon>Index.cs</DependentUpon>
       </Compile>
+      <Compile Update="Index.Dictionary.cs">
+        <DependentUpon>Index.cs</DependentUpon>
+      </Compile>
       <Compile Update="Index.Tasks.cs">
         <DependentUpon>Index.cs</DependentUpon>
       </Compile>
diff --git a/src/Meilisearch/SearchQuery.cs b/src/Meilisearch/SearchQuery.cs
@@ -142,5 +142,11 @@ public class SearchQuery
         /// </summary>
         [JsonPropertyName("distinct")]
         public string Distinct { get; set; }
+
+        /// <summary>
+        /// Gets or sets rankingScoreThreshold, a number between 0.0 and 1.0. 
+        /// </summary>
+        [JsonPropertyName("rankingScoreThreshold")]
+        public decimal RankingScoreThreshold { get; set; }
     }
 }
diff --git a/src/Meilisearch/Settings.cs b/src/Meilisearch/Settings.cs
@@ -86,6 +86,12 @@ public class Settings
         [JsonPropertyName("pagination")]
         public Pagination Pagination { get; set; }
 
+        /// <summary>
+        /// Gets or sets the dictionary object.
+        /// </summary>
+        [JsonPropertyName("dictionary")]
+        public IEnumerable<string> Dictionary { get; set; }
+
         /// <summary>
         /// Gets or sets the proximity precision attribute.
         /// </summary>
diff --git a/tests/Meilisearch.Tests/IndexFixture.cs b/tests/Meilisearch.Tests/IndexFixture.cs
@@ -124,6 +124,7 @@ public async Task<Index> SetUpIndexForNestedSearch(string indexUid)
 
             return index;
         }
+
         public async Task<Index> SetUpIndexForDistinctProductsSearch(string indexUid)
         {
             var index = DefaultClient.Index(indexUid);
@@ -156,6 +157,22 @@ public async Task<Index> SetUpIndexForDistinctProductsSearch(string indexUid)
             return index;
         }
 
+        public async Task<Index> SetUpIndexForRankingScoreThreshold(string indexUid)
+        {
+            var index = DefaultClient.Index(indexUid);
+            var movies = await JsonFileReader.ReadAsync<List<MovieWithInfo>>(Datasets.MoviesWithInfoJsonPath);
+            var task = await index.AddDocumentsAsync(movies);
+
+            // Check the documents have been added
+            var finishedTask = await index.WaitForTaskAsync(task.TaskUid);
+            if (finishedTask.Status != TaskInfoStatus.Succeeded)
+            {
+                throw new Exception("The documents were not added during SetUpIndexForRankingScoreThreshold. Impossible to run the tests.");
+            }
+
+            return index;
+        }
+
         public async Task DeleteAllIndexes()
         {
             var indexes = await DefaultClient.GetAllIndexesAsync();
diff --git a/tests/Meilisearch.Tests/Meilisearch.Tests.csproj b/tests/Meilisearch.Tests/Meilisearch.Tests.csproj
@@ -7,8 +7,8 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <PackageReference Include="FluentAssertions" Version="6.12.1" />
-        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
+        <PackageReference Include="FluentAssertions" Version="7.0.0" />
+        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.12.0" />
         <PackageReference Include="xunit" Version="2.7.0" />
         <PackageReference Include="xunit.runner.visualstudio" Version="2.8.2" />
     </ItemGroup>
diff --git a/tests/Meilisearch.Tests/SearchTests.cs b/tests/Meilisearch.Tests/SearchTests.cs
@@ -14,6 +14,7 @@ public abstract class SearchTests<TFixture> : IAsyncLifetime where TFixture : In
         private Index _indexForFaceting;
         private Index _indexWithIntId;
         private Index _productIndexForDistinct;
+        private Index _indexForRankingScoreThreshold;
 
         private readonly TFixture _fixture;
 
@@ -30,6 +31,7 @@ public async Task InitializeAsync()
             _indexWithIntId = await _fixture.SetUpBasicIndexWithIntId("IndexWithIntId-SearchTests");
             _nestedIndex = await _fixture.SetUpIndexForNestedSearch("IndexForNestedDocs-SearchTests");
             _productIndexForDistinct = await _fixture.SetUpIndexForDistinctProductsSearch("IndexForDistinctProducts-SearchTests");
+            _indexForRankingScoreThreshold = await _fixture.SetUpIndexForRankingScoreThreshold("IndexForRankingThreshold-SearchTests");
         }
 
         public Task DisposeAsync() => Task.CompletedTask;
@@ -527,6 +529,7 @@ public async Task CustomSearchProductsWithoutDistinct()
             var products = await _productIndexForDistinct.SearchAsync<Product>("", searchQuery);
             products.Hits.Count.Should().Be(14);
         }
+
         [Fact]
         public async Task CustomSearchProductsWithDistinct()
         {
@@ -537,5 +540,19 @@ public async Task CustomSearchProductsWithDistinct()
             var products = await _productIndexForDistinct.SearchAsync<Product>("", searchQuery);
             products.Hits.Count.Should().Be(6);
         }
+
+        [Fact]
+        public async Task CustomSearchWithRankingScoreThreshold()
+        {
+            var searchQuery = new SearchQuery { };
+            var movies = await _indexForRankingScoreThreshold.SearchAsync<MovieWithInfo>("a wizard movie", searchQuery);
+            movies.Hits.Count.Should().Be(4);
+
+            searchQuery.RankingScoreThreshold = 0.5M;
+            movies = await _indexForRankingScoreThreshold.SearchAsync<MovieWithInfo>("a wizard movie", searchQuery);
+            movies.Hits.Count.Should().Be(1);
+            movies.Hits.First().Id.Should().Be("13");
+            movies.Hits.First().Name.Should().Be("Harry Potter");
+        }
     }
 }
diff --git a/tests/Meilisearch.Tests/SettingsTests.cs b/tests/Meilisearch.Tests/SettingsTests.cs
@@ -34,6 +34,7 @@ public SettingsTests(TFixture fixture)
                 DistinctAttribute = null,
                 SearchableAttributes = new string[] { "*" },
                 DisplayedAttributes = new string[] { "*" },
+                Dictionary = new string[] { },
                 StopWords = new string[] { },
                 SeparatorTokens = new List<string> { },
                 NonSeparatorTokens = new List<string> { },
@@ -95,6 +96,7 @@ public async Task UpdateSettings()
                 SearchableAttributes = new string[] { "name", "genre" },
                 StopWords = new string[] { "of", "the" },
                 DistinctAttribute = "name",
+                Dictionary = new string[] { "dictionary" }
             };
             await AssertUpdateSuccess(_index.UpdateSettingsAsync, newSettings);
             await AssertGetInequality(_index.GetSettingsAsync, newSettings); // fields omitted in newSettings shouldn't have changed
@@ -114,6 +116,7 @@ public async Task TwoStepUpdateSettings()
                     { "hp", new string[] { "harry potter" } },
                     { "harry potter", new string[] { "hp" } },
                 },
+                Dictionary = new string[] { "dictionary" }
             };
             await AssertUpdateSuccess(_index.UpdateSettingsAsync, newSettingsOne);
 
@@ -143,7 +146,8 @@ public async Task ResetSettings()
                 DistinctAttribute = "name",
                 DisplayedAttributes = new string[] { "name" },
                 RankingRules = new string[] { "typo" },
-                FilterableAttributes = new string[] { "genre" }
+                FilterableAttributes = new string[] { "genre" },
+                Dictionary = new string[] { "dictionary" }
             };
             await AssertUpdateSuccess(_index.UpdateSettingsAsync, newSettings);
             await AssertGetInequality(_index.GetSettingsAsync, newSettings); // fields omitted in newSettings shouldn't have changed
@@ -603,11 +607,37 @@ public async Task ResetProximityPrecision()
             await AssertUpdateSuccess(_index.UpdateProximityPrecisionAsync, newPrecision);
             await AssertGetEquality(_index.GetProximityPrecisionAsync, newPrecision);
 
-            await AssertResetSuccess(_index.ResetProximityPrecisionAsync
-            );
+            await AssertResetSuccess(_index.ResetProximityPrecisionAsync);
             await AssertGetEquality(_index.GetProximityPrecisionAsync, _defaultSettings.ProximityPrecision);
         }
 
+        [Fact]
+        public async Task GetDictionaryAsync()
+        {
+            await AssertGetEquality(_index.GetDictionaryAsync, _defaultSettings.Dictionary);
+        }
+
+        [Fact]
+        public async Task UpdateDictionaryAsync()
+        {
+            var newDictionary = new string[] { "W. E. B.", "W.E.B." };
+
+            await AssertUpdateSuccess(_index.UpdateDictionaryAsync, newDictionary);
+            await AssertGetEquality(_index.GetDictionaryAsync, newDictionary);
+        }
+
+        [Fact]
+        public async Task ResetDictionaryAsync()
+        {
+            var newDictionary = new string[] { "W. E. B.", "W.E.B." };
+
+            await AssertUpdateSuccess(_index.UpdateDictionaryAsync, newDictionary);
+            await AssertGetEquality(_index.GetDictionaryAsync, newDictionary);
+
+            await AssertResetSuccess(_index.ResetDictionaryAsync);
+            await AssertGetEquality(_index.GetDictionaryAsync, _defaultSettings.Dictionary);
+        }
+
         private static Settings SettingsWithDefaultedNullFields(Settings inputSettings, Settings defaultSettings)
         {
             return new Settings
@@ -625,7 +655,8 @@ private static Settings SettingsWithDefaultedNullFields(Settings inputSettings,
                 TypoTolerance = inputSettings.TypoTolerance ?? defaultSettings.TypoTolerance,
                 Faceting = inputSettings.Faceting ?? defaultSettings.Faceting,
                 Pagination = inputSettings.Pagination ?? defaultSettings.Pagination,
-                ProximityPrecision = inputSettings.ProximityPrecision ?? defaultSettings.ProximityPrecision
+                ProximityPrecision = inputSettings.ProximityPrecision ?? defaultSettings.ProximityPrecision,
+                Dictionary = inputSettings.Dictionary ?? defaultSettings.Dictionary,
             };
         }
 

Original file line number	Diff line number	Diff line change
`@@ -142,5 +142,11 @@ public class SearchQuery`
`142`	`142`	`/// </summary>`
`143`	`143`	`[JsonPropertyName("distinct")]`
`144`	`144`	`public string Distinct { get; set; }`
	`145`	`+`
	`146`	`+ /// <summary>`
	`147`	`+ /// Gets or sets rankingScoreThreshold, a number between 0.0 and 1.0.`
	`148`	`+ /// </summary>`
	`149`	`+ [JsonPropertyName("rankingScoreThreshold")]`
	`150`	`+ public decimal RankingScoreThreshold { get; set; }`
`145`	`151`	`}`
`146`	`152`	`}`