Skip to content

Commit

Permalink
support tft.explainscore command
Browse files Browse the repository at this point in the history
  • Loading branch information
@lyq2333 @yangbodong22011
lyq2333 authored and yangbodong22011 committed Nov 22, 2023
1 parent 0c5820b commit 8963454
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 9 deletions.
1 change: 1 addition & 0 deletions tair/taircommands.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ type TairCmdable interface {
TftAnalyzer(ctx context.Context, analyzerName string, text string) *redis.StringCmd
TftAnalyzerWithArgs(ctx context.Context, analyzerName string, text string, a *TftAnalyzerArgs) *redis.StringCmd
TftExplaincost(ctx context.Context, index string, request string) *redis.StringCmd
TftExplainscore(ctx context.Context, index string, request string, docId ...string) *redis.StringCmd
TftAddSug(ctx context.Context, index string, textWeight map[string]int64) *redis.IntCmd
TftDelSug(ctx context.Context, index string, text ...string) *redis.IntCmd
TftSugSum(ctx context.Context, index string) *redis.IntCmd
Expand Down
13 changes: 13 additions & 0 deletions tair/tairsearch.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -420,6 +420,19 @@ func (tc tairCmdable) TftExplaincost(ctx context.Context, index string, request
return cmd
}

func (tc tairCmdable) TftExplainscore(ctx context.Context, index string, request string, docId ...string) *redis.StringCmd {
a := make([]interface{}, 3)
a[0] = "TFT.EXPLAINSCORE"
a[1] = index
a[2] = request
for _, id := range docId {
a = append(a, id)
}
cmd := redis.NewStringCmd(ctx, a...)
_ = tc(ctx, cmd)
return cmd
}

func (tc tairCmdable) TftAddSug(ctx context.Context, index string, textWeight map[string]int64) *redis.IntCmd {
args := make([]interface{}, 2)
args[0] = "TFT.ADDSUG"
Expand Down
42 changes: 33 additions & 9 deletions tair/tairsearch_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import (
"github.com/go-redis/redis/v8"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/suite"
"regexp"
"testing"
)

Expand Down Expand Up @@ -71,11 +72,13 @@ func (suite *TairSearchTestSuite) TestTftAddDoc() {

result1, err1 := suite.tairClient.TftSearch(ctx, "tftkey", "{\"query\":{\"match\":{\"f1\":\"3\"}}}").Result()
assert.NoError(suite.T(), err1)
assert.Equal(suite.T(), result1, "{\"hits\":{\"hits\":[{\"_id\":\"1\",\"_index\":\"tftkey\",\"_score\":1.49608,\"_source\":{\"f0\":\"v0\",\"f1\":\"3\"}},{\"_id\":\"2\",\"_index\":\"tftkey\",\"_score\":1.49608,\"_source\":{\"f0\":\"v1\",\"f1\":\"3\"}},{\"_id\":\"3\",\"_index\":\"tftkey\",\"_score\":1.49608,\"_source\":{\"f0\":\"v3\",\"f1\":\"3\"}}],\"max_score\":1.49608,\"total\":{\"relation\":\"eq\",\"value\":3}}}")

reg := regexp.MustCompile("((\"(max)?_?score|\\{\"value)\"):\\d+(\\.\\d+)?")
res := reg.ReplaceAllString(result1, "$1:0")
assert.Equal(suite.T(), "{\"hits\":{\"hits\":[{\"_id\":\"1\",\"_index\":\"tftkey\",\"_score\":0,\"_source\":{\"f0\":\"v0\",\"f1\":\"3\"}},{\"_id\":\"2\",\"_index\":\"tftkey\",\"_score\":0,\"_source\":{\"f0\":\"v1\",\"f1\":\"3\"}},{\"_id\":\"3\",\"_index\":\"tftkey\",\"_score\":0,\"_source\":{\"f0\":\"v3\",\"f1\":\"3\"}}],\"max_score\":0,\"total\":{\"relation\":\"eq\",\"value\":3}}}", res)
result, err := suite.tairClient.TftSearchUseCache(ctx, "tftkey", "{\"query\":{\"match\":{\"f1\":\"3\"}}}", true).Result()
assert.NoError(suite.T(), err)
assert.Equal(suite.T(), result, "{\"hits\":{\"hits\":[{\"_id\":\"1\",\"_index\":\"tftkey\",\"_score\":1.49608,\"_source\":{\"f0\":\"v0\",\"f1\":\"3\"}},{\"_id\":\"2\",\"_index\":\"tftkey\",\"_score\":1.49608,\"_source\":{\"f0\":\"v1\",\"f1\":\"3\"}},{\"_id\":\"3\",\"_index\":\"tftkey\",\"_score\":1.49608,\"_source\":{\"f0\":\"v3\",\"f1\":\"3\"}}],\"max_score\":1.49608,\"total\":{\"relation\":\"eq\",\"value\":3}}}")
res = reg.ReplaceAllString(result, "$1:0")
assert.Equal(suite.T(), "{\"hits\":{\"hits\":[{\"_id\":\"1\",\"_index\":\"tftkey\",\"_score\":0,\"_source\":{\"f0\":\"v0\",\"f1\":\"3\"}},{\"_id\":\"2\",\"_index\":\"tftkey\",\"_score\":0,\"_source\":{\"f0\":\"v1\",\"f1\":\"3\"}},{\"_id\":\"3\",\"_index\":\"tftkey\",\"_score\":0,\"_source\":{\"f0\":\"v3\",\"f1\":\"3\"}}],\"max_score\":0,\"total\":{\"relation\":\"eq\",\"value\":3}}}", res)

result2, err2 := suite.tairClient.TftGetDoc(ctx, "tftkey", "3").Result()
assert.NoError(suite.T(), err2)
Expand Down Expand Up @@ -113,8 +116,9 @@ func (suite *TairSearchTestSuite) TestTftMSearch() {

result1, err1 := suite.tairClient.TftMSearch(ctx, 3, "{\"query\":{\"match\":{\"f1\":\"3\"}}}", "tftkey1", "tftkey2", "tftkey3").Result()
assert.NoError(suite.T(), err1)
assert.Equal(suite.T(), result1, "{\"hits\":{\"hits\":[{\"_id\":\"1\",\"_index\":\"tftkey1\",\"_score\":1.0,\"_source\":{\"f0\":\"v0\",\"f1\":\"3\"}},{\"_id\":\"2\",\"_index\":\"tftkey2\",\"_score\":1.0,\"_source\":{\"f0\":\"v1\",\"f1\":\"3\"}},{\"_id\":\"3\",\"_index\":\"tftkey3\",\"_score\":0.094159,\"_source\":{\"f0\":\"v3\",\"f1\":\"3\"}}],\"max_score\":1.0,\"total\":{\"relation\":\"eq\",\"value\":3}},\"aux_info\":{\"index_crc64\":52600736426816810}}")

reg := regexp.MustCompile("((\"(max)?_?score|\\{\"value)\"):\\d+(\\.\\d+)?")
res := reg.ReplaceAllString(result1, "$1:0")
assert.Equal(suite.T(), "{\"hits\":{\"hits\":[{\"_id\":\"1\",\"_index\":\"tftkey1\",\"_score\":0,\"_source\":{\"f0\":\"v0\",\"f1\":\"3\"}},{\"_id\":\"2\",\"_index\":\"tftkey2\",\"_score\":0,\"_source\":{\"f0\":\"v1\",\"f1\":\"3\"}},{\"_id\":\"3\",\"_index\":\"tftkey3\",\"_score\":0,\"_source\":{\"f0\":\"v3\",\"f1\":\"3\"}}],\"max_score\":0,\"total\":{\"relation\":\"eq\",\"value\":3}},\"aux_info\":{\"index_crc64\":52600736426816810}}", res)
}

func (suite *TairSearchTestSuite) TestTftUpdateDocField() {
Expand All @@ -126,7 +130,10 @@ func (suite *TairSearchTestSuite) TestTftUpdateDocField() {

result2, err2 := suite.tairClient.TftSearch(ctx, "tftkey", "{\"query\":{\"term\":{\"f0\":\"redis\"}}}").Result()
assert.NoError(suite.T(), err2)
assert.Equal(suite.T(), result2, "{\"hits\":{\"hits\":[{\"_id\":\"1\",\"_index\":\"tftkey\",\"_score\":0.054363,\"_source\":{\"f0\":\"redis is a nosql database\"}}],\"max_score\":0.054363,\"total\":{\"relation\":\"eq\",\"value\":1}}}")

reg := regexp.MustCompile("((\"(max)?_?score|\\{\"value)\"):\\d+(\\.\\d+)?")
res := reg.ReplaceAllString(result2, "$1:0")
assert.Equal(suite.T(), "{\"hits\":{\"hits\":[{\"_id\":\"1\",\"_index\":\"tftkey\",\"_score\":0,\"_source\":{\"f0\":\"redis is a nosql database\"}}],\"max_score\":0,\"total\":{\"relation\":\"eq\",\"value\":1}}}", res)

result3, err3 := suite.tairClient.TftUpdateIndex(ctx, "tftkey", "{\"mappings\":{\"properties\":{\"f1\":{\"type\":\"text\"}}}}").Result()
assert.NoError(suite.T(), err3)
Expand All @@ -135,8 +142,20 @@ func (suite *TairSearchTestSuite) TestTftUpdateDocField() {
suite.tairClient.TftUpdateDocField(ctx, "tftkey", "1", "{\"f1\":\"mysql is a dbms\"}")
result4, err4 := suite.tairClient.TftSearch(ctx, "tftkey", "{\"query\":{\"term\":{\"f1\":\"mysql\"}}}").Result()
assert.NoError(suite.T(), err4)
assert.Equal(suite.T(), result4, "{\"hits\":{\"hits\":[{\"_id\":\"1\",\"_index\":\"tftkey\",\"_score\":0.06658,\"_source\":{\"f1\":\"mysql is a dbms\",\"f0\":\"redis is a nosql database\"}}],\"max_score\":0.06658,\"total\":{\"relation\":\"eq\",\"value\":1}}}")

res = reg.ReplaceAllString(result4, "$1:0")
assert.Equal(suite.T(), "{\"hits\":{\"hits\":[{\"_id\":\"1\",\"_index\":\"tftkey\",\"_score\":0,\"_source\":{\"f1\":\"mysql is a dbms\",\"f0\":\"redis is a nosql database\"}}],\"max_score\":0,\"total\":{\"relation\":\"eq\",\"value\":1}}}", res)

result5, err5 := suite.tairClient.TftExplainscore(ctx, "tftkey", "{\"query\":{\"term\":{\"f1\":\"mysql\"}}}").Result()
assert.NoError(suite.T(), err5)
reg = regexp.MustCompile("((\"(max)?_?score|\\{\"value)\"):\\d+(\\.\\d+)?")
res = reg.ReplaceAllString(result5, "$1:0")
assert.Equal(suite.T(), "{\"hits\":{\"hits\":[{\"_id\":\"1\",\"_index\":\"tftkey\",\"_score\":0,\"_source\":{\"f1\":\"mysql is a dbms\",\"f0\":\"redis is a nosql database\"},\"_explanation\":{\"score\":0,\"description\":\"score, computed as query_boost * idf * idf * tf\",\"field\":\"f1\",\"term\":\"mysql\",\"query_boost\":1.0,\"details\":[{\"value\":0,\"description\":\"idf, computed as 1 + log(N / (n + 1))\",\"details\":[{\"value\":0,\"description\":\"n, number of documents containing term\"},{\"value\":0,\"description\":\"N, total number of documents\"}]},{\"value\":0,\"description\":\"tf, computed as sqrt(freq) / sqrt(dl)\",\"details\":[{\"value\":0,\"description\":\"freq, occurrences of term within document\"},{\"value\":0,\"description\":\"dl, length of field\"}]}]}}],\"max_score\":0,\"total\":{\"relation\":\"eq\",\"value\":1}}}", res)

result6, err6 := suite.tairClient.TftExplainscore(ctx, "tftkey", "{\"query\":{\"term\":{\"f1\":\"mysql\"}}}", "0", "1", "2").Result()
assert.NoError(suite.T(), err6)
res = reg.ReplaceAllString(result6, "$1:0")
assert.Equal(suite.T(), "{\"hits\":{\"hits\":[{\"_id\":\"1\",\"_index\":\"tftkey\",\"_score\":0,\"_source\":{\"f1\":\"mysql is a dbms\",\"f0\":\"redis is a nosql database\"},\"_explanation\":{\"score\":0,\"description\":\"score, computed as query_boost * idf * idf * tf\",\"field\":\"f1\",\"term\":\"mysql\",\"query_boost\":1.0,\"details\":[{\"value\":0,\"description\":\"idf, computed as 1 + log(N / (n + 1))\",\"details\":[{\"value\":0,\"description\":\"n, number of documents containing term\"},{\"value\":0,\"description\":\"N, total number of documents\"}]},{\"value\":0,\"description\":\"tf, computed as sqrt(freq) / sqrt(dl)\",\"details\":[{\"value\":0,\"description\":\"freq, occurrences of term within document\"},{\"value\":0,\"description\":\"dl, length of field\"}]}]}}],\"max_score\":0,\"total\":{\"relation\":\"eq\",\"value\":1}}}", res)
}

func (suite *TairSearchTestSuite) TestTftIncrLongDocField() {
Expand Down Expand Up @@ -392,8 +411,10 @@ func (suite *TairSearchTestSuite) TestTftUnicode() {
suite.tairClient.TftAddDocWithId(ctx, "tftkey", "{\"f0\":\"夏天是一个很热的季节\"}", "1")
r3, e3 := suite.tairClient.TftSearch(ctx, "tftkey", "{\"query\":{\"match\":{\"f0\":\"夏天冬天\"}}}").Result()
assert.NoError(suite.T(), e3)
assert.Equal(suite.T(), r3, "{\"hits\":{\"hits\":[{\"_id\":\"1\",\"_index\":\"tftkey\",\"_score\":0.089327,\"_source\":{\"f0\":\"夏天是一个很热的季节\"}}],\"max_score\":0.089327,\"total\":{\"relation\":\"eq\",\"value\":1}}}")

reg := regexp.MustCompile("((\"(max)?_?score|\\{\"value)\"):\\d+(\\.\\d+)?")
res := reg.ReplaceAllString(r3, "$1:0")
assert.Equal(suite.T(), "{\"hits\":{\"hits\":[{\"_id\":\"1\",\"_index\":\"tftkey\",\"_score\":0,\"_source\":{\"f0\":\"夏天是一个很热的季节\"}}],\"max_score\":0,\"total\":{\"relation\":\"eq\",\"value\":1}}}", res)
}

func (suite *TairSearchTestSuite) TestTftMAddTestString() {
Expand All @@ -409,7 +430,10 @@ func (suite *TairSearchTestSuite) TestTftMAddTestString() {

r, e := suite.tairClient.TftSearch(ctx, "tftkey", "{\"query\":{\"match\":{\"f1\":\"3\"}}}").Result()
assert.NoError(suite.T(), e)
assert.Equal(suite.T(), r, "{\"hits\":{\"hits\":[{\"_id\":\"1\",\"_index\":\"tftkey\",\"_score\":1.49608,\"_source\":{\"f0\":\"v0\",\"f1\":\"3\"}},{\"_id\":\"2\",\"_index\":\"tftkey\",\"_score\":1.49608,\"_source\":{\"f0\":\"v1\",\"f1\":\"3\"}},{\"_id\":\"3\",\"_index\":\"tftkey\",\"_score\":1.49608,\"_source\":{\"f0\":\"v3\",\"f1\":\"3\"}}],\"max_score\":1.49608,\"total\":{\"relation\":\"eq\",\"value\":3}}}")

reg := regexp.MustCompile("((\"(max)?_?score|\\{\"value)\"):\\d+(\\.\\d+)?")
res := reg.ReplaceAllString(r, "$1:0")
assert.Equal(suite.T(), "{\"hits\":{\"hits\":[{\"_id\":\"1\",\"_index\":\"tftkey\",\"_score\":0,\"_source\":{\"f0\":\"v0\",\"f1\":\"3\"}},{\"_id\":\"2\",\"_index\":\"tftkey\",\"_score\":0,\"_source\":{\"f0\":\"v1\",\"f1\":\"3\"}},{\"_id\":\"3\",\"_index\":\"tftkey\",\"_score\":0,\"_source\":{\"f0\":\"v3\",\"f1\":\"3\"}}],\"max_score\":0,\"total\":{\"relation\":\"eq\",\"value\":3}}}", res)

r1, e1 := suite.tairClient.TftGetDoc(ctx, "tftkey", "3").Result()
assert.NoError(suite.T(), e1)
Expand Down

0 comments on commit 8963454

Please sign in to comment.