RubyGems - rroonga - Versions diffs - 5.0.5-x86-mingw32 → 5.0.8-x86-mingw32 - Mend

rroonga 5.0.5-x86-mingw32 → 5.0.8-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 (594) hide show

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

@@ -7,7 +7,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>7.11. Scorer &mdash; Groonga v5.0.6-226-gd7da7e7 documentation</title>
+    <title>7.11. Scorer &mdash; Groonga v5.0.7-264-ga2dae20 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.6-226-gd7da7e7',
+        VERSION:     '5.0.7-264-ga2dae20',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -25,7 +25,7 @@
     <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.6-226-gd7da7e7 documentation" href="../index.html" />
+    <link rel="top" title="Groonga v5.0.7-264-ga2dae20 documentation" href="../index.html" />
     <link rel="up" title="7. Reference manual" href="../reference.html" />
     <link rel="next" title="7.11.3.1. scorer_tf_at_most" href="scorers/scorer_tf_at_most.html" />
     <link rel="prev" title="7.10.1. QueryExpanderTSV" href="query_expanders/tsv.html" />
@@ -60,7 +60,7 @@
         <li class="right" >
           <a href="query_expanders/tsv.html" title="7.10.1. QueryExpanderTSV"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">Groonga v5.0.6-226-gd7da7e7 documentation</a> &raquo;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">Groonga v5.0.7-264-ga2dae20 documentation</a> &raquo;</li>
           <li class="nav-item nav-item-1"><a href="../reference.html" accesskey="U">7. Reference manual</a> &raquo;</li>
       </ul>
     </div>
@@ -89,26 +89,18 @@ keyword, keyword ... and keyword&quot;. Search engine spammer may use
 the technique.</li>
 </ul>
 </div></blockquote>
-<p>Score function can solve these cases. For example, <a class="reference external" href="http://en.wikipedia.org/wiki/Tf%E2%80%93idf">TF-IDF</a> (term
+<p>Score function can solve these cases. For example, <a class="reference external" href="https://en.wikipedia.org/wiki/Tf%E2%80%93idf">TF-IDF</a> (term
 frequency-inverse document frequency) can solve the first case.
-<a class="reference external" href="http://en.wikipedia.org/wiki/Okapi_BM25">Okapi BM25</a> can solve the
+<a class="reference external" href="https://en.wikipedia.org/wiki/Okapi_BM25">Okapi BM25</a> can solve the
 second case. But their are slower than TF.</p>
 <p>Groonga provides TF-IDF based scorer as
 <a class="reference internal" href="scorers/scorer_tf_idf.html"><em>scorer_tf_idf</em></a> but doesn't provide Okapi BM25
 based scorer yet.</p>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">orphan:</th><td class="field-body"></td>
-</tr>
-</tbody>
-</table>
 <blockquote id="note">
 <div><p>You don't need to resolve scoring only by score function. Score
 function is highly depends on search query. You may be able to use
 metadata of matched record.</p>
-<p>For example, Google uses <a class="reference external" href="http://en.wikipedia.org/wiki/PageRank">PageRank</a> for scoring. You may be
+<p>For example, Google uses <a class="reference external" href="https://en.wikipedia.org/wiki/PageRank">PageRank</a> for scoring. You may be
 able to use data type (&quot;title&quot; data are important rather than
 &quot;memo&quot; data), tag, geolocation and so on.</p>
 <p>Please stop to think about only score function for scoring.</p>
@@ -345,13 +337,50 @@ scorer, <code class="docutils literal"><span class="pre">_score</span></code> is
 Because the scorer used in the <code class="docutils literal"><span class="pre">select</span></code> command limits the maximum
 score value to <code class="docutils literal"><span class="pre">2</span></code>.</p>
 <p>Here is an example that uses multiple scorers:</p>
-<div class="highlight-none"><div class="highlight"><pre>.. groonga-command
-.. include:: ../example/reference/scorer/usage_multiple_scorers.log
-.. select Memos \
-..   --match_columns &quot;scorer_tf_idf(title) || scorer_tf_at_most(content, 2.0)&quot; \
-..   --query &quot;Groonga&quot; \
-..   --output_columns &quot;title, content, _score&quot; \
-..   --sortby &quot;-_score&quot;
+<p>Execution example:</p>
+<div class="highlight-none"><div class="highlight"><pre>select Memos \
+  --match_columns &quot;scorer_tf_idf(title) || scorer_tf_at_most(content, 2.0)&quot; \
+  --query &quot;Groonga&quot; \
+  --output_columns &quot;title, content, _score&quot; \
+  --sortby &quot;-_score&quot;
+# [
+#   [
+#     0,
+#     1337566253.89858,
+#     0.000355720520019531
+#   ],
+#   [
+#     [
+#       [
+#         2
+#       ],
+#       [
+#         [
+#           &quot;title&quot;,
+#           &quot;ShortText&quot;
+#         ],
+#         [
+#           &quot;content&quot;,
+#           &quot;Text&quot;
+#         ],
+#         [
+#           &quot;_score&quot;,
+#           &quot;Int32&quot;
+#         ]
+#       ],
+#       [
+#         &quot;Groonga is fast&quot;,
+#         &quot;Groonga! Groonga! Groonga! Groonga is very fast!&quot;,
+#         3
+#       ],
+#       [
+#         &quot;Groonga is easy&quot;,
+#         &quot;Groonga is very easy full text search engine!&quot;,
+#         2
+#       ]
+#     ]
+#   ]
+# ]
 </pre></div>
 </div>
 <p>The <code class="docutils literal"><span class="pre">--match_columns</span></code> uses <code class="docutils literal"><span class="pre">scorer_tf_idf(title)</span></code> and
@@ -359,13 +388,50 @@ score value to <code class="docutils literal"><span class="pre">2</span></code>.
 <p>You can use the default scorer and custom scorer in the same
 <code class="docutils literal"><span class="pre">--match_columns</span></code>. You can use the default scorer by just specifying
 a match column:</p>
-<div class="highlight-none"><div class="highlight"><pre>.. groonga-command
-.. include:: ../example/reference/scorer/usage_default_and_custom_scorers.log
-.. select Memos \
-..   --match_columns &quot;title || scorer_tf_at_most(content, 2.0)&quot; \
-..   --query &quot;Groonga&quot; \
-..   --output_columns &quot;title, content, _score&quot; \
-..   --sortby &quot;-_score&quot;
+<p>Execution example:</p>
+<div class="highlight-none"><div class="highlight"><pre>select Memos \
+  --match_columns &quot;title || scorer_tf_at_most(content, 2.0)&quot; \
+  --query &quot;Groonga&quot; \
+  --output_columns &quot;title, content, _score&quot; \
+  --sortby &quot;-_score&quot;
+# [
+#   [
+#     0,
+#     1337566253.89858,
+#     0.000355720520019531
+#   ],
+#   [
+#     [
+#       [
+#         2
+#       ],
+#       [
+#         [
+#           &quot;title&quot;,
+#           &quot;ShortText&quot;
+#         ],
+#         [
+#           &quot;content&quot;,
+#           &quot;Text&quot;
+#         ],
+#         [
+#           &quot;_score&quot;,
+#           &quot;Int32&quot;
+#         ]
+#       ],
+#       [
+#         &quot;Groonga is fast&quot;,
+#         &quot;Groonga! Groonga! Groonga! Groonga is very fast!&quot;,
+#         3
+#       ],
+#       [
+#         &quot;Groonga is easy&quot;,
+#         &quot;Groonga is very easy full text search engine!&quot;,
+#         2
+#       ]
+#     ]
+#   ]
+# ]
 </pre></div>
 </div>
 <p>The <code class="docutils literal"><span class="pre">--match_columns</span></code> uses the default scorer (TF) for <code class="docutils literal"><span class="pre">title</span></code> and
@@ -442,7 +508,7 @@ a match column:</p>
         <li class="right" >
           <a href="query_expanders/tsv.html" title="7.10.1. QueryExpanderTSV"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">Groonga v5.0.6-226-gd7da7e7 documentation</a> &raquo;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">Groonga v5.0.7-264-ga2dae20 documentation</a> &raquo;</li>
           <li class="nav-item nav-item-1"><a href="../reference.html" >7. Reference manual</a> &raquo;</li>
       </ul>
     </div>

data/vendor/local/share/doc/groonga/en/html/reference/scorers/scorer_tf_at_most.html CHANGED Viewed

@@ -7,7 +7,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>7.11.3.1. scorer_tf_at_most &mdash; Groonga v5.0.6-226-gd7da7e7 documentation</title>
+    <title>7.11.3.1. scorer_tf_at_most &mdash; Groonga v5.0.7-264-ga2dae20 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.6-226-gd7da7e7',
+        VERSION:     '5.0.7-264-ga2dae20',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -25,7 +25,7 @@
     <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.6-226-gd7da7e7 documentation" href="../../index.html" />
+    <link rel="top" title="Groonga v5.0.7-264-ga2dae20 documentation" href="../../index.html" />
     <link rel="up" title="7.11. Scorer" href="../scorer.html" />
     <link rel="next" title="7.11.3.2. scorer_tf_idf" href="scorer_tf_idf.html" />
     <link rel="prev" title="7.11. Scorer" href="../scorer.html" />
@@ -60,7 +60,7 @@
         <li class="right" >
           <a href="../scorer.html" title="7.11. Scorer"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v5.0.6-226-gd7da7e7 documentation</a> &raquo;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v5.0.7-264-ga2dae20 documentation</a> &raquo;</li>
           <li class="nav-item nav-item-1"><a href="../../reference.html" >7. Reference manual</a> &raquo;</li>
           <li class="nav-item nav-item-2"><a href="../scorer.html" accesskey="U">7.11. Scorer</a> &raquo;</li>
       </ul>
@@ -83,7 +83,158 @@
 <div class="section" id="summary">
 <h2>7.11.3.1.1. Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
 <p><code class="docutils literal"><span class="pre">scorer_tf_at_most</span></code> is a scorer based on TF (term frequency).</p>
-<p>TODO</p>
+<p>TF based scorer includes TF-IDF based scorer has a problem for the
+following case:</p>
+<p>If document contains many same keywords such as &quot;They are keyword,
+keyword, keyword ... and keyword&quot;, the document has high score. It's
+not expected. Search engine spammer may use the technique.</p>
+<p><code class="docutils literal"><span class="pre">scorer_tf_at_most</span></code> is a TF based scorer but it can solve the case.</p>
+<p><code class="docutils literal"><span class="pre">scorer_tf_at_most</span></code> limits the maximum score value. It means that
+<code class="docutils literal"><span class="pre">scorer_tf_at_most</span></code> limits effect of a match.</p>
+<p>If document contains many same keywords such as &quot;They are keyword,
+keyword, keyword ... and keyword&quot;, <code class="docutils literal"><span class="pre">scorer_tf_at_most(column,</span> <span class="pre">2.0)</span></code>
+returns at most <code class="docutils literal"><span class="pre">2</span></code> as score.</p>
+<blockquote id="note">
+<div><p>You don't need to resolve scoring only by score function. Score
+function is highly depends on search query. You may be able to use
+metadata of matched record.</p>
+<p>For example, Google uses <a class="reference external" href="https://en.wikipedia.org/wiki/PageRank">PageRank</a> for scoring. You may be
+able to use data type (&quot;title&quot; data are important rather than
+&quot;memo&quot; data), tag, geolocation and so on.</p>
+<p>Please stop to think about only score function for scoring.</p>
+</div></blockquote>
+</div>
+<div class="section" id="syntax">
+<h2>7.11.3.1.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2>
+<p>This scorer has two parameters:</p>
+<div class="highlight-none"><div class="highlight"><pre>scorer_tf_at_most(column, max)
+scorer_tf_at_most(index, max)
+</pre></div>
+</div>
+</div>
+<div class="section" id="usage">
+<h2>7.11.3.1.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
+<p>This section describes how to use this scorer.</p>
+<p>Here are a schema definition and sample data to show usage.</p>
+<p>Sample schema:</p>
+<p>Execution example:</p>
+<div class="highlight-none"><div class="highlight"><pre>table_create Logs TABLE_NO_KEY
+# [[0, 1337566253.89858, 0.000355720520019531], true]
+column_create Logs message COLUMN_SCALAR Text
+# [[0, 1337566253.89858, 0.000355720520019531], true]
+table_create Terms TABLE_PAT_KEY ShortText \
+  --default_tokenizer TokenBigram \
+  --normalizer NormalizerAuto
+# [[0, 1337566253.89858, 0.000355720520019531], true]
+column_create Terms message_index COLUMN_INDEX|WITH_POSITION Logs message
+# [[0, 1337566253.89858, 0.000355720520019531], true]
+</pre></div>
+</div>
+<p>Sample data:</p>
+<p>Execution example:</p>
+<div class="highlight-none"><div class="highlight"><pre>load --table Logs
+[
+{&quot;message&quot;: &quot;Notice&quot;},
+{&quot;message&quot;: &quot;Notice Notice&quot;},
+{&quot;message&quot;: &quot;Notice Notice Notice&quot;},
+{&quot;message&quot;: &quot;Notice Notice Notice Notice&quot;},
+{&quot;message&quot;: &quot;Notice Notice Notice Notice Notice&quot;}
+]
+# [[0, 1337566253.89858, 0.000355720520019531], 5]
+</pre></div>
+</div>
+<p>You specify <code class="docutils literal"><span class="pre">scorer_tf_at_most</span></code> in <a class="reference internal" href="../commands/select.html#select-match-columns"><span>match_columns</span></a> like
+the following:</p>
+<p>Execution example:</p>
+<div class="highlight-none"><div class="highlight"><pre>select Logs \
+  --match_columns &quot;scorer_tf_at_most(message, 3.0)&quot; \
+  --query &quot;Notice&quot; \
+  --output_columns &quot;message, _score&quot; \
+  --sortby &quot;-_score&quot;
+# [
+#   [
+#     0,
+#     1337566253.89858,
+#     0.000355720520019531
+#   ],
+#   [
+#     [
+#       [
+#         5
+#       ],
+#       [
+#         [
+#           &quot;message&quot;,
+#           &quot;Text&quot;
+#         ],
+#         [
+#           &quot;_score&quot;,
+#           &quot;Int32&quot;
+#         ]
+#       ],
+#       [
+#         &quot;Notice Notice Notice Notice Notice&quot;,
+#         3
+#       ],
+#       [
+#         &quot;Notice Notice Notice Notice&quot;,
+#         3
+#       ],
+#       [
+#         &quot;Notice Notice Notice&quot;,
+#         3
+#       ],
+#       [
+#         &quot;Notice Notice&quot;,
+#         2
+#       ],
+#       [
+#         &quot;Notice&quot;,
+#         1
+#       ]
+#     ]
+#   ]
+# ]
+</pre></div>
+</div>
+<p>If a document has three or more <code class="docutils literal"><span class="pre">Notice</span></code> terms, its score is <code class="docutils literal"><span class="pre">3</span></code>.
+Because the <code class="docutils literal"><span class="pre">select</span></code> specify <code class="docutils literal"><span class="pre">3.0</span></code> as the max score.</p>
+<p>If a document has one or two <code class="docutils literal"><span class="pre">Notice</span></code> terms, its score is <code class="docutils literal"><span class="pre">1</span></code> or
+<code class="docutils literal"><span class="pre">2</span></code>. Because the score is less than <code class="docutils literal"><span class="pre">3.0</span></code> specified as the max score.</p>
+</div>
+<div class="section" id="parameters">
+<h2>7.11.3.1.4. Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
+<p>This section describes all parameters.</p>
+<div class="section" id="required-parameters">
+<h3>7.11.3.1.4.1. Required parameters<a class="headerlink" href="#required-parameters" title="Permalink to this headline">¶</a></h3>
+<p>There is only one required parameters.</p>
+<div class="section" id="column">
+<h4>7.11.3.1.4.1.1. <code class="docutils literal"><span class="pre">column</span></code><a class="headerlink" href="#column" title="Permalink to this headline">¶</a></h4>
+<p>The data column that is match target. The data column must be indexed.</p>
+</div>
+<div class="section" id="index">
+<h4>7.11.3.1.4.1.2. <code class="docutils literal"><span class="pre">index</span></code><a class="headerlink" href="#index" title="Permalink to this headline">¶</a></h4>
+<p>The index column to be used for search.</p>
+</div>
+</div>
+<div class="section" id="optional-parameters">
+<h3>7.11.3.1.4.2. Optional parameters<a class="headerlink" href="#optional-parameters" title="Permalink to this headline">¶</a></h3>
+<p>There is no optional parameters.</p>
+</div>
+</div>
+<div class="section" id="return-value">
+<h2>7.11.3.1.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
+<p>This scorer returns score as <a class="reference internal" href="../types.html#builtin-type-float"><span>Float</span></a>.</p>
+<p><a class="reference internal" href="../commands/select.html"><em>select</em></a> returns <code class="docutils literal"><span class="pre">_score</span></code> as <code class="docutils literal"><span class="pre">Int32</span></code> not
+<code class="docutils literal"><span class="pre">Float</span></code>. Because it casts to <code class="docutils literal"><span class="pre">Int32</span></code> from <code class="docutils literal"><span class="pre">Float</span></code> for keeping
+backward compatibility.</p>
+<p>Score is computed as TF with limitation.</p>
+</div>
+<div class="section" id="see-also">
+<h2>7.11.3.1.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="../scorer.html"><em>Scorer</em></a></li>
+</ul>
 </div>
 </div>
@@ -97,6 +248,19 @@
   <ul>
 <li><a class="reference internal" href="#">7.11.3.1. <code class="docutils literal"><span class="pre">scorer_tf_at_most</span></code></a><ul>
 <li><a class="reference internal" href="#summary">7.11.3.1.1. Summary</a></li>
+<li><a class="reference internal" href="#syntax">7.11.3.1.2. Syntax</a></li>
+<li><a class="reference internal" href="#usage">7.11.3.1.3. Usage</a></li>
+<li><a class="reference internal" href="#parameters">7.11.3.1.4. Parameters</a><ul>
+<li><a class="reference internal" href="#required-parameters">7.11.3.1.4.1. Required parameters</a><ul>
+<li><a class="reference internal" href="#column">7.11.3.1.4.1.1. <code class="docutils literal"><span class="pre">column</span></code></a></li>
+<li><a class="reference internal" href="#index">7.11.3.1.4.1.2. <code class="docutils literal"><span class="pre">index</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#optional-parameters">7.11.3.1.4.2. Optional parameters</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#return-value">7.11.3.1.5. Return value</a></li>
+<li><a class="reference internal" href="#see-also">7.11.3.1.6. See also</a></li>
 </ul>
 </li>
 </ul>
@@ -143,7 +307,7 @@
         <li class="right" >
           <a href="../scorer.html" title="7.11. Scorer"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v5.0.6-226-gd7da7e7 documentation</a> &raquo;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v5.0.7-264-ga2dae20 documentation</a> &raquo;</li>
           <li class="nav-item nav-item-1"><a href="../../reference.html" >7. Reference manual</a> &raquo;</li>
           <li class="nav-item nav-item-2"><a href="../scorer.html" >7.11. Scorer</a> &raquo;</li>
       </ul>

data/vendor/local/share/doc/groonga/en/html/reference/scorers/scorer_tf_idf.html CHANGED Viewed

@@ -7,7 +7,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>7.11.3.2. scorer_tf_idf &mdash; Groonga v5.0.6-226-gd7da7e7 documentation</title>
+    <title>7.11.3.2. scorer_tf_idf &mdash; Groonga v5.0.7-264-ga2dae20 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.6-226-gd7da7e7',
+        VERSION:     '5.0.7-264-ga2dae20',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -25,7 +25,7 @@
     <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.6-226-gd7da7e7 documentation" href="../../index.html" />
+    <link rel="top" title="Groonga v5.0.7-264-ga2dae20 documentation" href="../../index.html" />
     <link rel="up" title="7.11. Scorer" href="../scorer.html" />
     <link rel="next" title="7.12. grn_expr" href="../grn_expr.html" />
     <link rel="prev" title="7.11.3.1. scorer_tf_at_most" href="scorer_tf_at_most.html" />
@@ -60,7 +60,7 @@
         <li class="right" >
           <a href="scorer_tf_at_most.html" title="7.11.3.1. scorer_tf_at_most"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v5.0.6-226-gd7da7e7 documentation</a> &raquo;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v5.0.7-264-ga2dae20 documentation</a> &raquo;</li>
           <li class="nav-item nav-item-1"><a href="../../reference.html" >7. Reference manual</a> &raquo;</li>
           <li class="nav-item nav-item-2"><a href="../scorer.html" accesskey="U">7.11. Scorer</a> &raquo;</li>
       </ul>
@@ -82,7 +82,7 @@
 </div>
 <div class="section" id="summary">
 <h2>7.11.3.2.1. Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
-<p><code class="docutils literal"><span class="pre">scorer_tf_idf</span></code> is a scorer based of <a class="reference external" href="http://en.wikipedia.org/wiki/Tf%E2%80%93idf">TF-IDF</a> (term
+<p><code class="docutils literal"><span class="pre">scorer_tf_idf</span></code> is a scorer based of <a class="reference external" href="https://en.wikipedia.org/wiki/Tf%E2%80%93idf">TF-IDF</a> (term
 frequency-inverse document frequency) score function.</p>
 <p>To put it simply, TF (term frequency) divided by DF (document
 frequency) is TF-IDF. &quot;TF&quot; means that &quot;the number of occurrences is
@@ -94,32 +94,34 @@ doesn't care about term importance but is fast.</p>
 <p>TF-IDF will compute more suitable score rather than TF for many cases.
 But it's not perfect.</p>
 <p>If document contains many same keywords such as &quot;They are keyword,
-keyword, keyword ... and keyword&quot;. It increases score by TF and
+keyword, keyword ... and keyword&quot;, it increases score by TF and
 TF-IDF. Search engine spammer may use the technique. But TF-IDF
 doesn't guard from the technique.</p>
-<p><a class="reference external" href="http://en.wikipedia.org/wiki/Okapi_BM25">Okapi BM25</a> can solve the
+<p><a class="reference external" href="https://en.wikipedia.org/wiki/Okapi_BM25">Okapi BM25</a> can solve the
 case. But it's more slower than TF-IDF and not implemented yet in
 Groonga.</p>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">orphan:</th><td class="field-body"></td>
-</tr>
-</tbody>
-</table>
+<p>Groonga provides <a class="reference internal" href="scorer_tf_at_most.html"><em>scorer_tf_at_most</em></a> scorer that can also solve
+the case.</p>
 <blockquote id="note">
 <div><p>You don't need to resolve scoring only by score function. Score
 function is highly depends on search query. You may be able to use
 metadata of matched record.</p>
-<p>For example, Google uses <a class="reference external" href="http://en.wikipedia.org/wiki/PageRank">PageRank</a> for scoring. You may be
+<p>For example, Google uses <a class="reference external" href="https://en.wikipedia.org/wiki/PageRank">PageRank</a> for scoring. You may be
 able to use data type (&quot;title&quot; data are important rather than
 &quot;memo&quot; data), tag, geolocation and so on.</p>
 <p>Please stop to think about only score function for scoring.</p>
 </div></blockquote>
 </div>
+<div class="section" id="syntax">
+<h2>7.11.3.2.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2>
+<p>This scorer has only one parameter:</p>
+<div class="highlight-none"><div class="highlight"><pre>scorer_tf_idf(column)
+scorer_tf_idf(index)
+</pre></div>
+</div>
+</div>
 <div class="section" id="usage">
-<h2>7.11.3.2.2. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
+<h2>7.11.3.2.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
 <p>This section describes how to use this scorer.</p>
 <p>Here are a schema definition and sample data to show usage.</p>
 <p>Sample schema:</p>
@@ -219,8 +221,36 @@ include <code class="docutils literal"><span class="pre">Error</span></code> is
 means that the term is more characteristic term. Characteristic term
 is important term.</p>
 </div>
+<div class="section" id="parameters">
+<h2>7.11.3.2.4. Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
+<p>This section describes all parameters.</p>
+<div class="section" id="required-parameters">
+<h3>7.11.3.2.4.1. Required parameters<a class="headerlink" href="#required-parameters" title="Permalink to this headline">¶</a></h3>
+<p>There is only one required parameters.</p>
+<div class="section" id="column">
+<h4>7.11.3.2.4.1.1. <code class="docutils literal"><span class="pre">column</span></code><a class="headerlink" href="#column" title="Permalink to this headline">¶</a></h4>
+<p>The data column that is match target. The data column must be indexed.</p>
+</div>
+<div class="section" id="index">
+<h4>7.11.3.2.4.1.2. <code class="docutils literal"><span class="pre">index</span></code><a class="headerlink" href="#index" title="Permalink to this headline">¶</a></h4>
+<p>The index column to be used for search.</p>
+</div>
+</div>
+<div class="section" id="optional-parameters">
+<h3>7.11.3.2.4.2. Optional parameters<a class="headerlink" href="#optional-parameters" title="Permalink to this headline">¶</a></h3>
+<p>There is no optional parameters.</p>
+</div>
+</div>
+<div class="section" id="return-value">
+<h2>7.11.3.2.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
+<p>This scorer returns score as <a class="reference internal" href="../types.html#builtin-type-float"><span>Float</span></a>.</p>
+<p><a class="reference internal" href="../commands/select.html"><em>select</em></a> returns <code class="docutils literal"><span class="pre">_score</span></code> as <code class="docutils literal"><span class="pre">Int32</span></code> not
+<code class="docutils literal"><span class="pre">Float</span></code>. Because it casts to <code class="docutils literal"><span class="pre">Int32</span></code> from <code class="docutils literal"><span class="pre">Float</span></code> for keeping
+backward compatibility.</p>
+<p>Score is computed as TF-IDF based algorithm.</p>
+</div>
 <div class="section" id="see-also">
-<h2>7.11.3.2.3. See also<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
+<h2>7.11.3.2.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="../scorer.html"><em>Scorer</em></a></li>
 </ul>
@@ -237,8 +267,19 @@ is important term.</p>
   <ul>
 <li><a class="reference internal" href="#">7.11.3.2. <code class="docutils literal"><span class="pre">scorer_tf_idf</span></code></a><ul>
 <li><a class="reference internal" href="#summary">7.11.3.2.1. Summary</a></li>
-<li><a class="reference internal" href="#usage">7.11.3.2.2. Usage</a></li>
-<li><a class="reference internal" href="#see-also">7.11.3.2.3. See also</a></li>
+<li><a class="reference internal" href="#syntax">7.11.3.2.2. Syntax</a></li>
+<li><a class="reference internal" href="#usage">7.11.3.2.3. Usage</a></li>
+<li><a class="reference internal" href="#parameters">7.11.3.2.4. Parameters</a><ul>
+<li><a class="reference internal" href="#required-parameters">7.11.3.2.4.1. Required parameters</a><ul>
+<li><a class="reference internal" href="#column">7.11.3.2.4.1.1. <code class="docutils literal"><span class="pre">column</span></code></a></li>
+<li><a class="reference internal" href="#index">7.11.3.2.4.1.2. <code class="docutils literal"><span class="pre">index</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#optional-parameters">7.11.3.2.4.2. Optional parameters</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#return-value">7.11.3.2.5. Return value</a></li>
+<li><a class="reference internal" href="#see-also">7.11.3.2.6. See also</a></li>
 </ul>
 </li>
 </ul>
@@ -285,7 +326,7 @@ is important term.</p>
         <li class="right" >
           <a href="scorer_tf_at_most.html" title="7.11.3.1. scorer_tf_at_most"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v5.0.6-226-gd7da7e7 documentation</a> &raquo;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v5.0.7-264-ga2dae20 documentation</a> &raquo;</li>
           <li class="nav-item nav-item-1"><a href="../../reference.html" >7. Reference manual</a> &raquo;</li>
           <li class="nav-item nav-item-2"><a href="../scorer.html" >7.11. Scorer</a> &raquo;</li>
       </ul>