RubyGems - rroonga - Versions diffs - 1.2.5-x86-mingw32 → 1.2.7-x86-mingw32 - Mend

rroonga 1.2.5-x86-mingw32 → 1.2.7-x86-mingw32

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (300) hide show

data/vendor/local/share/doc/groonga/en/html/commands/status.html CHANGED Viewed

@@ -9,7 +9,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>5.2.19. status &mdash; groonga v1.2.4 documentation</title>
+    <title>6.2.19. status &mdash; groonga v1.2.5 documentation</title>
     <link rel="stylesheet" href="../_static/groonga.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@@ -17,7 +17,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../',
-        VERSION:     '1.2.4',
+        VERSION:     '1.2.5',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -27,10 +27,10 @@
     <script type="text/javascript" src="../_static/underscore.js"></script>
     <script type="text/javascript" src="../_static/doctools.js"></script>
     <link rel="shortcut icon" href="../_static/favicon.ico"/>
-    <link rel="top" title="groonga v1.2.4 documentation" href="../index.html" />
-    <link rel="up" title="5.2. コマンド" href="../commands.html" />
-    <link rel="next" title="5.2.20. suggest" href="suggest.html" />
-    <link rel="prev" title="5.2.18. shutdown" href="shutdown.html" />
+    <link rel="top" title="groonga v1.2.5 documentation" href="../index.html" />
+    <link rel="up" title="6.2. コマンド" href="../commands.html" />
+    <link rel="next" title="6.2.20. suggest" href="suggest.html" />
+    <link rel="prev" title="6.2.18. shutdown" href="shutdown.html" />
   </head>
   <body>
 <div class="header">
@@ -57,14 +57,14 @@
           <a href="../genindex.html" title="General Index"
              accesskey="I">index</a></li>
         <li class="right" >
-          <a href="suggest.html" title="5.2.20. suggest"
+          <a href="suggest.html" title="6.2.20. suggest"
              accesskey="N">next</a> |</li>
         <li class="right" >
-          <a href="shutdown.html" title="5.2.18. shutdown"
+          <a href="shutdown.html" title="6.2.18. shutdown"
              accesskey="P">previous</a> |</li>
-        <li><a href="../index.html">groonga v1.2.4 documentation</a> &raquo;</li>
-          <li><a href="../reference.html" >5. リファレンスマニュアル</a> &raquo;</li>
-          <li><a href="../commands.html" accesskey="U">5.2. コマンド</a> &raquo;</li>
+        <li><a href="../index.html">groonga v1.2.5 documentation</a> &raquo;</li>
+          <li><a href="../reference.html" >6. リファレンスマニュアル</a> &raquo;</li>
+          <li><a href="../commands.html" accesskey="U">6.2. コマンド</a> &raquo;</li>
       </ul>
     </div>
@@ -74,30 +74,30 @@
           <div class="body">
   <div class="section" id="status">
-<h1>5.2.19. status<a class="headerlink" href="#status" title="Permalink to this headline">¶</a></h1>
+<h1>6.2.19. status<a class="headerlink" href="#status" title="Permalink to this headline">¶</a></h1>
 <div class="section" id="id1">
-<h2>5.2.19.1. 名前<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
+<h2>6.2.19.1. 名前<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
 <p>status - groongaプロセスの状態表示</p>
 </div>
 <div class="section" id="id2">
-<h2>5.2.19.2. 書式<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h2>
+<h2>6.2.19.2. 書式<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h2>
 <div class="highlight-none"><div class="highlight"><pre>status
 </pre></div>
 </div>
 </div>
 <div class="section" id="id3">
-<h2>5.2.19.3. 説明<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h2>
+<h2>6.2.19.3. 説明<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h2>
 <p>groonga組込コマンドの一つであるstatusについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。</p>
 <p>statusコマンドは、groongaプロセスの状態を表示します。主にgroongaサーバプロセスに対して使用することを想定しています。</p>
 </div>
 <div class="section" id="id4">
-<h2>5.2.19.4. 引数<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h2>
+<h2>6.2.19.4. 引数<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h2>
 <p>ありません。</p>
 </div>
 <div class="section" id="id5">
-<h2>5.2.19.5. 返値<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h2>
+<h2>6.2.19.5. 返値<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h2>
 <div class="section" id="json">
-<h3>5.2.19.5.1. json形式<a class="headerlink" href="#json" title="Permalink to this headline">¶</a></h3>
+<h3>6.2.19.5.1. json形式<a class="headerlink" href="#json" title="Permalink to this headline">¶</a></h3>
 <div class="highlight-none"><div class="highlight"><pre>下記の項目がハッシュ形式で出力されます。
 ``alloc_count``
@@ -116,7 +116,7 @@
 </div>
 </div>
 <div class="section" id="id6">
-<h2>5.2.19.6. 例<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h2>
+<h2>6.2.19.6. 例<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h2>
 <div class="highlight-none"><div class="highlight"><pre>status
 {&quot;alloc_count&quot;:104,
  &quot;starttime&quot;:1268213679,
@@ -134,26 +134,26 @@
         <div class="sphinxsidebarwrapper">
   <h3><a href="../index.html">Table Of Contents</a></h3>
   <ul>
-<li><a class="reference internal" href="#">5.2.19. status</a><ul>
-<li><a class="reference internal" href="#id1">5.2.19.1. 名前</a></li>
-<li><a class="reference internal" href="#id2">5.2.19.2. 書式</a></li>
-<li><a class="reference internal" href="#id3">5.2.19.3. 説明</a></li>
-<li><a class="reference internal" href="#id4">5.2.19.4. 引数</a></li>
-<li><a class="reference internal" href="#id5">5.2.19.5. 返値</a><ul>
-<li><a class="reference internal" href="#json">5.2.19.5.1. json形式</a></li>
+<li><a class="reference internal" href="#">6.2.19. status</a><ul>
+<li><a class="reference internal" href="#id1">6.2.19.1. 名前</a></li>
+<li><a class="reference internal" href="#id2">6.2.19.2. 書式</a></li>
+<li><a class="reference internal" href="#id3">6.2.19.3. 説明</a></li>
+<li><a class="reference internal" href="#id4">6.2.19.4. 引数</a></li>
+<li><a class="reference internal" href="#id5">6.2.19.5. 返値</a><ul>
+<li><a class="reference internal" href="#json">6.2.19.5.1. json形式</a></li>
 </ul>
 </li>
-<li><a class="reference internal" href="#id6">5.2.19.6. 例</a></li>
+<li><a class="reference internal" href="#id6">6.2.19.6. 例</a></li>
 </ul>
 </li>
 </ul>
   <h4>Previous topic</h4>
   <p class="topless"><a href="shutdown.html"
-                        title="previous chapter">5.2.18. shutdown</a></p>
+                        title="previous chapter">6.2.18. shutdown</a></p>
   <h4>Next topic</h4>
   <p class="topless"><a href="suggest.html"
-                        title="next chapter">5.2.20. suggest</a></p>
+                        title="next chapter">6.2.20. suggest</a></p>
   <h3>This Page</h3>
   <ul class="this-page-menu">
     <li><a href="../_sources/commands/status.txt"
@@ -183,14 +183,14 @@
           <a href="../genindex.html" title="General Index"
              >index</a></li>
         <li class="right" >
-          <a href="suggest.html" title="5.2.20. suggest"
+          <a href="suggest.html" title="6.2.20. suggest"
              >next</a> |</li>
         <li class="right" >
-          <a href="shutdown.html" title="5.2.18. shutdown"
+          <a href="shutdown.html" title="6.2.18. shutdown"
              >previous</a> |</li>
-        <li><a href="../index.html">groonga v1.2.4 documentation</a> &raquo;</li>
-          <li><a href="../reference.html" >5. リファレンスマニュアル</a> &raquo;</li>
-          <li><a href="../commands.html" >5.2. コマンド</a> &raquo;</li>
+        <li><a href="../index.html">groonga v1.2.5 documentation</a> &raquo;</li>
+          <li><a href="../reference.html" >6. リファレンスマニュアル</a> &raquo;</li>
+          <li><a href="../commands.html" >6.2. コマンド</a> &raquo;</li>
       </ul>
     </div>
     <div class="footer">

data/vendor/local/share/doc/groonga/en/html/commands/suggest.html CHANGED Viewed

@@ -9,7 +9,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>5.2.20. suggest &mdash; groonga v1.2.4 documentation</title>
+    <title>6.2.20. suggest &mdash; groonga v1.2.5 documentation</title>
     <link rel="stylesheet" href="../_static/groonga.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@@ -17,7 +17,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../',
-        VERSION:     '1.2.4',
+        VERSION:     '1.2.5',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -27,10 +27,10 @@
     <script type="text/javascript" src="../_static/underscore.js"></script>
     <script type="text/javascript" src="../_static/doctools.js"></script>
     <link rel="shortcut icon" href="../_static/favicon.ico"/>
-    <link rel="top" title="groonga v1.2.4 documentation" href="../index.html" />
-    <link rel="up" title="5.2. コマンド" href="../commands.html" />
-    <link rel="next" title="5.2.21. table_create" href="table_create.html" />
-    <link rel="prev" title="5.2.19. status" href="status.html" />
+    <link rel="top" title="groonga v1.2.5 documentation" href="../index.html" />
+    <link rel="up" title="6.2. コマンド" href="../commands.html" />
+    <link rel="next" title="6.2.21. table_create" href="table_create.html" />
+    <link rel="prev" title="6.2.19. status" href="status.html" />
   </head>
   <body>
 <div class="header">
@@ -57,14 +57,14 @@
           <a href="../genindex.html" title="General Index"
              accesskey="I">index</a></li>
         <li class="right" >
-          <a href="table_create.html" title="5.2.21. table_create"
+          <a href="table_create.html" title="6.2.21. table_create"
              accesskey="N">next</a> |</li>
         <li class="right" >
-          <a href="status.html" title="5.2.19. status"
+          <a href="status.html" title="6.2.19. status"
              accesskey="P">previous</a> |</li>
-        <li><a href="../index.html">groonga v1.2.4 documentation</a> &raquo;</li>
-          <li><a href="../reference.html" >5. リファレンスマニュアル</a> &raquo;</li>
-          <li><a href="../commands.html" accesskey="U">5.2. コマンド</a> &raquo;</li>
+        <li><a href="../index.html">groonga v1.2.5 documentation</a> &raquo;</li>
+          <li><a href="../reference.html" >6. リファレンスマニュアル</a> &raquo;</li>
+          <li><a href="../commands.html" accesskey="U">6.2. コマンド</a> &raquo;</li>
       </ul>
     </div>
@@ -74,68 +74,252 @@
           <div class="body">
   <div class="section" id="suggest">
-<h1>5.2.20. suggest<a class="headerlink" href="#suggest" title="Permalink to this headline">¶</a></h1>
-<p>** 未だ仕様は確定しておりません。利用のためには特定のデータを持つテーブルが必要となります。 **</p>
-<div class="section" id="id1">
-<h2>5.2.20.1. 名前<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
-<p>suggest - 指定したクエリに対する補完・修正・提案を行う。</p>
-</div>
-<div class="section" id="id2">
-<h2>5.2.20.2. 書式<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h2>
-<div class="highlight-none"><div class="highlight"><pre>suggest types table column query
+<h1>6.2.20. suggest<a class="headerlink" href="#suggest" title="Permalink to this headline">¶</a></h1>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">The suggest feature specification isn't stable. The
+specification may be changed.</p>
+</div>
+<div class="section" id="name">
+<h2>6.2.20.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline">¶</a></h2>
+<p>suggest - returns completion, correction and/or suggestion for a query.</p>
+</div>
+<div class="section" id="synopsis">
+<h2>6.2.20.2. SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
+<div class="highlight-none"><div class="highlight"><pre>suggest types table column query [sortby [output_columns [offset [limit [frequency_threshold [conditional_probability_threshold [prefix_search]]]]]]]
 </pre></div>
 </div>
 </div>
-<div class="section" id="id3">
-<h2>5.2.20.3. 説明<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h2>
-<p>suggestコマンドは、指定したクエリに対して補完・修正・提案を行います。</p>
-<p>補完とは、クエリの未入力・未変換部分を補うことです。修正とは、クエリ内のミスタイプや誤変換を修正することです。提案とは、さらなる絞込みを行うための候補となるクエリを提案することです。</p>
+<div class="section" id="description">
+<h2>6.2.20.3. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
+<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"><em>Introduction</em></a> about completion,
+correction and suggestion.</p>
 </div>
-<div class="section" id="id4">
-<h2>5.2.20.4. 引数<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h2>
-<p><tt class="docutils literal"><span class="pre">types</span></tt></p>
-<blockquote>
-<div><p>補完・修正・提案のいずれを行うかを、パイプ('|')で組み合わせたシンボル名で指定します(例: correct|suggest)</p>
-<p><tt class="docutils literal"><span class="pre">complete</span></tt></p>
+<div class="section" id="options">
+<h2>6.2.20.4. OPTIONS<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
+<dl class="docutils">
+<dt><tt class="docutils literal"><span class="pre">types</span></tt></dt>
+<dd><p class="first">It specifies what types are returned by the suggest
+command.</p>
+<p>Here are available types:</p>
 <blockquote>
-<div>補完を行います。</div></blockquote>
-<p><tt class="docutils literal"><span class="pre">correct</span></tt></p>
+<div><dl class="docutils">
+<dt><tt class="docutils literal"><span class="pre">complete</span></tt></dt>
+<dd>The suggest command does completion.</dd>
+<dt><tt class="docutils literal"><span class="pre">correct</span></tt></dt>
+<dd>The suggest command does correction.</dd>
+<dt><tt class="docutils literal"><span class="pre">suggest</span></tt></dt>
+<dd>The suggest command does suggestion.</dd>
+</dl>
+</div></blockquote>
+<p>You can specify one or more types separated by <tt class="docutils literal"><span class="pre">|</span></tt>.
+Here are examples:</p>
+<blockquote class="last">
+<div><p>It returns correction:</p>
+<div class="highlight-none"><div class="highlight"><pre>correct
+</pre></div>
+</div>
+<p>It returns correction and suggestion:</p>
+<div class="highlight-none"><div class="highlight"><pre>correct|suggest
+</pre></div>
+</div>
+<p>It returns complete, correction and suggestion:</p>
+<div class="highlight-none"><div class="highlight"><pre>complete|correct|suggest
+</pre></div>
+</div>
+</div></blockquote>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">table</span></tt></dt>
+<dd><p class="first">It specifies table name that has <tt class="docutils literal"><span class="pre">item_${DATA_SET_NAME}`</span> <span class="pre">format.</span>
+<span class="pre">For</span> <span class="pre">example,</span> <span class="pre">``item_query</span></tt> is a table name if you created
+dataset by the following command:</p>
+<div class="last highlight-none"><div class="highlight"><pre>groonga-suggest-create-dataset /tmp/db-path query
+</pre></div>
+</div>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">column</span></tt></dt>
+<dd>It specifies a column name that has furigana in
+Katakana in <tt class="docutils literal"><span class="pre">table</span></tt> table.</dd>
+<dt><tt class="docutils literal"><span class="pre">query</span></tt></dt>
+<dd>It specifies query for completion, correction and/or
+suggestion.</dd>
+<dt><tt class="docutils literal"><span class="pre">sortby</span></tt></dt>
+<dd><p class="first">It specifies sort key.</p>
+<dl class="last docutils">
+<dt>Default:</dt>
+<dd><tt class="docutils literal"><span class="pre">-_score</span></tt></dd>
+</dl>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">output_columns</span></tt></dt>
+<dd><p class="first">It specifies output columns.</p>
+<dl class="last docutils">
+<dt>Default:</dt>
+<dd><tt class="docutils literal"><span class="pre">_key,_score</span></tt></dd>
+</dl>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">offset</span></tt></dt>
+<dd><p class="first">It specifies returned records offset.</p>
+<dl class="last docutils">
+<dt>Default:</dt>
+<dd><tt class="docutils literal"><span class="pre">0</span></tt></dd>
+</dl>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">limit</span></tt></dt>
+<dd><p class="first">It specifies number of returned records.</p>
+<dl class="last docutils">
+<dt>Default:</dt>
+<dd><tt class="docutils literal"><span class="pre">10</span></tt></dd>
+</dl>
+</dd>
+<dt><tt class="docutils literal"><span class="pre">frequency_threshold</span></tt></dt>
+<dd><p class="first">It specifies threshold for item frequency. Returned records must have
+<tt class="docutils literal"><span class="pre">_score</span></tt> that is greater than or equal to <tt class="docutils literal"><span class="pre">frequency_threshold</span></tt>.</p>
+<dl class="last docutils">
+<dt>Default:</dt>
+<dd><tt class="docutils literal"><span class="pre">100</span></tt></dd>
+</dl>
+</dd>
+</dl>
+<p><tt class="docutils literal"><span class="pre">conditional_probability_threshold</span></tt></p>
 <blockquote>
-<div>修正を行います。</div></blockquote>
-<p><tt class="docutils literal"><span class="pre">suggest</span></tt></p>
+<div><p>It specifies threshold for conditional
+probability. Conditional probability is used for learned
+data. It is probability of query submission when <tt class="docutils literal"><span class="pre">query</span></tt>
+is occurred. Returned records must have conditional
+probability that is greater than or equal to
+<tt class="docutils literal"><span class="pre">conditional_probability_threshold</span></tt>.</p>
+<dl class="docutils">
+<dt>Default:</dt>
+<dd><tt class="docutils literal"><span class="pre">0.2</span></tt></dd>
+</dl>
+</div></blockquote>
+<dl class="docutils">
+<dt><tt class="docutils literal"><span class="pre">prefix_search</span></tt></dt>
+<dd><p class="first">It specifies whether optional prefix search is used or not
+in completion.</p>
+<p>Here are available values:</p>
 <blockquote>
-<div>提案を行います。</div></blockquote>
+<div><dl class="docutils">
+<dt><tt class="docutils literal"><span class="pre">yes</span></tt></dt>
+<dd>Prefix search is always used.</dd>
+<dt><tt class="docutils literal"><span class="pre">no</span></tt></dt>
+<dd>Prefix search is never used.</dd>
+<dt><tt class="docutils literal"><span class="pre">auto</span></tt></dt>
+<dd>Prefix search is used only when other search can't
+find any records.</dd>
+</dl>
 </div></blockquote>
-<p><tt class="docutils literal"><span class="pre">table</span></tt></p>
+<dl class="last docutils">
+<dt>Default:</dt>
+<dd><tt class="docutils literal"><span class="pre">auto</span></tt></dd>
+</dl>
+</dd>
+</dl>
+</div>
+<div class="section" id="return-value">
+<h2>6.2.20.5. RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="json-format">
+<h3>6.2.20.5.1. JSON format<a class="headerlink" href="#json-format" title="Permalink to this headline">¶</a></h3>
+<p>Here is a returned JSON format:</p>
+<div class="highlight-none"><div class="highlight"><pre>{&quot;type1&quot;: [[&quot;candidate1&quot;, score of candidate1],
+           [&quot;candidate2&quot;, score of candidate2],
+           ...],
+ &quot;type2&quot;: [[&quot;candidate1&quot;, score of candidate1],
+           [&quot;candidate2&quot;, score of candidate2],
+           ...],
+ ...}
+</pre></div>
+</div>
+<p><tt class="docutils literal"><span class="pre">type</span></tt></p>
 <blockquote>
-<div>基礎となるデータが格納されているテーブル名を指定します。</div></blockquote>
-<p><tt class="docutils literal"><span class="pre">column</span></tt></p>
+<div>A type specified by <tt class="docutils literal"><span class="pre">types</span></tt>.</div></blockquote>
+<p><tt class="docutils literal"><span class="pre">candidate</span></tt></p>
 <blockquote>
-<div>基礎となるデータが格納されているテーブルにおいて、「ヨミガナ」が格納されているカラム名を指定します。</div></blockquote>
-<p><tt class="docutils literal"><span class="pre">query</span></tt></p>
+<div>A candidate for completion, correction or suggestion.</div></blockquote>
+<p><tt class="docutils literal"><span class="pre">score</span> <span class="pre">of</span> <span class="pre">candidate</span></tt></p>
 <blockquote>
-<div>補完・修正・提案の対象となるクエリを指定します。</div></blockquote>
+<div>A score of corresponding <tt class="docutils literal"><span class="pre">candidate</span></tt>. It means that
+higher score candidate is more likely candidate for
+completion, correction or suggestion. Returned candidates
+are sorted by <tt class="docutils literal"><span class="pre">score</span> <span class="pre">of</span> <span class="pre">candidate</span></tt> descending by
+default.</div></blockquote>
 </div>
-<div class="section" id="id5">
-<h2>5.2.20.5. 返値<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h2>
-<div class="section" id="json">
-<h3>5.2.20.5.1. json形式<a class="headerlink" href="#json" title="Permalink to this headline">¶</a></h3>
-<div class="highlight-none"><div class="highlight"><pre>{&quot;タイプ1&quot;:[[&quot;候補1&quot;, 候補1のスコア], [&quot;候補2&quot;, 候補2のスコア], ...], ...}
-``タイプ``
-  types引数に指定した値。
-``候補``
-  補完・修正・提案の候補。
-``候補のスコア``
-  補完・修正・提案として優れたものほど高くなる数値。結果は、スコア順にソートされている。
+</div>
+<div class="section" id="example">
+<h2>6.2.20.6. EXAMPLE<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2>
+<p>Here are learned data for completion.</p>
+<p>Execution example:</p>
+<div class="highlight-none"><div class="highlight"><pre>&gt; load --table event_query --each &#39;suggest_preparer(_id, type, item, sequence, time, pair_query)&#39;
+&gt; [
+&gt; {&quot;sequence&quot;: &quot;1&quot;, &quot;time&quot;: 1312950803.86057, &quot;item&quot;: &quot;e&quot;},
+&gt; {&quot;sequence&quot;: &quot;1&quot;, &quot;time&quot;: 1312950803.96857, &quot;item&quot;: &quot;en&quot;},
+&gt; {&quot;sequence&quot;: &quot;1&quot;, &quot;time&quot;: 1312950804.26057, &quot;item&quot;: &quot;eng&quot;},
+&gt; {&quot;sequence&quot;: &quot;1&quot;, &quot;time&quot;: 1312950804.56057, &quot;item&quot;: &quot;engi&quot;},
+&gt; {&quot;sequence&quot;: &quot;1&quot;, &quot;time&quot;: 1312950804.76057, &quot;item&quot;: &quot;engin&quot;},
+&gt; {&quot;sequence&quot;: &quot;1&quot;, &quot;time&quot;: 1312950805.86057, &quot;item&quot;: &quot;engine&quot;, &quot;type&quot;: &quot;submit&quot;}
+&gt; ]
+[[0,1313562872.82845,1.577141877],6]
+</pre></div>
+</div>
+<p>Here are learned data for correction.</p>
+<p>Execution example:</p>
+<div class="highlight-none"><div class="highlight"><pre>&gt; load --table event_query --each &#39;suggest_preparer(_id, type, item, sequence, time, pair_query)&#39;
+&gt; [
+&gt; {&quot;sequence&quot;: &quot;2&quot;, &quot;time&quot;: 1312950803.86057, &quot;item&quot;: &quot;s&quot;},
+&gt; {&quot;sequence&quot;: &quot;2&quot;, &quot;time&quot;: 1312950803.96857, &quot;item&quot;: &quot;sa&quot;},
+&gt; {&quot;sequence&quot;: &quot;2&quot;, &quot;time&quot;: 1312950804.26057, &quot;item&quot;: &quot;sae&quot;},
+&gt; {&quot;sequence&quot;: &quot;2&quot;, &quot;time&quot;: 1312950804.56057, &quot;item&quot;: &quot;saer&quot;},
+&gt; {&quot;sequence&quot;: &quot;2&quot;, &quot;time&quot;: 1312950804.76057, &quot;item&quot;: &quot;saerc&quot;},
+&gt; {&quot;sequence&quot;: &quot;2&quot;, &quot;time&quot;: 1312950805.76057, &quot;item&quot;: &quot;saerch&quot;, &quot;type&quot;: &quot;submit&quot;},
+&gt; {&quot;sequence&quot;: &quot;2&quot;, &quot;time&quot;: 1312950809.76057, &quot;item&quot;: &quot;serch&quot;},
+&gt; {&quot;sequence&quot;: &quot;2&quot;, &quot;time&quot;: 1312950810.86057, &quot;item&quot;: &quot;search&quot;, &quot;type&quot;: &quot;submit&quot;}
+&gt; ]
+[[0,1313562874.6075,2.004191545],8]
+</pre></div>
+</div>
+<p>Here are learned data for suggestion.</p>
+<p>Execution example:</p>
+<div class="highlight-none"><div class="highlight"><pre>&gt; load --table event_query --each &#39;suggest_preparer(_id, type, item, sequence, time, pair_query)&#39;
+&gt; [
+&gt; {&quot;sequence&quot;: &quot;3&quot;, &quot;time&quot;: 1312950803.86057, &quot;item&quot;: &quot;search engine&quot;, &quot;type&quot;: &quot;submit&quot;},
+&gt; {&quot;sequence&quot;: &quot;3&quot;, &quot;time&quot;: 1312950808.86057, &quot;item&quot;: &quot;web search realtime&quot;, &quot;type&quot;: &quot;submit&quot;}
+&gt; ]
+[[0,1313562876.81305,0.801821271],2]
 </pre></div>
 </div>
+<p>Here is a completion example.</p>
+<p>Execution example:</p>
+<div class="highlight-none"><div class="highlight"><pre>&gt; suggest --table item_query --column kana --types complete --threshold 1 --query en
+[[0,1313562877.81745,0.001827712],{&quot;complete&quot;:[[1],[[&quot;_key&quot;,&quot;ShortText&quot;],[&quot;_score&quot;,&quot;Int32&quot;]],[&quot;engine&quot;,1]]}]
+</pre></div>
+</div>
+<p>Here is a correction example.</p>
+<p>Execution example:</p>
+<div class="highlight-none"><div class="highlight"><pre>&gt; suggest --table item_query --column kana --types correct --threshold 1 --query saerch
+[[0,1313562878.02203,0.000442789],{&quot;correct&quot;:[[1],[[&quot;_key&quot;,&quot;ShortText&quot;],[&quot;_score&quot;,&quot;Int32&quot;]],[&quot;search&quot;,1]]}]
+</pre></div>
+</div>
+<p>Here is a suggestion example.</p>
+<p>Execution example:</p>
+<div class="highlight-none"><div class="highlight"><pre>&gt; suggest --table item_query --column kana --types suggest --threshold 1 --query search
+[[0,1313562878.22422,0.000812428],{&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>
+<p>Here is a mixed example.</p>
+<p>Execution example:</p>
+<div class="highlight-none"><div class="highlight"><pre>&gt; suggest --table item_query --column kana --types complete|correct|suggest --threshold 1 --query search
+[[0,1313562878.42973,0.001223259],{&quot;complete&quot;:[[2],[[&quot;_key&quot;,&quot;ShortText&quot;],[&quot;_score&quot;,&quot;Int32&quot;]],[&quot;search&quot;,2],[&quot;search engine&quot;,2]],&quot;correct&quot;:[[1],[[&quot;_key&quot;,&quot;ShortText&quot;],[&quot;_score&quot;,&quot;Int32&quot;]],[&quot;search&quot;,2]],&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="see-also">
+<h2>6.2.20.7. SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
+<ul class="simple">
+<li><a class="reference internal" href="../suggest.html"><em>Suggest</em></a></li>
+<li><a class="reference internal" href="../executables/groonga-suggest-create-dataset.html"><em>groonga-suggest-create-dataset</em></a></li>
+</ul>
 </div>
 </div>
@@ -147,25 +331,27 @@
         <div class="sphinxsidebarwrapper">
   <h3><a href="../index.html">Table Of Contents</a></h3>
   <ul>
-<li><a class="reference internal" href="#">5.2.20. suggest</a><ul>
-<li><a class="reference internal" href="#id1">5.2.20.1. 名前</a></li>
-<li><a class="reference internal" href="#id2">5.2.20.2. 書式</a></li>
-<li><a class="reference internal" href="#id3">5.2.20.3. 説明</a></li>
-<li><a class="reference internal" href="#id4">5.2.20.4. 引数</a></li>
-<li><a class="reference internal" href="#id5">5.2.20.5. 返値</a><ul>
-<li><a class="reference internal" href="#json">5.2.20.5.1. json形式</a></li>
+<li><a class="reference internal" href="#">6.2.20. suggest</a><ul>
+<li><a class="reference internal" href="#name">6.2.20.1. NAME</a></li>
+<li><a class="reference internal" href="#synopsis">6.2.20.2. SYNOPSIS</a></li>
+<li><a class="reference internal" href="#description">6.2.20.3. DESCRIPTION</a></li>
+<li><a class="reference internal" href="#options">6.2.20.4. OPTIONS</a></li>
+<li><a class="reference internal" href="#return-value">6.2.20.5. RETURN VALUE</a><ul>
+<li><a class="reference internal" href="#json-format">6.2.20.5.1. JSON format</a></li>
 </ul>
 </li>
+<li><a class="reference internal" href="#example">6.2.20.6. EXAMPLE</a></li>
+<li><a class="reference internal" href="#see-also">6.2.20.7. SEE ALSO</a></li>
 </ul>
 </li>
 </ul>
   <h4>Previous topic</h4>
   <p class="topless"><a href="status.html"
-                        title="previous chapter">5.2.19. status</a></p>
+                        title="previous chapter">6.2.19. status</a></p>
   <h4>Next topic</h4>
   <p class="topless"><a href="table_create.html"
-                        title="next chapter">5.2.21. table_create</a></p>
+                        title="next chapter">6.2.21. table_create</a></p>
   <h3>This Page</h3>
   <ul class="this-page-menu">
     <li><a href="../_sources/commands/suggest.txt"
@@ -195,14 +381,14 @@
           <a href="../genindex.html" title="General Index"
              >index</a></li>
         <li class="right" >
-          <a href="table_create.html" title="5.2.21. table_create"
+          <a href="table_create.html" title="6.2.21. table_create"
              >next</a> |</li>
         <li class="right" >
-          <a href="status.html" title="5.2.19. status"
+          <a href="status.html" title="6.2.19. status"
              >previous</a> |</li>
-        <li><a href="../index.html">groonga v1.2.4 documentation</a> &raquo;</li>
-          <li><a href="../reference.html" >5. リファレンスマニュアル</a> &raquo;</li>
-          <li><a href="../commands.html" >5.2. コマンド</a> &raquo;</li>
+        <li><a href="../index.html">groonga v1.2.5 documentation</a> &raquo;</li>
+          <li><a href="../reference.html" >6. リファレンスマニュアル</a> &raquo;</li>
+          <li><a href="../commands.html" >6.2. コマンド</a> &raquo;</li>
       </ul>
     </div>
     <div class="footer">