File: suggestion.html

package info (click to toggle)
groonga 11.0.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 121,576 kB
  • sloc: ansic: 801,209; javascript: 62,121; ruby: 46,206; cpp: 33,790; xml: 24,951; yacc: 13,333; sh: 7,776; python: 3,266; makefile: 2,315; perl: 133
file content (296 lines) | stat: -rw-r--r-- 12,449 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296


<!DOCTYPE html>

<html lang="en">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>7.20.4. Suggestion &#8212; Groonga v10.1.1-31-g1e46ba6 documentation</title>
    <link rel="stylesheet" href="../../_static/groonga.css" type="text/css" />
    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
    
    <script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
    <script src="../../_static/jquery.js"></script>
    <script src="../../_static/underscore.js"></script>
    <script src="../../_static/doctools.js"></script>
    <script src="../../_static/language_data.js"></script>
    
    <link rel="shortcut icon" href="../../_static/favicon.ico"/>
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="7.21. Indexing" href="../indexing.html" />
    <link rel="prev" title="7.20.3. Correction" href="correction.html" /> 
  </head><body>
<div class="header">
  <h1 class="title">
    <a id="top-link" href="../../index.html">
      <span class="project">groonga</span>
      <span class="separator">-</span>
      <span class="description">An open-source fulltext search engine and column store.</span>
    </a>
  </h1>

  <div class="other-language-links">
    <ul>
      <li><a href="../../../../ja/html/reference/suggest/suggestion.html">日本語</a></li>
    </ul>
  </div>
</div>
  

    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="../indexing.html" title="7.21. Indexing"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="correction.html" title="7.20.3. Correction"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v10.1.1-31-g1e46ba6 documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../../reference.html" ><span class="section-number">7. </span>Reference manual</a> &#187;</li>
          <li class="nav-item nav-item-2"><a href="../suggest.html" accesskey="U"><span class="section-number">7.20. </span>Suggest</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href=""><span class="section-number">7.20.4. </span>Suggestion</a></li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="suggestion">
<h1><span class="section-number">7.20.4. </span>Suggestion<a class="headerlink" href="#suggestion" title="Permalink to this headline">¶</a></h1>
<p>This section describes about the following completion
features:</p>
<ul class="simple">
<li><p>How it works</p></li>
<li><p>How to use</p></li>
<li><p>How to learn</p></li>
</ul>
<div class="section" id="how-it-works">
<h2><span class="section-number">7.20.4.1. </span>How it works<a class="headerlink" href="#how-it-works" title="Permalink to this headline">¶</a></h2>
<p>The suggestion feature uses a search to compute suggested
words:</p>
<blockquote>
<div><ol class="arabic simple">
<li><p>Cooccurrence search against learned data.</p></li>
</ol>
</div></blockquote>
<div class="section" id="cooccurrence-search">
<h3><span class="section-number">7.20.4.1.1. </span>Cooccurrence search<a class="headerlink" href="#cooccurrence-search" title="Permalink to this headline">¶</a></h3>
<p>Cooccurrence search can find related words from user’s
input. It uses user submissions that will be learned
from query logs, access logs and so on.</p>
<p>For example, there are the following user submissions:</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 100%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>query</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>search engine</p></td>
</tr>
<tr class="row-odd"><td><p>web search realtime</p></td>
</tr>
</tbody>
</table>
<p>Groonga creates the following suggestion pairs:</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 22%" />
<col style="width: 78%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>input</p></th>
<th class="head"><p>suggested words</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>search</p></td>
<td><p>search engine</p></td>
</tr>
<tr class="row-odd"><td><p>engine</p></td>
<td><p>search engine</p></td>
</tr>
<tr class="row-even"><td><p>web</p></td>
<td><p>web search realtime</p></td>
</tr>
<tr class="row-odd"><td><p>search</p></td>
<td><p>web search realtime</p></td>
</tr>
<tr class="row-even"><td><p>realtime</p></td>
<td><p>web search realtime</p></td>
</tr>
</tbody>
</table>
<p>Those pairs are created by the following steps:</p>
<blockquote>
<div><ol class="arabic simple">
<li><p>Tokenizes user input query by TokenDelimit tokenizer
that uses a space as token delimiter. (e.g. “search
engine” is tokenized to two tokens “search” and
“engine”.)</p></li>
<li><p>Creates a pair that is consists of a token and original
query for each token.</p></li>
</ol>
</div></blockquote>
<p>If an user inputs “search” and cooccurrence search returns
“search engine” and “web search realtime” because “search” is
in two input columns and corresponding suggested word
columns have “search engine” and “web search realtime”.</p>
</div>
</div>
<div class="section" id="how-to-use">
<h2><span class="section-number">7.20.4.2. </span>How to use<a class="headerlink" href="#how-to-use" title="Permalink to this headline">¶</a></h2>
<p>Groonga provides <a class="reference internal" href="../commands/suggest.html"><span class="doc">suggest</span></a> command to use
suggestion. <cite>–type suggest</cite> option requests suggestion</p>
<p>For example, here is an command to get suggestion results by
“search”:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>suggest --table item_query --column kana --types suggest --frequency_threshold 1 --query search
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   {
#     &quot;suggest&quot;: [
#       [
#         2
#       ],
#       [
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;_score&quot;,
#           &quot;Int32&quot;
#         ]
#       ],
#       [
#         &quot;search engine&quot;,
#         1
#       ],
#       [
#         &quot;web search realtime&quot;,
#         1
#       ]
#     ]
#   }
# ]
</pre></div>
</div>
</div>
<div class="section" id="how-it-learns">
<h2><span class="section-number">7.20.4.3. </span>How it learns<a class="headerlink" href="#how-it-learns" title="Permalink to this headline">¶</a></h2>
<p>Cooccurrence search uses learned data. They are based on
query logs, access logs and so on. To create learned data,
groonga needs user input sequence with time stamp and user
submit input with time stamp.</p>
<p>For example, an user wants to search by “engine”. The user
inputs the query with the following sequence:</p>
<blockquote>
<div><ol class="arabic simple">
<li><p>2011-08-10T13:33:23+09:00: search engine (submit)</p></li>
<li><p>2011-08-10T13:33:28+09:00: web search realtime (submit)</p></li>
</ol>
</div></blockquote>
<p>Groonga can be learned from the submissions by the
following command:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>load --table event_query --each &#39;suggest_preparer(_id, type, item, sequence, time, pair_query)&#39;
[
{&quot;sequence&quot;: &quot;1&quot;, &quot;time&quot;: 1312950803.86057, &quot;item&quot;: &quot;search engine&quot;, &quot;type&quot;: &quot;submit&quot;},
{&quot;sequence&quot;: &quot;1&quot;, &quot;time&quot;: 1312950808.86057, &quot;item&quot;: &quot;web search realtime&quot;, &quot;type&quot;: &quot;submit&quot;}
]
</pre></div>
</div>
</div>
<div class="section" id="how-to-extract-learning-data">
<h2><span class="section-number">7.20.4.4. </span>How to extract learning data<a class="headerlink" href="#how-to-extract-learning-data" title="Permalink to this headline">¶</a></h2>
<p>The learning data is stored into <code class="docutils literal notranslate"><span class="pre">item_DATASET</span></code> and <code class="docutils literal notranslate"><span class="pre">pair_DATASET</span></code> tables.
By using select command for such tables, you can all extract learing data.</p>
<p>Here is the query to extract all learning data:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select item_DATASET --limit -1
select pair_DATASET --filter &#39;freq0 &gt; 0 || freq1 &gt; 0 || freq2 &gt; 0&#39; --limit -1
</pre></div>
</div>
<p>Without ‘–limit -1’, you can’t get all data.
In pair table, the valid value of <code class="docutils literal notranslate"><span class="pre">freq0</span></code>, <code class="docutils literal notranslate"><span class="pre">freq1</span></code> and <code class="docutils literal notranslate"><span class="pre">freq2</span></code> column must be larger than 0.</p>
<p>Don’t execute above query via HTTP request because enormous number of records are fetched.</p>
</div>
</div>


            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h3><a href="../../index.html">Table of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">7.20.4. Suggestion</a><ul>
<li><a class="reference internal" href="#how-it-works">7.20.4.1. How it works</a><ul>
<li><a class="reference internal" href="#cooccurrence-search">7.20.4.1.1. Cooccurrence search</a></li>
</ul>
</li>
<li><a class="reference internal" href="#how-to-use">7.20.4.2. How to use</a></li>
<li><a class="reference internal" href="#how-it-learns">7.20.4.3. How it learns</a></li>
<li><a class="reference internal" href="#how-to-extract-learning-data">7.20.4.4. How to extract learning data</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="correction.html"
                        title="previous chapter"><span class="section-number">7.20.3. </span>Correction</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="../indexing.html"
                        title="next chapter"><span class="section-number">7.21. </span>Indexing</a></p>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="../indexing.html" title="7.21. Indexing"
             >next</a> |</li>
        <li class="right" >
          <a href="correction.html" title="7.20.3. Correction"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v10.1.1-31-g1e46ba6 documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../../reference.html" ><span class="section-number">7. </span>Reference manual</a> &#187;</li>
          <li class="nav-item nav-item-2"><a href="../suggest.html" ><span class="section-number">7.20. </span>Suggest</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href=""><span class="section-number">7.20.4. </span>Suggestion</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &#169; Copyright 2009-2021, Brazil, Inc.
    </div>
  </body>
</html>