Debian Codegraph @

suggester_context.go

raw
1 // Copyright 2012-present Oliver Eilhard. All rights reserved.
2 // Use of this source code is governed by a MIT-license.
3 // See http://olivere.mit-license.org/license.txt for details.
4
5 package elastic
6
7 import "errors"
8
9 // SuggesterContextQuery is used to define context information within
10 // a suggestion request.
11 type SuggesterContextQuery interface {
12 Source() (interface{}, error)
13 }
14
15 // ContextSuggester is a fast suggester for e.g. type-ahead completion that supports filtering and boosting based on contexts.
16 // See https://www.elastic.co/guide/en/elasticsearch/reference/current/suggester-context.html
17 // for more details.
18 type ContextSuggester struct {
19 Suggester
20 name string
21 prefix string
22 field string
23 size *int
24 contextQueries []SuggesterContextQuery
25 }
26
27 // Creates a new context suggester.
28 func NewContextSuggester(name string) *ContextSuggester {
29 return &ContextSuggester{
30 name: name,
31 contextQueries: make([]SuggesterContextQuery, 0),
32 }
33 }
34
35 func (q *ContextSuggester) Name() string {
36 return q.name
37 }
38
39 func (q *ContextSuggester) Prefix(prefix string) *ContextSuggester {
40 q.prefix = prefix
41 return q
42 }
43
44 func (q *ContextSuggester) Field(field string) *ContextSuggester {
45 q.field = field
46 return q
47 }
48
49 func (q *ContextSuggester) Size(size int) *ContextSuggester {
50 q.size = &size
51 return q
52 }
53
54 func (q *ContextSuggester) ContextQuery(query SuggesterContextQuery) *ContextSuggester {
55 q.contextQueries = append(q.contextQueries, query)
56 return q
57 }
58
59 func (q *ContextSuggester) ContextQueries(queries ...SuggesterContextQuery) *ContextSuggester {
60 q.contextQueries = append(q.contextQueries, queries...)
61 return q
62 }
63
64 // contextSuggesterRequest is necessary because the order in which
65 // the JSON elements are routed to Elasticsearch is relevant.
66 // We got into trouble when using plain maps because the text element
67 // needs to go before the completion element.
68 type contextSuggesterRequest struct {
69 Prefix string `json:"prefix"`
70 Completion interface{} `json:"completion"`
71 }
72
73 // Creates the source for the context suggester.
74 func (q *ContextSuggester) Source(includeName bool) (interface{}, error) {
75 cs := &contextSuggesterRequest{}
76
77 if q.prefix != "" {
78 cs.Prefix = q.prefix
79 }
80
81 suggester := make(map[string]interface{})
82 cs.Completion = suggester
83
84 if q.field != "" {
85 suggester["field"] = q.field
86 }
87 if q.size != nil {
88 suggester["size"] = *q.size
89 }
90 switch len(q.contextQueries) {
91 case 0:
92 case 1:
93 src, err := q.contextQueries[0].Source()
94 if err != nil {
95 return nil, err
96 }
97 suggester["context"] = src
98 default:
99 ctxq := make(map[string]interface{})
100 for _, query := range q.contextQueries {
101 src, err := query.Source()
102 if err != nil {
103 return nil, err
104 }
105 // Merge the dictionary into ctxq
106 m, ok := src.(map[string]interface{})
107 if !ok {
108 return nil, errors.New("elastic: context query is not a map")
109 }
110 for k, v := range m {
111 ctxq[k] = v
112 }
113 }
114 suggester["contexts"] = ctxq
115 }
116
117 if !includeName {
118 return cs, nil
119 }
120
121 source := make(map[string]interface{})
122 source[q.name] = cs
123 return source, nil
124 }