RubyGems - rroonga - Versions diffs - 5.0.0-x64-mingw32 → 5.0.1-x64-mingw32 - Mend

rroonga 5.0.0-x64-mingw32 → 5.0.1-x64-mingw32

Files changed (733) hide show

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

@@ -7,7 +7,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>7.3.32. suggest &mdash; Groonga v5.0.0 documentation</title>
+    <title>7.3.36. suggest &mdash; Groonga v5.0.1-42-g4d10df1 documentation</title>
     <link rel="stylesheet" href="../../_static/groonga.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
@@ -15,7 +15,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../../',
-        VERSION:     '5.0.0',
+        VERSION:     '5.0.1-42-g4d10df1',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -25,12 +25,12 @@
     <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 v5.0.0 documentation" href="../../index.html" />
+    <link rel="top" title="Groonga v5.0.1-42-g4d10df1 documentation" href="../../index.html" />
     <link rel="up" title="7.3. Command" href="../command.html" />
-    <link rel="next" title="7.3.33. table_create" href="table_create.html" />
-    <link rel="prev" title="7.3.31. status" href="status.html" />
+    <link rel="next" title="7.3.37. table_create" href="table_create.html" />
+    <link rel="prev" title="7.3.35. status" href="status.html" />
   </head>
-  <body role="document">
+  <body>
 <div class="header">
   <h1 class="title">
     <a id="top-link" href="../../index.html">
@@ -48,19 +48,19 @@
 </div>
-    <div class="related" role="navigation" aria-label="related navigation">
+    <div class="related">
       <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_create.html" title="7.3.33. table_create"
+          <a href="table_create.html" title="7.3.37. table_create"
              accesskey="N">next</a> |</li>
         <li class="right" >
-          <a href="status.html" title="7.3.31. status"
+          <a href="status.html" title="7.3.35. status"
              accesskey="P">previous</a> |</li>
-        <li><a href="../../index.html">Groonga v5.0.0 documentation</a> &raquo;</li>
+        <li><a href="../../index.html">Groonga v5.0.1-42-g4d10df1 documentation</a> &raquo;</li>
           <li><a href="../../reference.html" >7. Reference manual</a> &raquo;</li>
           <li><a href="../command.html" accesskey="U">7.3. Command</a> &raquo;</li>
       </ul>
@@ -69,17 +69,17 @@
     <div class="document">
       <div class="documentwrapper">
         <div class="bodywrapper">
-          <div class="body" role="main">
+          <div class="body">
   <div class="section" id="suggest">
-<h1>7.3.32. <code class="docutils literal"><span class="pre">suggest</span></code><a class="headerlink" href="#suggest" title="Permalink to this headline">¶</a></h1>
+<h1>7.3.36. <tt class="docutils literal"><span class="pre">suggest</span></tt><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="summary">
-<h2>7.3.32.1. Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
+<h2>7.3.36.1. 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>
@@ -87,13 +87,13 @@ suggestion for a specified query.</p>
 correction and suggestion.</p>
 </div>
 <div class="section" id="syntax">
-<h2>7.3.32.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2>
+<h2>7.3.36.2. Syntax<a class="headerlink" href="#syntax" 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="usage">
-<h2>7.3.32.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
+<h2>7.3.36.3. 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"><div class="highlight"><pre>load --table event_query --each &#39;suggest_preparer(_id, type, item, sequence, time, pair_query)&#39;
@@ -318,23 +318,23 @@ correction and suggestion.</p>
 </div>
 </div>
 <div class="section" id="parameters">
-<h2>7.3.32.4. Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
+<h2>7.3.36.4. Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
 <dl class="docutils">
-<dt><code class="docutils literal"><span class="pre">types</span></code></dt>
-<dd><p class="first">It specifies what types are returned by the suggest
+<dt><tt class="docutils literal"><span class="pre">types</span></tt></dt>
+<dd><p class="first">Specifies what types are returned by the suggest
 command.</p>
 <p>Here are available types:</p>
 <blockquote>
 <div><dl class="docutils">
-<dt><code class="docutils literal"><span class="pre">complete</span></code></dt>
+<dt><tt class="docutils literal"><span class="pre">complete</span></tt></dt>
 <dd>The suggest command does completion.</dd>
-<dt><code class="docutils literal"><span class="pre">correct</span></code></dt>
+<dt><tt class="docutils literal"><span class="pre">correct</span></tt></dt>
 <dd>The suggest command does correction.</dd>
-<dt><code class="docutils literal"><span class="pre">suggest</span></code></dt>
+<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 <code class="docutils literal"><span class="pre">|</span></code>.
+<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>
@@ -351,115 +351,115 @@ Here are examples:</p>
 </div>
 </div></blockquote>
 </dd>
-<dt><code class="docutils literal"><span class="pre">table</span></code></dt>
-<dd><p class="first">It specifies table name that has <code class="docutils literal"><span class="pre">item_${DATA_SET_NAME}</span></code> format.
-For example, <code class="docutils literal"><span class="pre">item_query</span></code> is a table name if you created
+<dt><tt class="docutils literal"><span class="pre">table</span></tt></dt>
+<dd><p class="first">Specifies table name that has <tt class="docutils literal"><span class="pre">item_${DATA_SET_NAME}</span></tt> format.
+For example, <tt class="docutils literal"><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><code class="docutils literal"><span class="pre">column</span></code></dt>
-<dd>It specifies a column name that has furigana in
-Katakana in <code class="docutils literal"><span class="pre">table</span></code> table.</dd>
-<dt><code class="docutils literal"><span class="pre">query</span></code></dt>
-<dd>It specifies query for completion, correction and/or
+<dt><tt class="docutils literal"><span class="pre">column</span></tt></dt>
+<dd>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>Specifies query for completion, correction and/or
 suggestion.</dd>
-<dt><code class="docutils literal"><span class="pre">sortby</span></code></dt>
-<dd><p class="first">It specifies sort key.</p>
+<dt><tt class="docutils literal"><span class="pre">sortby</span></tt></dt>
+<dd><p class="first">Specifies sort key.</p>
 <dl class="last docutils">
 <dt>Default:</dt>
-<dd><code class="docutils literal"><span class="pre">-_score</span></code></dd>
+<dd><tt class="docutils literal"><span class="pre">-_score</span></tt></dd>
 </dl>
 </dd>
-<dt><code class="docutils literal"><span class="pre">output_columns</span></code></dt>
-<dd><p class="first">It specifies output columns.</p>
+<dt><tt class="docutils literal"><span class="pre">output_columns</span></tt></dt>
+<dd><p class="first">Specifies output columns.</p>
 <dl class="last docutils">
 <dt>Default:</dt>
-<dd><code class="docutils literal"><span class="pre">_key,_score</span></code></dd>
+<dd><tt class="docutils literal"><span class="pre">_key,_score</span></tt></dd>
 </dl>
 </dd>
-<dt><code class="docutils literal"><span class="pre">offset</span></code></dt>
-<dd><p class="first">It specifies returned records offset.</p>
+<dt><tt class="docutils literal"><span class="pre">offset</span></tt></dt>
+<dd><p class="first">Specifies returned records offset.</p>
 <dl class="last docutils">
 <dt>Default:</dt>
-<dd><code class="docutils literal"><span class="pre">0</span></code></dd>
+<dd><tt class="docutils literal"><span class="pre">0</span></tt></dd>
 </dl>
 </dd>
-<dt><code class="docutils literal"><span class="pre">limit</span></code></dt>
-<dd><p class="first">It specifies number of returned records.</p>
+<dt><tt class="docutils literal"><span class="pre">limit</span></tt></dt>
+<dd><p class="first">Specifies number of returned records.</p>
 <dl class="last docutils">
 <dt>Default:</dt>
-<dd><code class="docutils literal"><span class="pre">10</span></code></dd>
+<dd><tt class="docutils literal"><span class="pre">10</span></tt></dd>
 </dl>
 </dd>
-<dt><code class="docutils literal"><span class="pre">frequency_threshold</span></code></dt>
-<dd><p class="first">It specifies threshold for item frequency. Returned records must have
-<code class="docutils literal"><span class="pre">_score</span></code> that is greater than or equal to <code class="docutils literal"><span class="pre">frequency_threshold</span></code>.</p>
+<dt><tt class="docutils literal"><span class="pre">frequency_threshold</span></tt></dt>
+<dd><p class="first">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><code class="docutils literal"><span class="pre">100</span></code></dd>
+<dd><tt class="docutils literal"><span class="pre">100</span></tt></dd>
 </dl>
 </dd>
 </dl>
-<p><code class="docutils literal"><span class="pre">conditional_probability_threshold</span></code></p>
+<p><tt class="docutils literal"><span class="pre">conditional_probability_threshold</span></tt></p>
 <blockquote>
-<div><p>It specifies threshold for conditional
+<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"><span class="pre">query</span></code>
+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
-<code class="docutils literal"><span class="pre">conditional_probability_threshold</span></code>.</p>
+<tt class="docutils literal"><span class="pre">conditional_probability_threshold</span></tt>.</p>
 <dl class="docutils">
 <dt>Default:</dt>
-<dd><code class="docutils literal"><span class="pre">0.2</span></code></dd>
+<dd><tt class="docutils literal"><span class="pre">0.2</span></tt></dd>
 </dl>
 </div></blockquote>
 <dl class="docutils">
-<dt><code class="docutils literal"><span class="pre">prefix_search</span></code></dt>
-<dd><p class="first">It specifies whether optional prefix search is used or not
+<dt><tt class="docutils literal"><span class="pre">prefix_search</span></tt></dt>
+<dd><p class="first">Specifies whether optional prefix search is used or not
 in completion.</p>
 <p>Here are available values:</p>
 <blockquote>
 <div><dl class="docutils">
-<dt><code class="docutils literal"><span class="pre">yes</span></code></dt>
+<dt><tt class="docutils literal"><span class="pre">yes</span></tt></dt>
 <dd>Prefix search is always used.</dd>
-<dt><code class="docutils literal"><span class="pre">no</span></code></dt>
+<dt><tt class="docutils literal"><span class="pre">no</span></tt></dt>
 <dd>Prefix search is never used.</dd>
-<dt><code class="docutils literal"><span class="pre">auto</span></code></dt>
+<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>
 <dl class="last docutils">
 <dt>Default:</dt>
-<dd><code class="docutils literal"><span class="pre">auto</span></code></dd>
+<dd><tt class="docutils literal"><span class="pre">auto</span></tt></dd>
 </dl>
 </dd>
-<dt><code class="docutils literal"><span class="pre">similar_search</span></code></dt>
-<dd><p class="first">It specifies whether optional similar search is used or not
+<dt><tt class="docutils literal"><span class="pre">similar_search</span></tt></dt>
+<dd><p class="first">Specifies whether optional similar search is used or not
 in correction.</p>
 <p>Here are available values:</p>
 <blockquote>
 <div><dl class="docutils">
-<dt><code class="docutils literal"><span class="pre">yes</span></code></dt>
+<dt><tt class="docutils literal"><span class="pre">yes</span></tt></dt>
 <dd>Similar search is always used.</dd>
-<dt><code class="docutils literal"><span class="pre">no</span></code></dt>
+<dt><tt class="docutils literal"><span class="pre">no</span></tt></dt>
 <dd>Similar search is never used.</dd>
-<dt><code class="docutils literal"><span class="pre">auto</span></code></dt>
+<dt><tt class="docutils literal"><span class="pre">auto</span></tt></dt>
 <dd>Similar search is used only when other search can't
 find any records.</dd>
 </dl>
 </div></blockquote>
 <dl class="last docutils">
 <dt>Default:</dt>
-<dd><code class="docutils literal"><span class="pre">auto</span></code></dd>
+<dd><tt class="docutils literal"><span class="pre">auto</span></tt></dd>
 </dl>
 </dd>
 </dl>
 </div>
 <div class="section" id="return-value">
-<h2>7.3.32.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
+<h2>7.3.36.5. 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"><div class="highlight"><pre>{&quot;type1&quot;: [[&quot;candidate1&quot;, score of candidate1],
            [&quot;candidate2&quot;, score of candidate2],
@@ -470,22 +470,22 @@ find any records.</dd>
  ...}
 </pre></div>
 </div>
-<p><code class="docutils literal"><span class="pre">type</span></code></p>
+<p><tt class="docutils literal"><span class="pre">type</span></tt></p>
 <blockquote>
-<div>A type specified by <code class="docutils literal"><span class="pre">types</span></code>.</div></blockquote>
-<p><code class="docutils literal"><span class="pre">candidate</span></code></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>A candidate for completion, correction or suggestion.</div></blockquote>
-<p><code class="docutils literal"><span class="pre">score</span> <span class="pre">of</span> <span class="pre">candidate</span></code></p>
+<p><tt class="docutils literal"><span class="pre">score</span> <span class="pre">of</span> <span class="pre">candidate</span></tt></p>
 <blockquote>
-<div>A score of corresponding <code class="docutils literal"><span class="pre">candidate</span></code>. It means that
+<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 <code class="docutils literal"><span class="pre">score</span> <span class="pre">of</span> <span class="pre">candidate</span></code> descending by
+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="see-also">
-<h2>7.3.32.6. See also<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
+<h2>7.3.36.6. 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>
@@ -497,35 +497,33 @@ default.</div></blockquote>
           </div>
         </div>
       </div>
-      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+      <div class="sphinxsidebar">
         <div class="sphinxsidebarwrapper">
   <h3><a href="../../index.html">Table Of Contents</a></h3>
   <ul>
-<li><a class="reference internal" href="#">7.3.32. <code class="docutils literal"><span class="pre">suggest</span></code></a><ul>
-<li><a class="reference internal" href="#summary">7.3.32.1. Summary</a></li>
-<li><a class="reference internal" href="#syntax">7.3.32.2. Syntax</a></li>
-<li><a class="reference internal" href="#usage">7.3.32.3. Usage</a></li>
-<li><a class="reference internal" href="#parameters">7.3.32.4. Parameters</a></li>
-<li><a class="reference internal" href="#return-value">7.3.32.5. Return value</a></li>
-<li><a class="reference internal" href="#see-also">7.3.32.6. See also</a></li>
+<li><a class="reference internal" href="#">7.3.36. <tt class="docutils literal"><span class="pre">suggest</span></tt></a><ul>
+<li><a class="reference internal" href="#summary">7.3.36.1. Summary</a></li>
+<li><a class="reference internal" href="#syntax">7.3.36.2. Syntax</a></li>
+<li><a class="reference internal" href="#usage">7.3.36.3. Usage</a></li>
+<li><a class="reference internal" href="#parameters">7.3.36.4. Parameters</a></li>
+<li><a class="reference internal" href="#return-value">7.3.36.5. Return value</a></li>
+<li><a class="reference internal" href="#see-also">7.3.36.6. See also</a></li>
 </ul>
 </li>
 </ul>
   <h4>Previous topic</h4>
   <p class="topless"><a href="status.html"
-                        title="previous chapter">7.3.31. <code class="docutils literal"><span class="pre">status</span></code></a></p>
+                        title="previous chapter">7.3.35. <tt class="docutils literal"><span class="pre">status</span></tt></a></p>
   <h4>Next topic</h4>
   <p class="topless"><a href="table_create.html"
-                        title="next chapter">7.3.33. <code class="docutils literal"><span class="pre">table_create</span></code></a></p>
-  <div role="note" aria-label="source link">
-    <h3>This Page</h3>
-    <ul class="this-page-menu">
-      <li><a href="../../_sources/reference/commands/suggest.txt"
-            rel="nofollow">Show Source</a></li>
-    </ul>
-   </div>
-<div id="searchbox" style="display: none" role="search">
+                        title="next chapter">7.3.37. <tt class="docutils literal"><span class="pre">table_create</span></tt></a></p>
+  <h3>This Page</h3>
+  <ul class="this-page-menu">
+    <li><a href="../../_sources/reference/commands/suggest.txt"
+           rel="nofollow">Show Source</a></li>
+  </ul>
+<div id="searchbox" style="display: none">
   <h3>Quick search</h3>
     <form class="search" action="../../search.html" method="get">
       <input type="text" name="q" />
@@ -542,24 +540,24 @@ default.</div></blockquote>
       </div>
       <div class="clearer"></div>
     </div>
-    <div class="related" role="navigation" aria-label="related navigation">
+    <div class="related">
       <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_create.html" title="7.3.33. table_create"
+          <a href="table_create.html" title="7.3.37. table_create"
              >next</a> |</li>
         <li class="right" >
-          <a href="status.html" title="7.3.31. status"
+          <a href="status.html" title="7.3.35. status"
              >previous</a> |</li>
-        <li><a href="../../index.html">Groonga v5.0.0 documentation</a> &raquo;</li>
+        <li><a href="../../index.html">Groonga v5.0.1-42-g4d10df1 documentation</a> &raquo;</li>
           <li><a href="../../reference.html" >7. Reference manual</a> &raquo;</li>
           <li><a href="../command.html" >7.3. Command</a> &raquo;</li>
       </ul>
     </div>
-    <div class="footer" role="contentinfo">
+    <div class="footer">
         &copy; Copyright 2009-2015, Brazil, Inc.
     </div>
   </body>