null+****@clear*****
null+****@clear*****
2010年 8月 26日 (木) 18:00:29 JST
Tasuku SUENAGA a.k.a. gunyarakun 2010-08-26 09:00:29 +0000 (Thu, 26 Aug 2010)
New Revision: f94380ab5fd0fcc293a275ac068eed853ac5104f
Log:
Added suggest command document.
Added files:
doc/ja/source/commands/suggest.txt
Added: doc/ja/source/commands/suggest.txt (+73 -0) 100644
===================================================================
--- /dev/null
+++ doc/ja/source/commands/suggest.txt 2010-08-26 09:00:29 +0000 (6202fda)
@@ -0,0 +1,73 @@
+.. highlightlang:: none
+
+suggest
+=======
+
+** 未だ仕様は確定しておりません。利用のためには特定のデータを持つテーブルが必要となります。 **
+
+名前
+----
+
+suggest - 指定したクエリに対する補完・修正・提案を行う。
+
+書式
+----
+::
+
+ suggest type table column query
+
+説明
+----
+
+suggestコマンドは、指定したクエリに対して補完・修正・提案を行います。
+
+補完とは、クエリの未入力・未変換部分を補うことです。修正とは、クエリ内のミスタイプや誤変換を修正することです。提案とは、さらなる絞込みを行うための候補となるクエリを提案することです。
+
+引数
+----
+
+``type``
+
+ 補完・修正・提案のいずれを行うかを、パイプ('|')で組み合わせたシンボル名で指定します(例: correct|suggest)
+
+ ``complete``
+
+ 補完を行います。
+
+ ``correct``
+
+ 修正を行います。
+
+ ``suggest``
+
+ 提案を行います。
+
+``table``
+
+ 基礎となるデータが格納されているテーブル名を指定します。
+
+``column``
+
+ 基礎となるデータが格納されているテーブルにおいて、「ヨミガナ」が格納されているカラム名を指定します。
+
+``query``
+
+ 補完・修正・提案の対象となるクエリを指定します。
+
+返値
+----
+
+json形式
+^^^^^^^^
+
+::
+
+ [["候補1", 候補1のスコア], ["候補2", 候補2のスコア], ...]
+
+ ``候補``
+
+ 補完・修正・提案の候補。
+
+ ``候補のスコア``
+
+ 補完・修正・提案として優れたものほど高くなる数値。結果は、スコア順にソートされている。