Initial Hybrid Search (FT.HYBRID) bindings #454
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| <Project Sdk="Microsoft.Build.NoTargets/3.3.0"> | ||
| <!-- this is actually here just to serve as a hub for docs, so we don't need to keep editing the sln--> | ||
| <PropertyGroup> | ||
| <TargetFramework>netstandard2.0</TargetFramework> | ||
| <IsPackable>false</IsPackable> | ||
| </PropertyGroup> | ||
| </Project> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| Redis 8.4 is currently in preview and may be subject to change. | ||
|
|
||
| *Hybrid Search* is a new feature in Redis 8.4 that allows you to search across multiple indexes and data types. | ||
|
|
||
| The corresponding library feature must also be considered subject to change: | ||
|
|
||
| 1. Existing bindings may cease working correctly if the underlying server API changes. | ||
| 2. Changes to the server API may require changes to the library API, manifesting in either/both of build-time | ||
| or run-time breaks. | ||
|
|
||
| While this seems *unlikely*, it must be considered a possibility. If you acknowledge this, you can suppress | ||
| this warning by adding the following to your `csproj` file: | ||
|
|
||
| ```xml | ||
| <NoWarn>$(NoWarn);NRS001</NoWarn> | ||
| ``` | ||
|
|
||
| or more granularly / locally in C#: | ||
|
|
||
| ``` c# | ||
| #pragma warning disable NRS001 | ||
| ``` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,5 @@ | ||
| namespace NRedisStack.Core; | ||
|
|
||
| public enum SetInfoAttr | ||
| { | ||
| /// <summary> | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| namespace NRedisStack | ||
| { | ||
| // [Experimental(Experiments.SomeFeature, UrlFormat = Experiments.UrlFormat)] | ||
| // where SomeFeature has the next label, for example "NRS042", and /docs/exp/NRS042.md exists | ||
| internal static class Experiments | ||
| { | ||
| public const string UrlFormat = "https://redis.github.io/NRedisStack/exp/"; | ||
|
|
||
| // ReSharper disable once InconsistentNaming | ||
| public const string Server_8_4 = "NRS001"; | ||
| } | ||
| } | ||
|
|
||
| #if !NET8_0_OR_GREATER | ||
| #pragma warning disable SA1403 | ||
| namespace System.Diagnostics.CodeAnalysis | ||
| #pragma warning restore SA1403 | ||
| { | ||
| [AttributeUsage( | ||
| AttributeTargets.Assembly | | ||
| AttributeTargets.Module | | ||
| AttributeTargets.Class | | ||
| AttributeTargets.Struct | | ||
| AttributeTargets.Enum | | ||
| AttributeTargets.Constructor | | ||
| AttributeTargets.Method | | ||
| AttributeTargets.Property | | ||
| AttributeTargets.Field | | ||
| AttributeTargets.Event | | ||
| AttributeTargets.Interface | | ||
| AttributeTargets.Delegate, | ||
| Inherited = false)] | ||
| internal sealed class ExperimentalAttribute(string diagnosticId) : Attribute | ||
| { | ||
| public string DiagnosticId { get; } = diagnosticId; | ||
| public string? UrlFormat { get; set; } | ||
| public string? Message { get; set; } | ||
| } | ||
| } | ||
| #endif |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| // ReSharper disable once CheckNamespace | ||
| namespace System.Runtime.CompilerServices; | ||
|
|
||
| #if !NET9_0_OR_GREATER | ||
| [AttributeUsage(AttributeTargets.Method, AllowMultiple = false)] | ||
| internal sealed class OverloadResolutionPriorityAttribute(int priority) : Attribute | ||
|
Collaborator
Author
There was a problem hiding this comment. will remove; there was at some point |
||
| { | ||
| public int Priority { get; } = priority; | ||
| } | ||
| #endif | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,13 +1,97 @@ | ||
| NRedisStack.Search.Parameters | ||
| static NRedisStack.Search.Parameters.From<T>(T obj) -> System.Collections.Generic.IReadOnlyDictionary<string!, object!>! | ||
| [NRS001]abstract NRedisStack.Search.VectorData.AsRedisValue() -> StackExchange.Redis.RedisValue | ||
| [NRS001]abstract NRedisStack.Search.VectorData<T>.Dispose() -> void | ||
| [NRS001]abstract NRedisStack.Search.VectorData<T>.Span.get -> System.Span<T> | ||
| [NRS001]const NRedisStack.Search.HybridSearchQuery.Fields.Key = "@__key" -> string! | ||
| [NRS001]const NRedisStack.Search.HybridSearchQuery.Fields.Score = "@__score" -> string! | ||
| [NRS001]NRedisStack.ISearchCommands.HybridSearch(string! indexName, NRedisStack.Search.HybridSearchQuery! query, System.Collections.Generic.IReadOnlyDictionary<string!, object!>? parameters = null) -> NRedisStack.Search.HybridSearchResult! | ||
| [NRS001]NRedisStack.ISearchCommandsAsync.HybridSearchAsync(string! indexName, NRedisStack.Search.HybridSearchQuery! query, System.Collections.Generic.IReadOnlyDictionary<string!, object!>? parameters = null) -> System.Threading.Tasks.Task<NRedisStack.Search.HybridSearchResult!>! | ||
| [NRS001]NRedisStack.Search.ApplyExpression | ||
| [NRS001]NRedisStack.Search.ApplyExpression.Alias.get -> string? | ||
| [NRS001]NRedisStack.Search.ApplyExpression.ApplyExpression() -> void | ||
| [NRS001]NRedisStack.Search.ApplyExpression.ApplyExpression(string! expression, string? alias = null) -> void | ||
| [NRS001]NRedisStack.Search.ApplyExpression.Expression.get -> string! | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.AllowModification() -> NRedisStack.Search.HybridSearchQuery! | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.Apply(NRedisStack.Search.ApplyExpression applyExpression) -> NRedisStack.Search.HybridSearchQuery! | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.Apply(params NRedisStack.Search.ApplyExpression[]! applyExpression) -> NRedisStack.Search.HybridSearchQuery! | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.Combine(NRedisStack.Search.HybridSearchQuery.Combiner! combiner) -> NRedisStack.Search.HybridSearchQuery! | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.Combiner | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.Combiner.Combiner() -> void | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.Fields | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.Filter(string! expression) -> NRedisStack.Search.HybridSearchQuery! | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.GroupBy(params string![]! fields) -> NRedisStack.Search.HybridSearchQuery! | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.GroupBy(string! field) -> NRedisStack.Search.HybridSearchQuery! | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.HybridSearchQuery() -> void | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.Limit(int offset, int count) -> NRedisStack.Search.HybridSearchQuery! | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.NoSort() -> NRedisStack.Search.HybridSearchQuery! | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.Reduce(NRedisStack.Search.Aggregation.Reducer! reducer) -> NRedisStack.Search.HybridSearchQuery! | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.Reduce(params NRedisStack.Search.Aggregation.Reducer![]! reducers) -> NRedisStack.Search.HybridSearchQuery! | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.ReturnFields(params string![]! fields) -> NRedisStack.Search.HybridSearchQuery! | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.ReturnFields(string! field) -> NRedisStack.Search.HybridSearchQuery! | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.Search(NRedisStack.Search.HybridSearchQuery.SearchConfig query) -> NRedisStack.Search.HybridSearchQuery! | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.SearchConfig | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.SearchConfig.Query.get -> string! | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.SearchConfig.ScoreAlias.get -> string? | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.SearchConfig.Scorer.get -> NRedisStack.Search.Scorer? | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.SearchConfig.SearchConfig() -> void | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.SearchConfig.SearchConfig(string! query, NRedisStack.Search.Scorer? scorer = null, string? scoreAlias = null) -> void | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.SearchConfig.WithQuery(string! query) -> NRedisStack.Search.HybridSearchQuery.SearchConfig | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.SearchConfig.WithScoreAlias(string? alias) -> NRedisStack.Search.HybridSearchQuery.SearchConfig | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.SearchConfig.WithScorer(NRedisStack.Search.Scorer? scorer) -> NRedisStack.Search.HybridSearchQuery.SearchConfig | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.SortBy(NRedisStack.Search.Aggregation.SortedField! field) -> NRedisStack.Search.HybridSearchQuery! | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.SortBy(params NRedisStack.Search.Aggregation.SortedField![]! fields) -> NRedisStack.Search.HybridSearchQuery! | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.SortBy(params string![]! fields) -> NRedisStack.Search.HybridSearchQuery! | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.SortBy(string! field) -> NRedisStack.Search.HybridSearchQuery! | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.Timeout(System.TimeSpan timeout) -> NRedisStack.Search.HybridSearchQuery! | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.VectorSearch(NRedisStack.Search.HybridSearchQuery.VectorSearchConfig config) -> NRedisStack.Search.HybridSearchQuery! | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.VectorSearch(string! fieldName, NRedisStack.Search.VectorData! vectorData) -> NRedisStack.Search.HybridSearchQuery! | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.VectorSearchConfig | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.VectorSearchConfig.FieldName.get -> string! | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.VectorSearchConfig.Filter.get -> string? | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.VectorSearchConfig.Method.get -> NRedisStack.Search.VectorSearchMethod? | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.VectorSearchConfig.ScoreAlias.get -> string? | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.VectorSearchConfig.VectorData.get -> NRedisStack.Search.VectorData? | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.VectorSearchConfig.VectorSearchConfig() -> void | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.VectorSearchConfig.VectorSearchConfig(string! fieldName, NRedisStack.Search.VectorData! vectorData, NRedisStack.Search.VectorSearchMethod? method = null, string? filter = null, string? scoreAlias = null) -> void | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.VectorSearchConfig.WithFieldName(string! fieldName) -> NRedisStack.Search.HybridSearchQuery.VectorSearchConfig | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.VectorSearchConfig.WithFilter(string? filter) -> NRedisStack.Search.HybridSearchQuery.VectorSearchConfig | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.VectorSearchConfig.WithMethod(NRedisStack.Search.VectorSearchMethod? method) -> NRedisStack.Search.HybridSearchQuery.VectorSearchConfig | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.VectorSearchConfig.WithScoreAlias(string? scoreAlias) -> NRedisStack.Search.HybridSearchQuery.VectorSearchConfig | ||
| [NRS001]NRedisStack.Search.HybridSearchQuery.VectorSearchConfig.WithVectorData(NRedisStack.Search.VectorData! vectorData) -> NRedisStack.Search.HybridSearchQuery.VectorSearchConfig | ||
| [NRS001]NRedisStack.Search.HybridSearchResult | ||
| [NRS001]NRedisStack.Search.HybridSearchResult.ExecutionTime.get -> System.TimeSpan | ||
| [NRS001]NRedisStack.Search.HybridSearchResult.Results.get -> NRedisStack.Search.Document![]! | ||
| [NRS001]NRedisStack.Search.HybridSearchResult.TotalResults.get -> long | ||
| [NRS001]NRedisStack.Search.Scorer | ||
| [NRS001]NRedisStack.Search.VectorData | ||
| [NRS001]NRedisStack.Search.VectorData<T> | ||
| [NRS001]NRedisStack.Search.VectorSearchMethod | ||
| [NRS001]NRedisStack.SearchCommands.HybridSearch(string! indexName, NRedisStack.Search.HybridSearchQuery! query, System.Collections.Generic.IReadOnlyDictionary<string!, object!>? parameters = null) -> NRedisStack.Search.HybridSearchResult! | ||
| [NRS001]NRedisStack.SearchCommandsAsync.HybridSearchAsync(string! indexName, NRedisStack.Search.HybridSearchQuery! query, System.Collections.Generic.IReadOnlyDictionary<string!, object!>? parameters = null) -> System.Threading.Tasks.Task<NRedisStack.Search.HybridSearchResult!>! | ||
| [NRS001]override NRedisStack.Search.ApplyExpression.Equals(object? obj) -> bool | ||
| [NRS001]override NRedisStack.Search.ApplyExpression.GetHashCode() -> int | ||
| [NRS001]override NRedisStack.Search.ApplyExpression.ToString() -> string! | ||
| [NRS001]override NRedisStack.Search.HybridSearchQuery.Combiner.ToString() -> string! | ||
| [NRS001]override NRedisStack.Search.Scorer.ToString() -> string! | ||
| [NRS001]override NRedisStack.Search.VectorData.ToString() -> string! | ||
| [NRS001]override NRedisStack.Search.VectorSearchMethod.ToString() -> string! | ||
| [NRS001]static NRedisStack.Search.ApplyExpression.implicit operator NRedisStack.Search.ApplyExpression(string! expression) -> NRedisStack.Search.ApplyExpression | ||
| [NRS001]static NRedisStack.Search.HybridSearchQuery.Combiner.Linear(double alpha = 0.3, double beta = 0.7) -> NRedisStack.Search.HybridSearchQuery.Combiner! | ||
| [NRS001]static NRedisStack.Search.HybridSearchQuery.Combiner.ReciprocalRankFusion(int? window = null, double? constant = null) -> NRedisStack.Search.HybridSearchQuery.Combiner! | ||
| [NRS001]static NRedisStack.Search.HybridSearchQuery.SearchConfig.implicit operator NRedisStack.Search.HybridSearchQuery.SearchConfig(string! query) -> NRedisStack.Search.HybridSearchQuery.SearchConfig | ||
| [NRS001]static NRedisStack.Search.Scorer.BM25Std.get -> NRedisStack.Search.Scorer! | ||
| [NRS001]static NRedisStack.Search.Scorer.BM25StdNorm.get -> NRedisStack.Search.Scorer! | ||
| [NRS001]static NRedisStack.Search.Scorer.DisMax.get -> NRedisStack.Search.Scorer! | ||
| [NRS001]static NRedisStack.Search.Scorer.DocScore.get -> NRedisStack.Search.Scorer! | ||
| [NRS001]static NRedisStack.Search.Scorer.Hamming.get -> NRedisStack.Search.Scorer! | ||
| [NRS001]static NRedisStack.Search.Scorer.TfIdf.get -> NRedisStack.Search.Scorer! | ||
| [NRS001]static NRedisStack.Search.Scorer.TfIdfDocNorm.get -> NRedisStack.Search.Scorer! | ||
| [NRS001]static NRedisStack.Search.VectorData.implicit operator NRedisStack.Search.VectorData!(string! name) -> NRedisStack.Search.VectorData! | ||
| [NRS001]static NRedisStack.Search.VectorData.Lease<T>(int dimension) -> NRedisStack.Search.VectorData<T>! | ||
| [NRS001]static NRedisStack.Search.VectorData.LeaseWithValues<T>(params System.ReadOnlySpan<T> values) -> NRedisStack.Search.VectorData<T>! | ||
| [NRS001]static NRedisStack.Search.VectorData.Parameter(string! name) -> NRedisStack.Search.VectorData! | ||
| [NRS001]static NRedisStack.Search.VectorData.Raw(System.ReadOnlyMemory<byte> bytes) -> NRedisStack.Search.VectorData! | ||
| [NRS001]static NRedisStack.Search.VectorSearchMethod.NearestNeighbour(int count = 10, int? maxCandidates = null) -> NRedisStack.Search.VectorSearchMethod! | ||
| [NRS001]static NRedisStack.Search.VectorSearchMethod.Range(double radius, double? epsilon = null) -> NRedisStack.Search.VectorSearchMethod! |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
needs small change with wording.