Skip to content

Commit 26036f2

Browse files
shacharPashshacharPash
authored
Add FieldName signature to VectorField (#104)
* add FieldName signature to VectorField * Add AddVectorField signature that get FieldName * add VSS example test https://github.com/Redislabs-Solution-Architects/Specialist-Solution-Workshops/blob/main/Real-Time-Query-Workshop/cli/lab5/README.md#vss * fix test * check only vec:2
1 parent ef71516 commit 26036f2

File tree

4 files changed

+116
-6
lines changed

4 files changed

+116
-6
lines changed

‎src/NRedisStack/Search/Query.cs

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ public HighlightTags(string open, string close)
180180
/// <summary>
181181
/// Set the query parameter to sort by ASC by default
182182
/// </summary>
183-
public bool SortAscending { get; set; } = true;
183+
public bool? SortAscending { get; set; } = null;
184184

185185
// highlight and summarize
186186
internal bool _wantsHighlight = false, _wantsSummarize = false;
@@ -260,7 +260,8 @@ internal void SerializeRedisArgs(List<object> args)
260260
{
261261
args.Add("SORTBY");
262262
args.Add(SortBy);
263-
args.Add((SortAscending ? "ASC" : "DESC"));
263+
if (SortAscending != null)
264+
args.Add(((bool)SortAscending ? "ASC" : "DESC"));
264265
}
265266
if (Payload != null)
266267
{
@@ -605,7 +606,7 @@ public Query SummarizeFields(int contextLen, int fragmentCount, string separator
605606
/// <param name="field">the sorting field's name</param>
606607
/// <param name="ascending">if set to true, the sorting order is ascending, else descending</param>
607608
/// <returns>the query object itself</returns>
608-
public Query SetSortBy(string field, bool ascending = true)
609+
public Query SetSortBy(string field, bool? ascending = null)
609610
{
610611
SortBy = field;
611612
SortAscending = ascending;

‎src/NRedisStack/Search/Schema.cs

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,13 +209,16 @@ public enum VectorAlgo
209209

210210
public VectorAlgo Algorithm { get; }
211211
public Dictionary<string, object>? Attributes { get; }
212-
public VectorField(string name, VectorAlgo algorithm, Dictionary<string, object>? attributes = null)
212+
public VectorField(FieldName name, VectorAlgo algorithm, Dictionary<string, object>? attributes = null)
213213
: base(name, FieldType.Vector)
214214
{
215215
Algorithm = algorithm;
216216
Attributes = attributes;
217217
}
218218

219+
public VectorField(string name, VectorAlgo algorithm, Dictionary<string, object>? attributes = null)
220+
: this(FieldName.Of(name), algorithm, attributes) { }
221+
219222
internal override void AddFieldTypeArgs(List<object> args)
220223
{
221224
args.Add(Algorithm.ToString());
@@ -376,6 +379,19 @@ public Schema AddTagField(string name, bool sortable = false, bool unf = false,
376379
return this;
377380
}
378381

382+
/// <summary>
383+
/// Add a Vector field to the schema.
384+
/// </summary>
385+
/// <param name="name">The field's name.</param>
386+
/// <param name="algorithm">The vector similarity algorithm to use.</param>
387+
/// <param name="attribute">The algorithm attributes for the creation of the vector index.</param>
388+
/// <returns>The <see cref="Schema"/> object.</returns>
389+
public Schema AddVectorField(FieldName name, VectorAlgo algorithm, Dictionary<string, object>? attributes = null)
390+
{
391+
Fields.Add(new VectorField(name, algorithm, attributes));
392+
return this;
393+
}
394+
379395
/// <summary>
380396
/// Add a Vector field to the schema.
381397
/// </summary>

‎src/NRedisStack/Search/SearchResult.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ public class SearchResult
1515
/// <summary>
1616
/// Converts the documents to a list of json strings. only works on a json documents index.
1717
/// </summary>
18-
public IEnumerable<string>? ToJson() => Documents.Select(x => x["json"].ToString())
19-
.Where(x => !string.IsNullOrEmpty(x));
18+
public List<string>? ToJson() => Documents.Select(x => x["json"].ToString())
19+
.Where(x => !string.IsNullOrEmpty(x)).ToList();
2020

2121
internal SearchResult(RedisResult[] resp, bool hasContent, bool hasScores, bool hasPayloads/*, bool shouldExplainScore*/)
2222
{

‎tests/NRedisStack.Tests/Search/SearchTests.cs

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
using static NRedisStack.Search.Schema;
77
using NRedisStack.Search.Aggregation;
88
using NRedisStack.Search.Literals.Enums;
9+
using System.Runtime.InteropServices;
910

1011
namespace NRedisStack.Tests.Search;
1112

@@ -1920,6 +1921,98 @@ public async Task TestVectorCount_Issue70()
19201921
Assert.Equal(expected.Count(), actual.Args.Length);
19211922
}
19221923

1924+
[Fact]
1925+
public void VectorSimilaritySearch()
1926+
{
1927+
IDatabase db = redisFixture.Redis.GetDatabase();
1928+
db.Execute("FLUSHALL");
1929+
var ft = db.FT();
1930+
var json = db.JSON();
1931+
1932+
json.Set("vec:1", "$", "{\"vector\":[1,1,1,1]}");
1933+
json.Set("vec:2", "$", "{\"vector\":[2,2,2,2]}");
1934+
json.Set("vec:3", "$", "{\"vector\":[3,3,3,3]}");
1935+
json.Set("vec:4", "$", "{\"vector\":[4,4,4,4]}");
1936+
1937+
var schema = new Schema().AddVectorField(FieldName.Of("$.vector").As("vector"), Schema.VectorField.VectorAlgo.FLAT, new Dictionary<string, object>()
1938+
{
1939+
["TYPE"] = "FLOAT32",
1940+
["DIM"] = "4",
1941+
["DISTANCE_METRIC"] = "L2",
1942+
});
1943+
1944+
var idxDef = new FTCreateParams().On(IndexDataType.JSON).Prefix("vec:");
1945+
Assert.True(ft.Create("vss_idx", idxDef, schema));
1946+
1947+
float[] vec = new float[] { 2, 2, 2, 2 };
1948+
byte[] queryVec = MemoryMarshal.Cast<float, byte>(vec).ToArray();
1949+
1950+
1951+
var query = new Query("*=>[KNN 3 @vector $query_vec]")
1952+
.AddParam("query_vec", queryVec)
1953+
.SetSortBy("__vector_score")
1954+
.Dialect(2);
1955+
var res = ft.Search("vss_idx", query);
1956+
1957+
Assert.Equal(3, res.TotalResults);
1958+
1959+
Assert.Equal("vec:2", res.Documents[0].Id.ToString());
1960+
1961+
Assert.Equal(0, res.Documents[0]["__vector_score"]);
1962+
1963+
var jsonRes = res.ToJson();
1964+
Assert.Equal("{\"vector\":[2,2,2,2]}", jsonRes![0]);
1965+
}
1966+
1967+
[Fact]
1968+
public void QueryingVectorFields()
1969+
{
1970+
IDatabase db = redisFixture.Redis.GetDatabase();
1971+
db.Execute("FLUSHALL");
1972+
var ft = db.FT();
1973+
var json = db.JSON();
1974+
1975+
var schema = new Schema().AddVectorField("v", Schema.VectorField.VectorAlgo.HNSW, new Dictionary<string, object>()
1976+
{
1977+
["TYPE"] = "FLOAT32",
1978+
["DIM"] = "2",
1979+
["DISTANCE_METRIC"] = "L2",
1980+
});
1981+
1982+
ft.Create("idx", new FTCreateParams(), schema);
1983+
1984+
db.HashSet("a", "v", "aaaaaaaa");
1985+
db.HashSet("b", "v", "aaaabaaa");
1986+
db.HashSet("c", "v", "aaaaabaa");
1987+
1988+
var q = new Query("*=>[KNN 2 @v $vec]").ReturnFields("__v_score").Dialect(2);
1989+
var res = ft.Search("idx", q.AddParam("vec", "aaaaaaaa"));
1990+
Assert.Equal(2, res.TotalResults);
1991+
}
1992+
1993+
[Fact]
1994+
public async Task TestVectorFieldJson_Issue102Async()
1995+
{
1996+
IDatabase db = redisFixture.Redis.GetDatabase();
1997+
db.Execute("FLUSHALL");
1998+
var ft = db.FT();
1999+
var json = db.JSON();
2000+
2001+
// JSON.SET 1 $ '{"vec":[1,2,3,4]}'
2002+
await json.SetAsync("1", "$", "{\"vec\":[1,2,3,4]}");
2003+
2004+
// FT.CREATE my_index ON JSON SCHEMA $.vec as vector VECTOR FLAT 6 TYPE FLOAT32 DIM 4 DISTANCE_METRIC L2
2005+
var schema = new Schema().AddVectorField(FieldName.Of("$.vec").As("vector"), Schema.VectorField.VectorAlgo.FLAT, new Dictionary<string, object>()
2006+
{
2007+
["TYPE"] = "FLOAT32",
2008+
["DIM"] = "4",
2009+
["DISTANCE_METRIC"] = "L2",
2010+
});
2011+
2012+
Assert.True(await ft.CreateAsync("my_index", new FTCreateParams().On(IndexDataType.JSON), schema));
2013+
2014+
}
2015+
19232016
[Fact]
19242017
public void TestModulePrefixs1()
19252018
{

0 commit comments

Comments
 (0)