<!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 — groonga v1.2.6 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.6',
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.6 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.6 documentation</a> »</li>
<li><a href="../suggest.html" accesskey="U">5. Suggest</a> »</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>"groonga"</li>
<li>"complete"</li>
<li>"correction"</li>
<li>"suggest"</li>
</ul>
<p>An user inputs "co" and groonga returns "complete" and
"correction" because they starts with "co".</p>
<p>An user inputs "sug" and groonga returns "suggest" because
"suggest" starts with "sug".</p>
<p>An user inputs "ab" and groonga returns nothing because no
word starts with "ab".</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 "gronga" and groonga returns "groonga" because
"gronga" is in wrong word and corresponding correct word is
"groonga".</p>
<p>An user inputs "roonga" and groonga returns nothing because
"roonga" 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 "groonga" and groonga returns "groonga search
engine" because "groonga" is in keyword column and related
query column is "groonga search engine".</p>
<p>An user inputs "MySQL" and groonga returns nothing because
"MySQL" 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.6 documentation</a> »</li>
<li><a href="../suggest.html" >5. Suggest</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2009-2011, Brazil, Inc.
</div>
</body>
</html>
