Implement embedders, vector search and similar documents

.env

@@ -1,3 +1,3 @@
-MEILISEARCH_VERSION=v1.9.0
+MEILISEARCH_VERSION=v1.13
 PROXIED_MEILISEARCH=http://nginx/api/
 MEILISEARCH_URL=http://meilisearch:7700

src/Meilisearch/Converters/EmbedderSourceConverter.cs

@@ -0,0 +1,51 @@
+using System;
+using System.Text.Json;
+using System.Text.Json.Serialization;
+
+namespace Meilisearch.Converters
+{
+    internal class EmbedderSourceConverter : JsonConverter<EmbedderSource>
+    {
+        public override EmbedderSource Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
+        {
+            if (reader.TokenType == JsonTokenType.String)
+            {
+                var enumValue = reader.GetString();
+                if (Enum.TryParse<EmbedderSource>(enumValue, true, out var embedderSource))
+                {
+                    return embedderSource;
+                }
+            }
+
+            return EmbedderSource.Unknown;
+        }
+
+        public override void Write(Utf8JsonWriter writer, EmbedderSource value, JsonSerializerOptions options)
+        {
+            string source;
+            switch (value)
+            {
+                case EmbedderSource.OpenAi:
+                    source = "openAi";
+                    break;
+                case EmbedderSource.HuggingFace:
+                    source = "huggingFace";
+                    break;
+                case EmbedderSource.Ollama:
+                    source = "ollama";
+                    break;
+                case EmbedderSource.Rest:
+                    source = "rest";
+                    break;
+                case EmbedderSource.UserProvided:
+                    source = "userProvided";
+                    break;
+                case EmbedderSource.Unknown:
+                default:
+                    throw new ArgumentOutOfRangeException(nameof(value), value, null);
+            }
+
+            writer.WriteStringValue(source);
+        }
+    }
+}

src/Meilisearch/Embedder.cs

@@ -0,0 +1,84 @@
+using System;
+using System.Collections.Generic;
+using System.Text.Json.Serialization;
+
+namespace Meilisearch
+{
+    /// <summary>
+    /// Embedder configuration.
+    /// </summary>
+    public class Embedder
+    {
+        /// <summary>
+        /// Gets or sets the source.
+        /// </summary>
+        [JsonPropertyName("source")]
+        public EmbedderSource Source { get; set; }
+
+        /// <summary>
+        /// Gets or sets the URL.
+        /// </summary>
+        [JsonPropertyName("url")]
+        public string Url { get; set; }
+
+        /// <summary>
+        /// Gets or sets the API key.
+        /// </summary>
+        [JsonPropertyName("apiKey")]
+        public string ApiKey { get; set; }
+
+        /// <summary>
+        /// Gets or sets the model.
+        /// </summary>
+        [JsonPropertyName("model")]
+        public string Model { get; set; }
+
+        /// <summary>
+        /// Gets or sets the document template.
+        /// </summary>
+        [JsonPropertyName("documentTemplate")]
+        public string DocumentTemplate { get; set; }
+
+        /// <summary>
+        /// Gets or sets the document template max bytes.
+        /// </summary>
+        [JsonPropertyName("documentTemplateMaxBytes")]
+        public int? DocumentTemplateMaxBytes { get; set; }
+
+        /// <summary>
+        /// Gets or sets the dimensions.
+        /// </summary>
+        [JsonPropertyName("dimensions")]
+        public int? Dimensions { get; set; }
+
+        /// <summary>
+        /// Gets or sets the revision.
+        /// </summary>
+        [JsonPropertyName("revision")]
+        public string Revision { get; set; }
+
+        /// <summary>
+        /// Gets or sets the distribution.
+        /// </summary>
+        [JsonPropertyName("distribution")]
+        public EmbedderDistribution Distribution { get; set; }
+
+        /// <summary>
+        /// Gets or sets the request.
+        /// </summary>
+        [JsonPropertyName("request")]
+        public Dictionary<string, object> Request { get; set; }
+
+        /// <summary>
+        /// Gets or sets the response.
+        /// </summary>
+        [JsonPropertyName("response")]
+        public Dictionary<string, object> Response { get; set; }
+
+        /// <summary>
+        /// Gets or sets whether the vectors should be compressed.
+        /// </summary>
+        [JsonPropertyName("binaryQuantized")]
+        public bool? BinaryQuantized { get; set; }
+    }
+}

src/Meilisearch/EmbedderDistribution.cs

@@ -0,0 +1,48 @@
+using System;
+using System.Text.Json.Serialization;
+
+namespace Meilisearch
+{
+    /// <summary>
+    /// Embedder distribution.
+    /// </summary>
+    public class EmbedderDistribution
+    {
+        /// <summary>
+        /// Creates a new instance of <see cref="EmbedderDistribution"/>.
+        /// </summary>
+        /// <param name="mean">Mean value between 0 and 1.</param>
+        /// <param name="sigma">Sigma value between 0 and 1.</param>
+        /// <exception cref="ArgumentOutOfRangeException"></exception>
+        public EmbedderDistribution(double mean, double sigma)
+        {
+            if (mean < 0 || mean > 1)
+            {
+                throw new ArgumentOutOfRangeException(nameof(mean), "Mean must be between 0 and 1.");
+            }
+
+            if (sigma < 0 || sigma > 1)
+            {
+                throw new ArgumentOutOfRangeException(nameof(sigma), "Sigma must be between 0 and 1.");
+            }
+        }
+
+        /// <summary>
+        /// Gets or sets the mean.
+        /// </summary>
+        [JsonPropertyName("mean")]
+        public double Mean { get; set; }
+
+        /// <summary>
+        /// Gets or sets the sigma.
+        /// </summary>
+        [JsonPropertyName("sigma")]
+        public double Sigma { get; set; }
+
+        /// <summary>
+        /// Creates a new instance of <see cref="EmbedderDistribution"/> with a uniform distribution.
+        /// </summary>
+        /// <returns></returns>
+        public static EmbedderDistribution Uniform() => new EmbedderDistribution(0.5, 0.5);
+    }
+}

src/Meilisearch/EmbedderSource.cs

@@ -0,0 +1,43 @@
+using System.Text.Json.Serialization;
+
+using Meilisearch.Converters;
+
+namespace Meilisearch
+{
+    /// <summary>
+    /// Embedder source.
+    /// </summary>
+    [JsonConverter(typeof(EmbedderSourceConverter))]
+    public enum EmbedderSource
+    {
+        /// <summary>
+        /// OpenAI
+        /// </summary>
+        OpenAi,
+
+        /// <summary>
+        /// Hugging Face
+        /// </summary>
+        HuggingFace,
+
+        /// <summary>
+        /// Ollama
+        /// </summary>
+        Ollama,
+
+        /// <summary>
+        /// REST
+        /// </summary>
+        Rest,
+
+        /// <summary>
+        /// User-provided
+        /// </summary>
+        UserProvided,
+
+        /// <summary>
+        /// Unknown
+        /// </summary>
+        Unknown
+    }
+}

src/Meilisearch/HybridSearch.cs

@@ -0,0 +1,19 @@
+using System.Text.Json.Serialization;
+
+namespace Meilisearch
+{
+    public class HybridSearch
+    {
+        /// <summary>
+        /// Gets or sets the embedder.
+        /// </summary>
+        [JsonPropertyName("embedder")]
+        public string Embedder { get; set; }
+
+        /// <summary>
+        /// Gets or sets the semantic ratio.
+        /// </summary>
+        [JsonPropertyName("semanticRatio")]
+        public double SemanticRatio { get; set; }
+    }
+}

src/Meilisearch/Index.Embedders.cs

@@ -0,0 +1,63 @@
+using System.Collections.Generic;
+using System.Net.Http.Json;
+using System.Threading;
+using System.Threading.Tasks;
+
+using Meilisearch.Extensions;
+
+namespace Meilisearch
+{
+    public partial class Index
+    {
+        /// <summary>
+        /// Gets the embedders setting.
+        /// </summary>
+        /// <param name="cancellationToken">The cancellation token for this call.</param>
+        /// <returns>Returns the embedders setting.</returns>
+        public async Task<Dictionary<string, Embedder>> GetEmbeddersAsync(CancellationToken cancellationToken = default)
+        {
+            return await _http
+                .GetFromJsonAsync<Dictionary<string, Embedder>>(
+                    $"indexes/{Uid}/settings/embedders",
+                    cancellationToken: cancellationToken)
+                .ConfigureAwait(false);
+        }
+
+        /// <summary>
+        /// Updates the embedders setting.
+        /// </summary>
+        /// <param name="embedders">Collection of embedders.</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> UpdateEmbeddersAsync(Dictionary<string, Embedder> embedders, CancellationToken cancellationToken = default)
+        {
+            var responseMessage =
+                await _http.PatchAsJsonAsync(
+                        $"indexes/{Uid}/settings/embedders",
+                        embedders,
+                        Constants.JsonSerializerOptionsRemoveNulls,
+                        cancellationToken: cancellationToken)
+                    .ConfigureAwait(false);
+
+            return await responseMessage.Content
+                .ReadFromJsonAsync<TaskInfo>(cancellationToken: cancellationToken)
+                .ConfigureAwait(false);
+        }
+
+        /// <summary>
+        /// Resets the embedders setting.
+        /// </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> ResetEmbeddersAsync(CancellationToken cancellationToken = default)
+        {
+            var response = await _http
+                .DeleteAsync($"indexes/{Uid}/settings/embedders", cancellationToken)
+                .ConfigureAwait(false);
+
+            return await response.Content
+                .ReadFromJsonAsync<TaskInfo>(cancellationToken: cancellationToken)
+                .ConfigureAwait(false);
+        }
+    }
+}

src/Meilisearch/Index.SimilarDocuments.cs

@@ -0,0 +1,33 @@
+using System.Net.Http.Json;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace Meilisearch
+{
+    public partial class Index
+    {
+        /// <summary>
+        /// Search for similar documents.
+        /// </summary>
+        /// <param name="query">The query to search for similar documents.</param>
+        /// <param name="cancellationToken">The cancellation token for this call.</param>
+        /// <typeparam name="T">The type of the documents to return.</typeparam>
+        /// <returns>Returns the similar documents.</returns>
+        public async Task<SimilarDocumentsResult<T>> SearchSimilarDocumentsAsync<T>(
+            SimilarDocumentsQuery query,
+            CancellationToken cancellationToken = default)
+        {
+            var responseMessage = await _http
+                .PostAsJsonAsync(
+                    $"indexes/{Uid}/similar",
+                    query,
+                    Constants.JsonSerializerOptionsRemoveNulls,
+                    cancellationToken: cancellationToken)
+                .ConfigureAwait(false);
+
+            return await responseMessage.Content
+                .ReadFromJsonAsync<SimilarDocumentsResult<T>>(cancellationToken: cancellationToken)
+                .ConfigureAwait(false);
+        }
+    }
+}

src/Meilisearch/Meilisearch.csproj

@@ -68,5 +68,26 @@
         <Compile Update="Index.SearchCutoffMs.cs">
             <DependentUpon>Index.cs</DependentUpon>
         </Compile>
+        <Compile Update="Index.Faceting.cs">
+          <DependentUpon>Index.cs</DependentUpon>
+        </Compile>
+        <Compile Update="Index.NonSeparatorTokens.cs">
+          <DependentUpon>Index.cs</DependentUpon>
+        </Compile>
+        <Compile Update="Index.Pagination.cs">
+          <DependentUpon>Index.cs</DependentUpon>
+        </Compile>
+        <Compile Update="Index.ProximityPrecision.cs">
+          <DependentUpon>Index.cs</DependentUpon>
+        </Compile>
+        <Compile Update="Index.SeparatorTokens.cs">
+          <DependentUpon>Index.cs</DependentUpon>
+        </Compile>
+        <Compile Update="Index.Embedders.cs">
+          <DependentUpon>Index.cs</DependentUpon>
+        </Compile>
+        <Compile Update="Index.SimilarDocuments.cs">
+          <DependentUpon>Index.cs</DependentUpon>
+        </Compile>
     </ItemGroup>
 </Project>