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 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546
|
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>7.3.60. suggest — 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.3.61. table_copy" href="table_copy.html" />
<link rel="prev" title="7.3.59. status" href="status.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/commands/suggest.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="table_copy.html" title="7.3.61. table_copy"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="status.html" title="7.3.59. status"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">Groonga v10.1.1-31-g1e46ba6 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="../../reference.html" ><span class="section-number">7. </span>Reference manual</a> »</li>
<li class="nav-item nav-item-2"><a href="../command.html" accesskey="U"><span class="section-number">7.3. </span>Command</a> »</li>
<li class="nav-item nav-item-this"><a href=""><span class="section-number">7.3.60. </span><code class="docutils literal notranslate"><span class="pre">suggest</span></code></a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="suggest">
<h1><span class="section-number">7.3.60. </span><code class="docutils literal notranslate"><span class="pre">suggest</span></code><a class="headerlink" href="#suggest" title="Permalink to this headline">¶</a></h1>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The suggest feature specification isn’t stable. The
specification may be changed.</p>
</div>
<div class="section" id="summary">
<h2><span class="section-number">7.3.60.1. </span>Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
<p>suggest - returns completion, correction and/or suggestion for a query.</p>
<p>The suggest command returns completion, correction and/or
suggestion for a specified query.</p>
<p>See <a class="reference internal" href="../suggest/introduction.html"><span class="doc">Introduction</span></a> about completion,
correction and suggestion.</p>
</div>
<div class="section" id="syntax">
<h2><span class="section-number">7.3.60.2. </span>Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>suggest types
table
column
query
[sortby=-_score]
[output_columns=_key,_score]
[offset=0]
[limit=10]
[frequency_threshold=100]
[conditional_probability_threshold=0.2]
[prefix_search=auto]
</pre></div>
</div>
</div>
<div class="section" id="usage">
<h2><span class="section-number">7.3.60.3. </span>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<p>Here are learned data for completion.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)'
[
{"sequence": "1", "time": 1312950803.86057, "item": "e"},
{"sequence": "1", "time": 1312950803.96857, "item": "en"},
{"sequence": "1", "time": 1312950804.26057, "item": "eng"},
{"sequence": "1", "time": 1312950804.56057, "item": "engi"},
{"sequence": "1", "time": 1312950804.76057, "item": "engin"},
{"sequence": "1", "time": 1312950805.86057, "item": "engine", "type": "submit"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 6]
</pre></div>
</div>
<p>Here are learned data for correction.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)'
[
{"sequence": "2", "time": 1312950803.86057, "item": "s"},
{"sequence": "2", "time": 1312950803.96857, "item": "sa"},
{"sequence": "2", "time": 1312950804.26057, "item": "sae"},
{"sequence": "2", "time": 1312950804.56057, "item": "saer"},
{"sequence": "2", "time": 1312950804.76057, "item": "saerc"},
{"sequence": "2", "time": 1312950805.76057, "item": "saerch", "type": "submit"},
{"sequence": "2", "time": 1312950809.76057, "item": "serch"},
{"sequence": "2", "time": 1312950810.86057, "item": "search", "type": "submit"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 8]
</pre></div>
</div>
<p>Here are learned data for suggestion.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)'
[
{"sequence": "3", "time": 1312950803.86057, "item": "search engine", "type": "submit"},
{"sequence": "3", "time": 1312950808.86057, "item": "web search realtime", "type": "submit"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 2]
</pre></div>
</div>
<p>Here is a completion example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>suggest --table item_query --column kana --types complete --frequency_threshold 1 --query en
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# {
# "complete": [
# [
# 1
# ],
# [
# [
# "_key",
# "ShortText"
# ],
# [
# "_score",
# "Int32"
# ]
# ],
# [
# "engine",
# 1
# ]
# ]
# }
# ]
</pre></div>
</div>
<p>Here is a correction example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>suggest --table item_query --column kana --types correct --frequency_threshold 1 --query saerch
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# {
# "correct": [
# [
# 0
# ],
# [
# [
# "_key",
# "ShortText"
# ],
# [
# "_score",
# "Int32"
# ]
# ]
# ]
# }
# ]
</pre></div>
</div>
<p>Here is a suggestion example.</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
# ],
# {
# "suggest": [
# [
# 2
# ],
# [
# [
# "_key",
# "ShortText"
# ],
# [
# "_score",
# "Int32"
# ]
# ],
# [
# "search engine",
# 1
# ],
# [
# "web search realtime",
# 1
# ]
# ]
# }
# ]
</pre></div>
</div>
<p>Here is a mixed example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>suggest --table item_query --column kana --types complete|correct|suggest --frequency_threshold 1 --query search
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# {
# "suggest": [
# [
# 2
# ],
# [
# [
# "_key",
# "ShortText"
# ],
# [
# "_score",
# "Int32"
# ]
# ],
# [
# "search engine",
# 1
# ],
# [
# "web search realtime",
# 1
# ]
# ],
# "complete": [
# [
# 2
# ],
# [
# [
# "_key",
# "ShortText"
# ],
# [
# "_score",
# "Int32"
# ]
# ],
# [
# "search engine",
# 2
# ],
# [
# "search",
# 1
# ]
# ],
# "correct": [
# [
# 0
# ],
# [
# [
# "_key",
# "ShortText"
# ],
# [
# "_score",
# "Int32"
# ]
# ]
# ]
# }
# ]
</pre></div>
</div>
</div>
<div class="section" id="parameters">
<h2><span class="section-number">7.3.60.4. </span>Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
<dl>
<dt><code class="docutils literal notranslate"><span class="pre">types</span></code></dt><dd><p>Specifies what types are returned by the suggest
command.</p>
<p>Here are available types:</p>
<blockquote>
<div><dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">complete</span></code></dt><dd><p>The suggest command does completion.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">correct</span></code></dt><dd><p>The suggest command does correction.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">suggest</span></code></dt><dd><p>The suggest command does suggestion.</p>
</dd>
</dl>
</div></blockquote>
<p>You can specify one or more types separated by <code class="docutils literal notranslate"><span class="pre">|</span></code>.
Here are examples:</p>
<blockquote>
<div><p>It returns correction:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>correct
</pre></div>
</div>
<p>It returns correction and suggestion:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>correct|suggest
</pre></div>
</div>
<p>It returns complete, correction and suggestion:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>complete|correct|suggest
</pre></div>
</div>
</div></blockquote>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">table</span></code></dt><dd><p>Specifies table name that has <code class="docutils literal notranslate"><span class="pre">item_${DATA_SET_NAME}</span></code> format.
For example, <code class="docutils literal notranslate"><span class="pre">item_query</span></code> is a table name if you created
dataset by the following command:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>groonga-suggest-create-dataset /tmp/db-path query
</pre></div>
</div>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">column</span></code></dt><dd><p>Specifies a column name that has furigana in
Katakana in <code class="docutils literal notranslate"><span class="pre">table</span></code> table.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">query</span></code></dt><dd><p>Specifies query for completion, correction and/or
suggestion.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">sortby</span></code></dt><dd><p>Specifies sort key.</p>
<dl class="simple">
<dt>Default:</dt><dd><p><code class="docutils literal notranslate"><span class="pre">-_score</span></code></p>
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">output_columns</span></code></dt><dd><p>Specifies output columns.</p>
<dl class="simple">
<dt>Default:</dt><dd><p><code class="docutils literal notranslate"><span class="pre">_key,_score</span></code></p>
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">offset</span></code></dt><dd><p>Specifies returned records offset.</p>
<dl class="simple">
<dt>Default:</dt><dd><p><code class="docutils literal notranslate"><span class="pre">0</span></code></p>
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">limit</span></code></dt><dd><p>Specifies number of returned records.</p>
<dl class="simple">
<dt>Default:</dt><dd><p><code class="docutils literal notranslate"><span class="pre">10</span></code></p>
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">frequency_threshold</span></code></dt><dd><p>Specifies threshold for item frequency. Returned records must have
<code class="docutils literal notranslate"><span class="pre">_score</span></code> that is greater than or equal to <code class="docutils literal notranslate"><span class="pre">frequency_threshold</span></code>.</p>
<dl class="simple">
<dt>Default:</dt><dd><p><code class="docutils literal notranslate"><span class="pre">100</span></code></p>
</dd>
</dl>
</dd>
</dl>
<p><code class="docutils literal notranslate"><span class="pre">conditional_probability_threshold</span></code></p>
<blockquote>
<div><p>Specifies threshold for conditional
probability. Conditional probability is used for learned
data. It is probability of query submission when <code class="docutils literal notranslate"><span class="pre">query</span></code>
is occurred. Returned records must have conditional
probability that is greater than or equal to
<code class="docutils literal notranslate"><span class="pre">conditional_probability_threshold</span></code>.</p>
<dl class="simple">
<dt>Default:</dt><dd><p><code class="docutils literal notranslate"><span class="pre">0.2</span></code></p>
</dd>
</dl>
</div></blockquote>
<dl>
<dt><code class="docutils literal notranslate"><span class="pre">prefix_search</span></code></dt><dd><p>Specifies whether optional prefix search is used or not
in completion.</p>
<p>Here are available values:</p>
<blockquote>
<div><dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">yes</span></code></dt><dd><p>Prefix search is always used.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">no</span></code></dt><dd><p>Prefix search is never used.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">auto</span></code></dt><dd><p>Prefix search is used only when other search can’t
find any records.</p>
</dd>
</dl>
</div></blockquote>
<dl class="simple">
<dt>Default:</dt><dd><p><code class="docutils literal notranslate"><span class="pre">auto</span></code></p>
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">similar_search</span></code></dt><dd><p>Specifies whether optional similar search is used or not
in correction.</p>
<p>Here are available values:</p>
<blockquote>
<div><dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">yes</span></code></dt><dd><p>Similar search is always used.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">no</span></code></dt><dd><p>Similar search is never used.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">auto</span></code></dt><dd><p>Similar search is used only when other search can’t
find any records.</p>
</dd>
</dl>
</div></blockquote>
<dl class="simple">
<dt>Default:</dt><dd><p><code class="docutils literal notranslate"><span class="pre">auto</span></code></p>
</dd>
</dl>
</dd>
</dl>
</div>
<div class="section" id="return-value">
<h2><span class="section-number">7.3.60.5. </span>Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
<p>Here is a returned JSON format:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>{"type1": [["candidate1", score of candidate1],
["candidate2", score of candidate2],
...],
"type2": [["candidate1", score of candidate1],
["candidate2", score of candidate2],
...],
...}
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">type</span></code></p>
<blockquote>
<div><p>A type specified by <code class="docutils literal notranslate"><span class="pre">types</span></code>.</p>
</div></blockquote>
<p><code class="docutils literal notranslate"><span class="pre">candidate</span></code></p>
<blockquote>
<div><p>A candidate for completion, correction or suggestion.</p>
</div></blockquote>
<p><code class="docutils literal notranslate"><span class="pre">score</span> <span class="pre">of</span> <span class="pre">candidate</span></code></p>
<blockquote>
<div><p>A score of corresponding <code class="docutils literal notranslate"><span class="pre">candidate</span></code>. It means that
higher score candidate is more likely candidate for
completion, correction or suggestion. Returned candidates
are sorted by <code class="docutils literal notranslate"><span class="pre">score</span> <span class="pre">of</span> <span class="pre">candidate</span></code> descending by
default.</p>
</div></blockquote>
</div>
<div class="section" id="see-also">
<h2><span class="section-number">7.3.60.6. </span>See also<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><p><a class="reference internal" href="../suggest.html"><span class="doc">Suggest</span></a></p></li>
<li><p><a class="reference internal" href="../executables/groonga-suggest-create-dataset.html"><span class="doc">groonga-suggest-create-dataset</span></a></p></li>
</ul>
</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.3.60. <code class="docutils literal notranslate"><span class="pre">suggest</span></code></a><ul>
<li><a class="reference internal" href="#summary">7.3.60.1. Summary</a></li>
<li><a class="reference internal" href="#syntax">7.3.60.2. Syntax</a></li>
<li><a class="reference internal" href="#usage">7.3.60.3. Usage</a></li>
<li><a class="reference internal" href="#parameters">7.3.60.4. Parameters</a></li>
<li><a class="reference internal" href="#return-value">7.3.60.5. Return value</a></li>
<li><a class="reference internal" href="#see-also">7.3.60.6. See also</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="status.html"
title="previous chapter"><span class="section-number">7.3.59. </span><code class="docutils literal notranslate"><span class="pre">status</span></code></a></p>
<h4>Next topic</h4>
<p class="topless"><a href="table_copy.html"
title="next chapter"><span class="section-number">7.3.61. </span><code class="docutils literal notranslate"><span class="pre">table_copy</span></code></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="table_copy.html" title="7.3.61. table_copy"
>next</a> |</li>
<li class="right" >
<a href="status.html" title="7.3.59. status"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">Groonga v10.1.1-31-g1e46ba6 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="../../reference.html" ><span class="section-number">7. </span>Reference manual</a> »</li>
<li class="nav-item nav-item-2"><a href="../command.html" ><span class="section-number">7.3. </span>Command</a> »</li>
<li class="nav-item nav-item-this"><a href=""><span class="section-number">7.3.60. </span><code class="docutils literal notranslate"><span class="pre">suggest</span></code></a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2009-2021, Brazil, Inc.
</div>
</body>
</html>
|