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/suggest/correction.html ADDED Viewed

@@ -0,0 +1,286 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <title>5.4. Correction &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" />
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '../',
+        VERSION:     '1.2.5',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true
+      };
+    </script>
+    <script type="text/javascript" src="../_static/jquery.js"></script>
+    <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.5 documentation" href="../index.html" />
+    <link rel="up" title="5. Suggest" href="../suggest.html" />
+    <link rel="next" title="5.5. Suggestion" href="suggestion.html" />
+    <link rel="prev" title="5.3. Completion" href="completion.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/suggest/correction.html"><img src="../_static/jp.png" alt="日本語"></a></li>
+    </ul>
+  </div>
+</div>
+    <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="suggestion.html" title="5.5. Suggestion"
+             accesskey="N">next</a> |</li>
+        <li class="right" >
+          <a href="completion.html" title="5.3. Completion"
+             accesskey="P">previous</a> |</li>
+        <li><a href="../index.html">groonga v1.2.5 documentation</a> &raquo;</li>
+          <li><a href="../suggest.html" accesskey="U">5. Suggest</a> &raquo;</li>
+      </ul>
+    </div>
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body">
+  <div class="section" id="correction">
+<h1>5.4. Correction<a class="headerlink" href="#correction" title="Permalink to this headline">¶</a></h1>
+<p>This section describes about the following correction
+features:</p>
+<ul class="simple">
+<li>How it works</li>
+<li>How to use</li>
+<li>How to learn</li>
+</ul>
+<div class="section" id="how-it-works">
+<h2>5.4.1. How it works<a class="headerlink" href="#how-it-works" title="Permalink to this headline">¶</a></h2>
+<p>The correction feature uses three searches to compute corrected
+words:</p>
+<blockquote>
+<div><ol class="arabic simple">
+<li>Cooccurrence search against learned data.</li>
+<li>Similar search against registered words. (optional)</li>
+</ol>
+</div></blockquote>
+<div class="section" id="cooccurrence-search">
+<h3>5.4.1.1. Cooccurrence search<a class="headerlink" href="#cooccurrence-search" title="Permalink to this headline">¶</a></h3>
+<p>Cooccurrence search can find registered words from user's
+wrong input. It uses user submit sequences that will be
+learned from query logs, access logs and so on.</p>
+<p>For example, there are the following user submissions:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="41%" />
+<col width="59%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">query</th>
+<th class="head">time</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>serach (typo!)</td>
+<td>2011-08-10T22:20:50+09:00</td>
+</tr>
+<tr class="row-odd"><td>search (fixed!)</td>
+<td>2011-08-10T22:20:52+09:00</td>
+</tr>
+</tbody>
+</table>
+<p>Groonga creates the following correction pair from the above
+submissions:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="33%" />
+<col width="67%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">input</th>
+<th class="head">corrected word</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>serach</td>
+<td>search</td>
+</tr>
+</tbody>
+</table>
+<p>Groonga treats continuous submissions within a minute as
+input correction by user. Not submitted user input sequence
+between two submissions isn't used as learned data for
+correction.</p>
+<p>If an user inputs &quot;serach&quot; and cooccurrence search returns
+&quot;search&quot; because &quot;serach&quot; is in input column and
+corresponding corrected word column value is &quot;search&quot;.</p>
+</div>
+<div class="section" id="similar-search">
+<h3>5.4.1.2. Similar search<a class="headerlink" href="#similar-search" title="Permalink to this headline">¶</a></h3>
+<p>Similar search can find registered words that has one or
+more the same tokens as user input. TokenBigram tokenizer is
+used for tokenization because suggest dataset schema
+created by <a class="reference internal" href="../executables/groonga-suggest-create-dataset.html"><em>groonga-suggest-create-dataset</em></a>
+uses TokenBigram tokenizer as the default tokenizer.</p>
+<p>For example, there is a registered query &quot;search engine&quot;. An
+user can find &quot;search engine&quot; by &quot;web search service&quot;,
+&quot;sound engine&quot; and so on. Because &quot;search engine&quot; and &quot;web
+search engine&quot; have the same token &quot;search&quot; and &quot;search
+engine&quot; and &quot;sound engine&quot; have the same token &quot;engine&quot;.</p>
+<p>&quot;search engine&quot; is tokenized to &quot;search&quot; and &quot;engine&quot;
+tokens. (Groonga's TokenBigram tokenizer doesn't tokenize
+two characters for continuous alphabets and continuous
+digits for reducing search
+noise. TokenBigramSplitSymbolAlphaDigit tokenizer should be
+used to ensure tokenizing to two characters.) &quot;web search
+service&quot; is tokenized to &quot;web&quot;, &quot;search&quot; and
+&quot;service&quot;. &quot;sound engine&quot; is tokenized to &quot;sound&quot; and
+&quot;engine&quot;.</p>
+</div>
+</div>
+<div class="section" id="how-to-use">
+<h2>5.4.2. 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"><em>suggest</em></a> command to use
+correction. <cite>--type correct</cite> option requests corrections.</p>
+<p>For example, here is an command to get correction results by
+&quot;saerch&quot;:</p>
+<p>Execution example:</p>
+<div class="highlight-none"><div class="highlight"><pre>&gt; suggest --table item_query --column kana --types correction --threshold 1 --query saerch
+[[0,1313131812.39207,0.000783031],{&quot;correct&quot;:[[1],[[&quot;_key&quot;,&quot;ShortText&quot;],[&quot;_score&quot;,&quot;Int32&quot;]],[&quot;search&quot;,1]]}]
+</pre></div>
+</div>
+</div>
+<div class="section" id="how-it-learns">
+<h2>5.4.3. 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 submit inputs with time stamp.</p>
+<p>For example, an user wants to search by &quot;search&quot; but the
+user has typo &quot;saerch&quot; before inputs the correct query. The
+user inputs the query with the following sequence:</p>
+<blockquote>
+<div><ol class="arabic simple">
+<li>2011-08-10T13:33:23+09:00: s</li>
+<li>2011-08-10T13:33:23+09:00: sa</li>
+<li>2011-08-10T13:33:24+09:00: sae</li>
+<li>2011-08-10T13:33:24+09:00: saer</li>
+<li>2011-08-10T13:33:24+09:00: saerc</li>
+<li>2011-08-10T13:33:25+09:00: saerch (submit!)</li>
+<li>2011-08-10T13:33:29+09:00: serch (correcting...)</li>
+<li>2011-08-10T13:33:30+09:00: search (submit!)</li>
+</ol>
+</div></blockquote>
+<p>Groonga can be learned from the input sequence by the
+following command:</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;
+[
+{&quot;sequence&quot;: &quot;1&quot;, &quot;time&quot;: 1312950803.86057, &quot;item&quot;: &quot;s&quot;},
+{&quot;sequence&quot;: &quot;1&quot;, &quot;time&quot;: 1312950803.96857, &quot;item&quot;: &quot;sa&quot;},
+{&quot;sequence&quot;: &quot;1&quot;, &quot;time&quot;: 1312950804.26057, &quot;item&quot;: &quot;sae&quot;},
+{&quot;sequence&quot;: &quot;1&quot;, &quot;time&quot;: 1312950804.56057, &quot;item&quot;: &quot;saer&quot;},
+{&quot;sequence&quot;: &quot;1&quot;, &quot;time&quot;: 1312950804.76057, &quot;item&quot;: &quot;saerc&quot;},
+{&quot;sequence&quot;: &quot;1&quot;, &quot;time&quot;: 1312950805.76057, &quot;item&quot;: &quot;saerch&quot;, &quot;type&quot;: &quot;submit&quot;},
+{&quot;sequence&quot;: &quot;1&quot;, &quot;time&quot;: 1312950809.76057, &quot;item&quot;: &quot;serch&quot;},
+{&quot;sequence&quot;: &quot;1&quot;, &quot;time&quot;: 1312950810.86057, &quot;item&quot;: &quot;search&quot;, &quot;type&quot;: &quot;submit&quot;}
+]
+</pre></div>
+</div>
+</div>
+</div>
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar">
+        <div class="sphinxsidebarwrapper">
+  <h3><a href="../index.html">Table Of Contents</a></h3>
+  <ul>
+<li><a class="reference internal" href="#">5.4. Correction</a><ul>
+<li><a class="reference internal" href="#how-it-works">5.4.1. How it works</a><ul>
+<li><a class="reference internal" href="#cooccurrence-search">5.4.1.1. Cooccurrence search</a></li>
+<li><a class="reference internal" href="#similar-search">5.4.1.2. Similar search</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#how-to-use">5.4.2. How to use</a></li>
+<li><a class="reference internal" href="#how-it-learns">5.4.3. How it learns</a></li>
+</ul>
+</li>
+</ul>
+  <h4>Previous topic</h4>
+  <p class="topless"><a href="completion.html"
+                        title="previous chapter">5.3. Completion</a></p>
+  <h4>Next topic</h4>
+  <p class="topless"><a href="suggestion.html"
+                        title="next chapter">5.5. Suggestion</a></p>
+  <h3>This Page</h3>
+  <ul class="this-page-menu">
+    <li><a href="../_sources/suggest/correction.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" size="18" />
+      <input type="submit" value="Go" />
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+    <p class="searchtip" style="font-size: 90%">
+    Enter search terms or a module, class or function name.
+    </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <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="suggestion.html" title="5.5. Suggestion"
+             >next</a> |</li>
+        <li class="right" >
+          <a href="completion.html" title="5.3. Completion"
+             >previous</a> |</li>
+        <li><a href="../index.html">groonga v1.2.5 documentation</a> &raquo;</li>
+          <li><a href="../suggest.html" >5. Suggest</a> &raquo;</li>
+      </ul>
+    </div>
+    <div class="footer">
+        &copy; Copyright 2009-2011, Brazil, Inc.
+    </div>
+  </body>
+</html>

data/vendor/local/share/doc/groonga/en/html/suggest/introduction.html ADDED Viewed

@@ -0,0 +1,243 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <title>5.1. Introduction &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" />
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '../',
+        VERSION:     '1.2.5',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true
+      };
+    </script>
+    <script type="text/javascript" src="../_static/jquery.js"></script>
+    <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.5 documentation" href="../index.html" />
+    <link rel="up" title="5. Suggest" href="../suggest.html" />
+    <link rel="next" title="5.2. Tutorial" href="tutorial.html" />
+    <link rel="prev" title="5. Suggest" href="../suggest.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/suggest/introduction.html"><img src="../_static/jp.png" alt="日本語"></a></li>
+    </ul>
+  </div>
+</div>
+    <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="tutorial.html" title="5.2. Tutorial"
+             accesskey="N">next</a> |</li>
+        <li class="right" >
+          <a href="../suggest.html" title="5. Suggest"
+             accesskey="P">previous</a> |</li>
+        <li><a href="../index.html">groonga v1.2.5 documentation</a> &raquo;</li>
+          <li><a href="../suggest.html" accesskey="U">5. Suggest</a> &raquo;</li>
+      </ul>
+    </div>
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body">
+  <div class="section" id="introduction">
+<h1>5.1. Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h1>
+<p>The suggest feature in groonga provides the following features:</p>
+<ul class="simple">
+<li>Completion</li>
+<li>Correction</li>
+<li>Suggestion</li>
+</ul>
+<div class="section" id="completion">
+<h2>5.1.1. Completion<a class="headerlink" href="#completion" title="Permalink to this headline">¶</a></h2>
+<p>Completion helps user input. If user inputs a partial word,
+groonga can return complete words from registered
+words.</p>
+<p>For example, there are registered words:</p>
+<ul class="simple">
+<li>&quot;groonga&quot;</li>
+<li>&quot;complete&quot;</li>
+<li>&quot;correction&quot;</li>
+<li>&quot;suggest&quot;</li>
+</ul>
+<p>An user inputs &quot;co&quot; and groonga returns &quot;complete&quot; and
+&quot;correction&quot; because they starts with &quot;co&quot;.</p>
+<p>An user inputs &quot;sug&quot; and groonga returns &quot;suggest&quot; because
+&quot;suggest&quot; starts with &quot;sug&quot;.</p>
+<p>An user inputs &quot;ab&quot; and groonga returns nothing because no
+word starts with &quot;ab&quot;.</p>
+</div>
+<div class="section" id="correction">
+<h2>5.1.2. Correction<a class="headerlink" href="#correction" title="Permalink to this headline">¶</a></h2>
+<p>Correction also helps user input. If user inputs a wrong
+word, groonga can return correct words from registered
+correction pairs.</p>
+<p>For example, there are registered correction pairs:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="46%" />
+<col width="54%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">wrong word</th>
+<th class="head">correct word</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>grroonga
+gronga
+gronnga</td>
+<td>groonga
+groonga
+groonga</td>
+</tr>
+</tbody>
+</table>
+<p>An user inputs &quot;gronga&quot; and groonga returns &quot;groonga&quot; because
+&quot;gronga&quot; is in wrong word and corresponding correct word is
+&quot;groonga&quot;.</p>
+<p>An user inputs &quot;roonga&quot; and groonga returns nothing because
+&quot;roonga&quot; isn't in wrong word.</p>
+</div>
+<div class="section" id="suggestion">
+<h2>5.1.3. Suggestion<a class="headerlink" href="#suggestion" title="Permalink to this headline">¶</a></h2>
+<p>Suggestion helps that user filters many found documents. If
+user inputs a query, groonga can return new queries that has
+more additional keywords from registered related query
+pairs.</p>
+<p>For example, there are registered related query pairs:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="52%" />
+<col width="48%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">keyword</th>
+<th class="head">related query</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>groonga</td>
+<td>groonga search engine</td>
+</tr>
+<tr class="row-odd"><td>search</td>
+<td>Google search</td>
+</tr>
+<tr class="row-even"><td>speed</td>
+<td>groonga speed</td>
+</tr>
+</tbody>
+</table>
+<p>An user inputs &quot;groonga&quot; and groonga returns &quot;groonga search
+engine&quot; because &quot;groonga&quot; is in keyword column and related
+query column is &quot;groonga search engine&quot;.</p>
+<p>An user inputs &quot;MySQL&quot; and groonga returns nothing because
+&quot;MySQL&quot; isn't in keyword column values.</p>
+</div>
+<div class="section" id="learning">
+<h2>5.1.4. Learning<a class="headerlink" href="#learning" title="Permalink to this headline">¶</a></h2>
+<p>The suggest feature requires registered data before using
+the feature. Those data can be registered from user inputs.
+Gronnga-suggest-httpd and groonga-suggest-learner commands
+are provided for the propose.</p>
+</div>
+</div>
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar">
+        <div class="sphinxsidebarwrapper">
+  <h3><a href="../index.html">Table Of Contents</a></h3>
+  <ul>
+<li><a class="reference internal" href="#">5.1. Introduction</a><ul>
+<li><a class="reference internal" href="#completion">5.1.1. Completion</a></li>
+<li><a class="reference internal" href="#correction">5.1.2. Correction</a></li>
+<li><a class="reference internal" href="#suggestion">5.1.3. Suggestion</a></li>
+<li><a class="reference internal" href="#learning">5.1.4. Learning</a></li>
+</ul>
+</li>
+</ul>
+  <h4>Previous topic</h4>
+  <p class="topless"><a href="../suggest.html"
+                        title="previous chapter">5. Suggest</a></p>
+  <h4>Next topic</h4>
+  <p class="topless"><a href="tutorial.html"
+                        title="next chapter">5.2. Tutorial</a></p>
+  <h3>This Page</h3>
+  <ul class="this-page-menu">
+    <li><a href="../_sources/suggest/introduction.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" size="18" />
+      <input type="submit" value="Go" />
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+    <p class="searchtip" style="font-size: 90%">
+    Enter search terms or a module, class or function name.
+    </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <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="tutorial.html" title="5.2. Tutorial"
+             >next</a> |</li>
+        <li class="right" >
+          <a href="../suggest.html" title="5. Suggest"
+             >previous</a> |</li>
+        <li><a href="../index.html">groonga v1.2.5 documentation</a> &raquo;</li>
+          <li><a href="../suggest.html" >5. Suggest</a> &raquo;</li>
+      </ul>
+    </div>
+    <div class="footer">
+        &copy; Copyright 2009-2011, Brazil, Inc.
+    </div>
+  </body>
+</html>