rroonga 1.2.5-x86-mingw32 → 1.2.7-x86-mingw32

data/vendor/local/share/man/ja/man1/groonga.1

@@ -1,4 +1,4 @@
-.TH "GROONGA" "1" "2011 年 08 月 05 日" "1.2.4" "groonga"
+.TH "GROONGA" "1" "2011 年 08 月 28 日" "1.2.5" "groonga"
 .SH NAME
 groonga \- groongaのドキュメント
 .
@@ -255,13 +255,24 @@ amd64版のみ提供でi386版は未提供。
 % brew install groonga
 .ft P
 .fi
-.SS Windows
+.SS Windows (Installer)
 .IP ノート
 .
 x64版のみ提供で32bit版は未提供。
 .RE
 .sp
-\fI\%packages.groonga.org/windows/\fP からzipファイルをダウンロードして展開するだけで使えます。今のところインストーラは配布していません。
+You just download installer (.exe file) from
+\fI\%packages.groonga.org/windows/\fP
+and execute it.
+.SS Windows (zip)
+.IP ノート
+.
+x64版のみ提供で32bit版は未提供。
+.RE
+.sp
+You just download zip\-file from
+\fI\%packages.groonga.org/windows/\fP
+and extract it.
 .SS その他
 .sp
 形態素単位でトークナイズした全文検索索引を使用したい場合は、groongaをインストールする前に \fI\%MeCab\fP をインストールしてください。
@@ -369,7 +380,7 @@ groonga実行ファイルやgroongaサーバを介して様々なコマンドを
 .sp
 書式2において、空白や、記号「"\(aq()」のうちいずれかを含む値を指定したい場合は、シングルクォート(\(aq)かダブルクォート(")で値を囲みます。
 .sp
-詳しくは、 \fB/execfile\fP のコマンドの項を参考にしてください。
+詳しくは、 \fB/executables/groonga\fP のコマンドの項を参考にしてください。
 .SS 主なコマンド
 .INDENT 0.0
 .INDENT 3.5
@@ -1816,6 +1827,724 @@ Commentsテーブルのlast_modifiedカラムは、Time型です。この型で
 .fi
 .sp
 2010/03/17 14:00:00以前に書かれたコメント5件がヒットしました。また、ドリルダウンの結果も返ってきており、「hsiomaneki」が2件、「グニャラくん」が3件ヒットしていることがわかります。
+.SH サジェスト
+.IP ノート
+.
+サジェスト機能の仕様はまだ確定していません。仕様は変更される可能性があります。
+.RE
+.sp
+groongaにはサジェスト機能があります。このセクションではこの機能の使い方とどのように動作しているかを説明します。
+.SS はじめに
+.sp
+groongaのサジェスト機能は以下の機能を提供します。:
+.INDENT 0.0
+.IP \(bu 2
+.
+補完
+.IP \(bu 2
+.
+補正
+.IP \(bu 2
+.
+提案
+.UNINDENT
+.SS 補完
+.sp
+補完はユーザの入力を支援します。ユーザが単語の一部分のみしか入力していないときに、登録済みの語の中から補完候補の語を返します。
+.sp
+例えば、以下が登録済みの語とします。:
+.INDENT 0.0
+.IP \(bu 2
+.
+"groonga"
+.IP \(bu 2
+.
+"complete"
+.IP \(bu 2
+.
+"correction"
+.IP \(bu 2
+.
+"suggest"
+.UNINDENT
+.sp
+ユーザが"co"と入力したとき、"complete"と"correction"を補完候補として返します。これはどちらも"co"で始まっているからです。
+.sp
+ユーザが"sug"と入力したとき、"suggest"を返します。これは"suggest"が"sug"から始まっているからです。
+.sp
+ユーザが"ab"と入力したときは何も返しません。これは"ab"から始まる語が1つも登録されていないからです。
+.SS 補正
+.sp
+修正もユーザの入力を支援します。ユーザが間違った語を入力したときに登録済みの修正ペアの中から修正された語を返します。
+.sp
+例えば、以下のような修正ペアが登録されていたとします。
+.TS
+center;
+|l|l|.
+_
+T{
+間違った語
+T}	T{
+正しい語
+T}
+_
+T{
+grroonga
+gronga
+gronnga
+T}	T{
+groonga
+groonga
+groonga
+T}
+_
+.TE
+.sp
+ユーザが"gronga"と入力したとき、"groonga"を返します。これは、"gronga"が「間違った語」にあり、対応する「正しい語」カラムの値が"groonga"だからです。
+.sp
+ユーザが"roonga"と入力したときは何も返しません。これは"roonga"が「間違った語」カラムにないからです。
+.SS 提案
+.sp
+提案は、たくさんの文書が見つかったときに、ユーザがさらに絞り込むことを支援します。ユーザがクエリを入力したとき、登録済みの関連クエリペアから追加のキーワードを選び、追加のキーワードを含んだ新しいクエリを返します。
+.sp
+例えば、以下の関連クエリペアが登録されているとします。:
+.TS
+center;
+|l|l|.
+_
+T{
+キーワード
+T}	T{
+関連クエリ
+T}
+_
+T{
+groonga
+T}	T{
+groonga search engine
+T}
+_
+T{
+search
+T}	T{
+Google search
+T}
+_
+T{
+speed
+T}	T{
+groonga speed
+T}
+_
+.TE
+.sp
+ユーザが"groonga"と入力したとき、"groonga search engine"を返します。これは、"groonga"が「キーワード」カラムの値にあり、対応する「関連クエリ」カラムの値が"groonga search engine"だからです。
+.sp
+ユーザが"MySQL"と入力したときは何も返しません。これは"MySQL"が「キーワード」カラムにないからです。
+.SS 学習
+.sp
+サジェスト機能を使う場合は、事前に登録済みのデータを用意する必要があります。これらのデータはユーザの入力を使って登録できます。これ用にgroonga\-suggest\-httpdコマンドとgroonga\-suggest\-learnerコマンドがあります。
+.SS チュートリアル
+.sp
+TODO...
+.SS 補完
+.sp
+このセクションでは以下の補完機能について説明します。:
+.INDENT 0.0
+.IP \(bu 2
+.
+どのように動作するか
+.IP \(bu 2
+.
+使い方
+.IP \(bu 2
+.
+学習方法
+.UNINDENT
+.SS どのように動作するか
+.sp
+補完機能は補完される語を計算するために3種類の検索を使います。
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
+.IP 1. 3
+.
+登録されている語を前方一致RK検索。
+.IP 2. 3
+.
+学習したデータを共起検索。
+.IP 3. 3
+.
+登録されている語を前方一致検索。（実行しないこともある）
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SS 前方一致RK検索
+.sp
+RKはローマ字（Romaji）とカタカナ（Katakana）を意味しています。前方一致RK検索は登録されている語をユーザの入力から前方一致検索します。このとき、ユーザの入力はローマ字でもカタカナでもひらがなでも構いません。この機能は日本語を検索するときに便利です。
+.sp
+例えば、"日本"という語が登録されているとします。そして、その読みとして"ニホン"（カタカナにしないといけません）が登録されているとします。このとき、ユーザの入力が"ni"でも"二"でも"に"でも"日本"を見つけることができます。
+.SS 共起検索
+.sp
+共起検索は入力途中のユーザのクエリから登録されている語を見つけます。共起検索では検索データベースとしてユーザの入力シーケンスを使います。これはクエリログやアクセスログなどから学習します。
+.sp
+例えば、以下のようなユーザの入力シーケンスがあるとします。
+.TS
+center;
+|l|l|.
+_
+T{
+入力
+T}	T{
+検索実行
+T}
+_
+T{
+s
+T}	T{
+していない
+T}
+_
+T{
+se
+T}	T{
+していない
+T}
+_
+T{
+sea
+T}	T{
+していない
+T}
+_
+T{
+sear
+T}	T{
+していない
+T}
+_
+T{
+searc
+T}	T{
+していない
+T}
+_
+T{
+search
+T}	T{
+した
+T}
+_
+T{
+e
+T}	T{
+していない
+T}
+_
+T{
+en
+T}	T{
+していない
+T}
+_
+T{
+eng
+T}	T{
+していない
+T}
+_
+T{
+engi
+T}	T{
+していない
+T}
+_
+T{
+engin
+T}	T{
+していない
+T}
+_
+T{
+engine
+T}	T{
+していない
+T}
+_
+T{
+enginen
+T}	T{
+していない（入力ミス！）
+T}
+_
+T{
+engine
+T}	T{
+した
+T}
+_
+.TE
+.sp
+groongaは以下のような補完ペアを作ります。:
+.TS
+center;
+|l|l|.
+_
+T{
+入力
+T}	T{
+補完語
+T}
+_
+T{
+s
+T}	T{
+search
+T}
+_
+T{
+se
+T}	T{
+search
+T}
+_
+T{
+sea
+T}	T{
+search
+T}
+_
+T{
+sear
+T}	T{
+search
+T}
+_
+T{
+searc
+T}	T{
+search
+T}
+_
+T{
+e
+T}	T{
+engine
+T}
+_
+T{
+en
+T}	T{
+engine
+T}
+_
+T{
+eng
+T}	T{
+engine
+T}
+_
+T{
+engi
+T}	T{
+engine
+T}
+_
+T{
+engin
+T}	T{
+engine
+T}
+_
+T{
+engine
+T}	T{
+engine
+T}
+_
+T{
+enginen
+T}	T{
+engine
+T}
+_
+.TE
+.sp
+ユーザが検索を実行する前のすべての入力（例では"s"、"se"など）を検索を実行した語（例では"search"）に対応付けます。
+.sp
+厳密に言うとこの説明は正しくありません。なぜならタイムスタンプに関することを省略しているからです。groongaは本当は「ユーザが検索を実行する前のすべての入力を」使いません。厳密には「ユーザが検索を実行する前の1分以内の入力のみ」を使います。検索実行時から1分より前の入力は使われません。
+.sp
+ユーザが"sea"と入力したら、共起検索は"search"を返します。なぜなら、「入力」カラムには"sea"という値があり、対応する「補完語」カラムには"search"という値が入っているからです。
+.SS 前方一致検索
+.sp
+前方一致検索はユーザが入力した文字列から始まる登録済みの語を検索します。この検索は前方一致RK検索とは違ってローマ字、カタカナ、ひらがなを特別扱いしません。
+.sp
+この検索はいつも実行されるわけではありません。この検索は明示的に実行するように指示するか、前方一致RK検索と共起検索の両方がなにもヒットしないときのみ実行されます。
+.sp
+例えば、"search"が登録されているとします。ユーザは"s"、"se"、"sea"、"sear"、"searc"、"search"のどれでも"search"を補完候補として利用できます。
+.SS 使い方
+.sp
+groongaは補完機能を使うために \fB/commands/suggest\fP コマンドを用意しています。 \fI\-\-type complete\fP オプションを使うと補完機能を利用できます。
+.sp
+例えば、"en"と入力したときの補完結果を取得するコマンドは以下のようになります。:
+.sp
+実行例:
+.sp
+.nf
+.ft C
+> suggest \-\-table item_query \-\-column kana \-\-types complete \-\-threshold 1 \-\-query en
+[[0,1313131879.64588,0.000913584],{"complete":[[1],[["_key","ShortText"],["_score","Int32"]],["engine",1]]}]
+.ft P
+.fi
+.SS 学習方法
+.sp
+共起検索は学習データを使います。学習データはクエリログやアクセスログなどを元に作成します。学習データを作成するには、タイムスタンプ付きの入力シーケンスと、タイムスタンプ付きの検索実行時の入力内容が必要です。
+.sp
+例えば、ユーザが"engine"で検索したいとします。ユーザが以下のようなシーケンスで検索クエリを入力したとします。:
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
+.IP 1. 3
+.
+2011\-08\-10T13:33:23+09:00: e
+.IP 2. 3
+.
+2011\-08\-10T13:33:23+09:00: en
+.IP 3. 3
+.
+2011\-08\-10T13:33:24+09:00: eng
+.IP 4. 3
+.
+2011\-08\-10T13:33:24+09:00: engi
+.IP 5. 3
+.
+2011\-08\-10T13:33:24+09:00: engin
+.IP 6. 3
+.
+2011\-08\-10T13:33:25+09:00: engine （検索実行！）
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.sp
+以下のコマンドでこの入力シーケンスから学習できます。:
+.sp
+.nf
+.ft C
+load \-\-table event_query \-\-each \(aqsuggest_preparer(_id, type, item, sequence, time, pair_query)\(aq
+[
+{"sequence": "1", "time": 1312950803.86057, "item": "e"},
+{"sequence": "1", "time": 1312950803.96857, "item": "en"},
+{"sequence": "1", "time": 1312950804.26057, "item": "eng"},
+{"sequence": "1", "time": 1312950804.56057, "item": "engi"},
+{"sequence": "1", "time": 1312950804.76057, "item": "engin"},
+{"sequence": "1", "time": 1312950805.86057, "item": "engine", "type": "submit"}
+]
+.ft P
+.fi
+.SS 補正
+.sp
+このセクションでは以下の補正機能について説明します。:
+.INDENT 0.0
+.IP \(bu 2
+.
+どのように動作するか
+.IP \(bu 2
+.
+使い方
+.IP \(bu 2
+.
+学習方法
+.UNINDENT
+.SS どのように動作するか
+.sp
+補正機能は補正した語を計算するために3種類の検索を使います。:
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
+.IP 1. 3
+.
+学習したデータを共起検索。
+.IP 2. 3
+.
+登録されている語を類似検索。（実行しないこともある）
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SS 共起検索
+.sp
+共起検索はユーザの間違って入力した文字列から登録済みの語を検索します。共起検索ではユーザがどのように検索を実行したかを使います。ユーザがどのように検索したかはクエリログやアクセスログから学習します。
+.sp
+例えば、ユーザが以下のように検索を実行したとします。:
+.TS
+center;
+|l|l|.
+_
+T{
+クエリ
+T}	T{
+時刻
+T}
+_
+T{
+serach （入力ミス！）
+T}	T{
+2011\-08\-10T22:20:50+09:00
+T}
+_
+T{
+search （修正！）
+T}	T{
+2011\-08\-10T22:20:52+09:00
+T}
+_
+.TE
+.sp
+上記の検索実行ログから以下のような補正ペアを作ります。
+.TS
+center;
+|l|l|.
+_
+T{
+入力
+T}	T{
+補正された語
+T}
+_
+T{
+serach
+T}	T{
+search
+T}
+_
+.TE
+.sp
+1分以内の連続して実行された検索をユーザが入力を補正したものとみなします。検索を実行した間の入力途中の入力シーケンスは、補正用の学習データとしては利用しません。
+.sp
+ユーザが"serach"と入力した場合、共起検索は"saerch"を返します。なぜなら、"serach"が「入力」カラムにあり、対応する「補正される語」カラムの値が"search"だからです。
+.SS 類似検索
+.sp
+類似検索はユーザの入力をトークナイズし、同じトークンを含んだ登録済みの語を検索します。トークナイズにはTokenBigramトークナイザーを使います。これは \fB/executables/groonga\-suggest\-create\-dataset\fP が作るサジェストデータセットスキーマではデフォルトトークナイザーとしてTokenBigramトークナイザーを使っているからです。
+.sp
+例えば、"search engine"という語が登録されているとします。ユーザが"web search service"や"sound engine"などで検索すると"search engine"が補正候補になります。なぜなら、"search engine"と"web search engine"は"search"という同じトークンを持つからです。また、"search engine"と"sound engine"は"engine"という同じトークンを持っています。
+.sp
+"search engine"は"search"トークンと"engine"トークンにトークナイズされます。（groongaのTokenBigramトークナイザーは連続するアルファベットと数字を2文字にトークナイズしません。これは検索ノイズを減らす為です。確実に2文字でトークナイズするためにはTokenBigramSplitSymbolAlphaDigitを使います。）"web search service"は"web"トークンと"search"トークンと"service"トークンにトークナイズされます。"sound engine"は"sound"トークンと"engine"トークンにトークナイズされます。
+.SS 使い方
+.sp
+groongaは補正機能を使うために \fB/commands/suggest\fP コマンドを用意しています。 \fI\-\-type correct\fP オプションを使うと補正機能を利用できます。
+.sp
+例えば、"saerch"と入力した時の補正結果取得するコマンドは以下のようになります。:
+.sp
+実行例:
+.sp
+.nf
+.ft C
+> suggest \-\-table item_query \-\-column kana \-\-types correction \-\-threshold 1 \-\-query saerch
+[[0,1313131812.39207,0.000783031],{"correct":[[1],[["_key","ShortText"],["_score","Int32"]],["search",1]]}]
+.ft P
+.fi
+.SS 学習方法
+.sp
+共起検索は学習データを使います。学習データはクエリログやアクセスログから作ります。学習データを作るためにはユーザが検索を実行したときの検索クエリとタイムスタンプが必要です。
+.sp
+例えば、ユーザが"search"で検索したかったとします。しかし、ユーザは正しい"search"というクエリで検索を実行する前に間違って"saerch"で検索してしまいました。このユーザの入力シーケンスは以下のようになります。:
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
+.IP 1. 3
+.
+2011\-08\-10T13:33:23+09:00: s
+.IP 2. 3
+.
+2011\-08\-10T13:33:23+09:00: sa
+.IP 3. 3
+.
+2011\-08\-10T13:33:24+09:00: sae
+.IP 4. 3
+.
+2011\-08\-10T13:33:24+09:00: saer
+.IP 5. 3
+.
+2011\-08\-10T13:33:24+09:00: saerc
+.IP 6. 3
+.
+2011\-08\-10T13:33:25+09:00: saerch （検索実行！）
+.IP 7. 3
+.
+2011\-08\-10T13:33:29+09:00: serch （修正中…）
+.IP 8. 3
+.
+2011\-08\-10T13:33:30+09:00: search （検索実行！）
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.sp
+以下のコマンドでこの入力シーケンスから学習できます。:
+.sp
+.nf
+.ft C
+load \-\-table event_query \-\-each \(aqsuggest_preparer(_id, type, item, sequence, time, pair_query)\(aq
+[
+{"sequence": "1", "time": 1312950803.86057, "item": "s"},
+{"sequence": "1", "time": 1312950803.96857, "item": "sa"},
+{"sequence": "1", "time": 1312950804.26057, "item": "sae"},
+{"sequence": "1", "time": 1312950804.56057, "item": "saer"},
+{"sequence": "1", "time": 1312950804.76057, "item": "saerc"},
+{"sequence": "1", "time": 1312950805.76057, "item": "saerch", "type": "submit"},
+{"sequence": "1", "time": 1312950809.76057, "item": "serch"},
+{"sequence": "1", "time": 1312950810.86057, "item": "search", "type": "submit"}
+]
+.ft P
+.fi
+.SS 提案
+.sp
+このセクションでは以下の補完機能について説明します。:
+.INDENT 0.0
+.IP \(bu 2
+.
+どのように動作するか
+.IP \(bu 2
+.
+使い方
+.IP \(bu 2
+.
+学習方法
+.UNINDENT
+.SS どのように動作するか
+.sp
+提案機能は提案する語を計算するために1種類の検索を使います。:
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
+.IP 1. 3
+.
+学習したデータを共起検索。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SS 共起検索
+.sp
+共起検索はユーザの入力と関連する語を検索します。共起検索ではユーザの実行したときの検索クエリを使います。このデータはクエリログやアクセスログなどから学習します。
+.sp
+例えば、ユーザが以下のように検索を実行したとします。:
+.TS
+center;
+|l|.
+_
+T{
+クエリ
+T}
+_
+T{
+search engine
+T}
+_
+T{
+web search realtime
+T}
+_
+.TE
+.sp
+groongaは以下のような提案ペアを作成します。
+.TS
+center;
+|l|l|.
+_
+T{
+入力
+T}	T{
+提案される語
+T}
+_
+T{
+search
+T}	T{
+search engine
+T}
+_
+T{
+engine
+T}	T{
+search engine
+T}
+_
+T{
+web
+T}	T{
+web search realtime
+T}
+_
+T{
+search
+T}	T{
+web search realtime
+T}
+_
+T{
+realtime
+T}	T{
+web search realtime
+T}
+_
+.TE
+.sp
+これらのペアは以下の手順で作成します。:
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
+.IP 1. 3
+.
+ユーザの入力をTokenDelimitトークナイザーでトークナイズします。TokenDelimitは空白をトークンの区切りに使います。（例えば、"search engine"は"search"トークンと"engine"トークンの2つのトークンにトークナイズされます。）
+.IP 2. 3
+.
+各トークンについて、トークンと元のクエリからなるペアを作成する。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.sp
+ユーザが"search"と入力したとき、共起検索は"search engine"と"web search raltime"を返します。これは、"search"が2つの「入力」カラムに含まれていて、対応するそれぞれの「提案される語」カラムの値が"search engine"と"web search realtime"だからです。
+.SS 使い方
+.sp
+groongaは提案機能を使うために \fB/commands/suggest\fP コマンドを用意しています。 \fI\-\-type suggest\fP オプションを使うと提案機能を利用できます。
+.sp
+例えば、"search"と入力した時の提案結果を取得するコマンドは以下の通りです。:
+.sp
+実行例:
+.sp
+.nf
+.ft C
+> suggest \-\-table item_query \-\-column kana \-\-types suggest \-\-threshold 1 \-\-query search
+[[0,1313131808.92868,0.000607197],{"suggest":[[2],[["_key","ShortText"],["_score","Int32"]],["search engine",1],["web search realtime",1]]}]
+.ft P
+.fi
+.SS 学習方法
+.sp
+共起検索は学習データを使います。学習データはクエリログやアクセスログなどを元に作成します。学習データを作成するには、タイムスタンプ付きの入力シーケンスと、タイムスタンプ付きの検索実行時の入力内容が必要です。
+.sp
+例えば、ユーザが"engine"で検索したいとします。ユーザが以下のようなシーケンスで検索クエリを入力したとします。:
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
+.IP 1. 3
+.
+2011\-08\-10T13:33:25+09:00: search engine （検索実行）
+.IP 2. 3
+.
+2011\-08\-10T13:33:28+09:00: web search realtime （検索実行）
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.sp
+以下のコマンドで上記の検索実行結果から学習します。:
+.sp
+.nf
+.ft C
+load \-\-table event_query \-\-each \(aqsuggest_preparer(_id, type, item, sequence, time, pair_query)\(aq
+[
+{"sequence": "1", "time": 1312950803.86057, "item": "search engine", "type": "submit"},
+{"sequence": "1", "time": 1312950808.86057, "item": "web search realtime", "type": "submit"}
+]
+.ft P
+.fi
 .SH リファレンスマニュアル
 .SS 実行ファイル
 .sp
@@ -2058,7 +2787,7 @@ out_gqtp コマンドファイル 出力ファイル名
 .UNINDENT
 .SS コマンドファイル
 .sp
-コマンドファイルは、groonga組み込みコマンドを1行に1つずつ記述したテキストファイルです。拡張子に制限はありません。groonga組み込みコマンドに関しては \fBcommands\fP を参照してください。
+コマンドファイルは、groonga組み込みコマンドを1行に1つずつ記述したテキストファイルです。拡張子に制限はありません。groonga組み込みコマンドに関しては \fB/commands\fP を参照してください。
 .SS サンプル
 .sp
 スクリプトファイルのサンプルです。:
@@ -2579,10 +3308,41 @@ GETメソッドのみが使用可能です。
 .sp
 output_typeにはjson, tsv, xmlが指定可能です。
 .sp
-command_versionはコマンドの仕様の互換性を指定します。詳細は \fBcommand_version\fP を参照してください。
+command_versionはコマンドの仕様の互換性を指定します。詳細は \fB/command_version\fP を参照してください。
 .SS 返値
 .sp
 output_typeの指定に従って、コマンドの実行結果を出力します。
+.SS groonga\-suggest\-create\-dataset
+.SS NAME
+.sp
+groonga\-suggest\-create\-dataset \- Defines schema for a suggestion dataset
+.SS SYNOPSTIS
+.sp
+.nf
+.ft C
+groonga\-suggest\-create\-dataset [options] DATABASE DATASET
+.ft P
+.fi
+.SS DESCTIPION
+.sp
+groonga\-suggest\-create\-dataset creates a dataset for \fB/suggest\fP. A database has many datasets. This command just defines schea for a suggestion dataset.
+.SS OPTIONS
+.sp
+None.
+.SS EXIT STATUS
+.sp
+TODO
+.SS FILES
+.sp
+TODO
+.SS EXAMPLE
+.sp
+TODO
+.SS SEE ALSO
+.sp
+\fB/suggest\fP
+.. : doc:\fIgroonga\-suggest\-httpd\fP
+.. : doc:\fIgroonga\-suggest\-learner\fP
 .SS コマンド
 .sp
 まず、すべてのコマンドに関係するコマンドバージョンについて説明します。その後、組み込みのコマンドを順に説明します。
@@ -4472,100 +5232,345 @@ status
 .ft P
 .fi
 .SS suggest
-.sp
-** 未だ仕様は確定しておりません。利用のためには特定のデータを持つテーブルが必要となります。 **
+.IP ノート
+.
+サジェスト機能の仕様はまだ確定していません。仕様は変更される可能性があります。
+.RE
 .SS 名前
 .sp
-suggest \- 指定したクエリに対する補完・修正・提案を行う。
+suggest \- 指定されたクエリに対する補完・補正・提案候補を返す。
 .SS 書式
 .sp
 .nf
 .ft C
-suggest types table column query
+suggest types table column query [sortby [output_columns [offset [limit [frequency_threshold [conditional_probability_threshold [prefix_search]]]]]]]
 .ft P
 .fi
 .SS 説明
 .sp
-suggestコマンドは、指定したクエリに対して補完・修正・提案を行います。
-.sp
-補完とは、クエリの未入力・未変換部分を補うことです。修正とは、クエリ内のミスタイプや誤変換を修正することです。提案とは、さらなる絞込みを行うための候補となるクエリを提案することです。
-.SS 引数
+suggestコマンドは指定されたクエリに対する補完・補正・提案候補を返します。
 .sp
-\fBtypes\fP
+補完・補正・提案については \fB/suggest/introduction\fP を参照してください。
+.SS オプション
 .INDENT 0.0
-.INDENT 3.5
+.TP
+.B \fBtypes\fP
 .sp
-補完・修正・提案のいずれを行うかを、パイプ(\(aq|\(aq)で組み合わせたシンボル名で指定します(例: correct|suggest)
+suggestコマンドでどの種類の候補を返すかを指定します。
 .sp
-\fBcomplete\fP
+指定できる種類は以下の通りです。
+.INDENT 7.0
+.INDENT 3.5
 .INDENT 0.0
+.TP
+.B \fBcomplete\fP
+.sp
+補完を実行します。
+.TP
+.B \fBcorrect\fP
+.sp
+補正を実行します。
+.TP
+.B \fBsuggest\fP
+.sp
+提案を実行します。
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.sp
+1つ以上の種類を指定できます。複数の種類を指定する場合は \fB|\fP で区切ります。以下が例です。:
+.INDENT 7.0
 .INDENT 3.5
 .sp
-補完を行います。
+補正候補を返します:
+.sp
+.nf
+.ft C
+correct
+.ft P
+.fi
+.sp
+補正候補と提案候補を返します:
+.sp
+.nf
+.ft C
+correct|suggest
+.ft P
+.fi
+.sp
+補完候補と補正候補と提案候補を返します:
+.sp
+.nf
+.ft C
+complete|correct|suggest
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.TP
+.B \fBtable\fP
+.sp
+\fBitem_${データセット名}\fP というフォーマットのテーブル名を指定します。例えば、以下のコマンドでデータセットを作成した場合はテーブル名として \fBitem_query\fP を指定します:
+.sp
+.nf
+.ft C
+groonga\-suggest\-create\-dataset /tmp/db\-path query
+.ft P
+.fi
+.TP
+.B \fBcolumn\fP
+.sp
+\fBtable\fP で指定したテーブルにあるふりがな情報を含むカラムを指定します。ふりがなはカタカナで指定します。
+.TP
+.B \fBquery\fP
+.sp
+補完・補正・提案対象のクエリを指定します。
+.TP
+.B \fBsortby\fP
+.sp
+ソートキーを指定します。
+.INDENT 7.0
+.TP
+.B Default:
+.
+\fB\-_score\fP
+.UNINDENT
+.TP
+.B \fBoutput_columns\fP
+.sp
+出力するカラムを指定します。
+.INDENT 7.0
+.TP
+.B Default:
+.
+\fB_key,_score\fP
+.UNINDENT
+.TP
+.B \fBoffset\fP
+.sp
+返されるレコードのオフセットを指定します。
+.INDENT 7.0
+.TP
+.B Default:
+.
+\fB0\fP
+.UNINDENT
+.TP
+.B \fBlimit\fP
+.sp
+返されるレコード数を指定します。
+.INDENT 7.0
+.TP
+.B Default:
+.
+\fB10\fP
+.UNINDENT
+.TP
+.B \fBfrequency_threshold\fP
+.sp
+出現頻度に対する閾値を指定します。返されるレコードの \fB_score\fP 値は \fBfrequency_threshold\fP 以上になります。
+.INDENT 7.0
+.TP
+.B Default:
+.
+\fB100\fP
 .UNINDENT
 .UNINDENT
 .sp
-\fBcorrect\fP
+\fBconditional_probability_threshold\fP
 .INDENT 0.0
 .INDENT 3.5
 .sp
-修正を行います。
+条件付き確率に対する閾値を指定します。学習データに対して条件付き確率を使います。ここで使う条件付き確率は、入力した \fBquery\fP と同じ入力があったときにクエリが検索された確率です。返されるレコードの条件付き確率は \fBconditional_probability_threshold\fP 以上になります。
+.INDENT 0.0
+.TP
+.B Default:
+.
+\fB0.2\fP
+.UNINDENT
 .UNINDENT
 .UNINDENT
-.sp
-\fBsuggest\fP
 .INDENT 0.0
+.TP
+.B \fBprefix_search\fP
+.sp
+補完時に前方一致検索を実行するかどうかを指定します。
+.sp
+指定可能な値は以下の通りです。
+.INDENT 7.0
 .INDENT 3.5
+.INDENT 0.0
+.TP
+.B \fByes\fP
 .sp
-提案を行います。
+常に前方一致検索を実行します。
+.TP
+.B \fBno\fP
+.sp
+前方一致検索を実行しません。
+.TP
+.B \fBauto\fP
+.sp
+他の検索でレコードが見つからない場合のみ前方一致検索を実行します。
+.UNINDENT
 .UNINDENT
 .UNINDENT
+.INDENT 7.0
+.TP
+.B Default:
+.
+\fBauto\fP
 .UNINDENT
 .UNINDENT
+.SS 返値
+.SS JSON形式
 .sp
-\fBtable\fP
+返されるJSON形式は以下の通りです:
+.sp
+.nf
+.ft C
+{"type1": [["candidate1", score of candidate1],
+           ["candidate2", score of candidate2],
+           ...],
+ "type2": [["candidate1", score of candidate1],
+           ["candidate2", score of candidate2],
+           ...],
+ ...}
+.ft P
+.fi
+.sp
+\fBtype\fP
 .INDENT 0.0
 .INDENT 3.5
 .sp
-基礎となるデータが格納されているテーブル名を指定します。
+\fBtypes\fP で指定した値。
 .UNINDENT
 .UNINDENT
 .sp
-\fBcolumn\fP
+\fBcandidate\fP
 .INDENT 0.0
 .INDENT 3.5
 .sp
-基礎となるデータが格納されているテーブルにおいて、「ヨミガナ」が格納されているカラム名を指定します。
+補完・補正・提案候補。
 .UNINDENT
 .UNINDENT
 .sp
-\fBquery\fP
+\fBscore of candidate\fP
 .INDENT 0.0
 .INDENT 3.5
 .sp
-補完・修正・提案の対象となるクエリを指定します。
+対応する \fBcandidate\fP のスコアです。スコアが高いほど補完・補正・提案候補として有力という意味になります。デフォルトでは候補は \fBscore of candidate\fP の降順でソートされています。
 .UNINDENT
 .UNINDENT
-.SS 返値
-.SS json形式
+.SS 例
+.sp
+以下は補完用の学習データです。
+.sp
+Execution example:
 .sp
 .nf
 .ft C
-{"タイプ1":[["候補1", 候補1のスコア], ["候補2", 候補2のスコア], ...], ...}
-
-\(ga\(gaタイプ\(ga\(ga
-
-  types引数に指定した値。
-
-\(ga\(ga候補\(ga\(ga
-
-  補完・修正・提案の候補。
-
-\(ga\(ga候補のスコア\(ga\(ga
-
-  補完・修正・提案として優れたものほど高くなる数値。結果は、スコア順にソートされている。
+> load \-\-table event_query \-\-each \(aqsuggest_preparer(_id, type, item, sequence, time, pair_query)\(aq
+> [
+> {"sequence": "1", "time": 1312950803.86057, "item": "e"},
+> {"sequence": "1", "time": 1312950803.96857, "item": "en"},
+> {"sequence": "1", "time": 1312950804.26057, "item": "eng"},
+> {"sequence": "1", "time": 1312950804.56057, "item": "engi"},
+> {"sequence": "1", "time": 1312950804.76057, "item": "engin"},
+> {"sequence": "1", "time": 1312950805.86057, "item": "engine", "type": "submit"}
+> ]
+[[0,1313562872.82845,1.577141877],6]
 .ft P
 .fi
+.sp
+以下は補正用の学習データです。
+.sp
+Execution example:
+.sp
+.nf
+.ft C
+> load \-\-table event_query \-\-each \(aqsuggest_preparer(_id, type, item, sequence, time, pair_query)\(aq
+> [
+> {"sequence": "2", "time": 1312950803.86057, "item": "s"},
+> {"sequence": "2", "time": 1312950803.96857, "item": "sa"},
+> {"sequence": "2", "time": 1312950804.26057, "item": "sae"},
+> {"sequence": "2", "time": 1312950804.56057, "item": "saer"},
+> {"sequence": "2", "time": 1312950804.76057, "item": "saerc"},
+> {"sequence": "2", "time": 1312950805.76057, "item": "saerch", "type": "submit"},
+> {"sequence": "2", "time": 1312950809.76057, "item": "serch"},
+> {"sequence": "2", "time": 1312950810.86057, "item": "search", "type": "submit"}
+> ]
+[[0,1313562874.6075,2.004191545],8]
+.ft P
+.fi
+.sp
+以下は提案用の学習データです。
+.sp
+Execution example:
+.sp
+.nf
+.ft C
+> load \-\-table event_query \-\-each \(aqsuggest_preparer(_id, type, item, sequence, time, pair_query)\(aq
+> [
+> {"sequence": "3", "time": 1312950803.86057, "item": "search engine", "type": "submit"},
+> {"sequence": "3", "time": 1312950808.86057, "item": "web search realtime", "type": "submit"}
+> ]
+[[0,1313562876.81305,0.801821271],2]
+.ft P
+.fi
+.sp
+以下は補完例です。
+.sp
+Execution example:
+.sp
+.nf
+.ft C
+> suggest \-\-table item_query \-\-column kana \-\-types complete \-\-threshold 1 \-\-query en
+[[0,1313562877.81745,0.001827712],{"complete":[[1],[["_key","ShortText"],["_score","Int32"]],["engine",1]]}]
+.ft P
+.fi
+.sp
+以下は補正例です。
+.sp
+Execution example:
+.sp
+.nf
+.ft C
+> suggest \-\-table item_query \-\-column kana \-\-types correct \-\-threshold 1 \-\-query saerch
+[[0,1313562878.02203,0.000442789],{"correct":[[1],[["_key","ShortText"],["_score","Int32"]],["search",1]]}]
+.ft P
+.fi
+.sp
+以下は提案例です。
+.sp
+Execution example:
+.sp
+.nf
+.ft C
+> suggest \-\-table item_query \-\-column kana \-\-types suggest \-\-threshold 1 \-\-query search
+[[0,1313562878.22422,0.000812428],{"suggest":[[2],[["_key","ShortText"],["_score","Int32"]],["search engine",1],["web search realtime",1]]}]
+.ft P
+.fi
+.sp
+以下は補完・補正・提案を混ぜた例です。
+.sp
+Execution example:
+.sp
+.nf
+.ft C
+> suggest \-\-table item_query \-\-column kana \-\-types complete|correct|suggest \-\-threshold 1 \-\-query search
+[[0,1313562878.42973,0.001223259],{"complete":[[2],[["_key","ShortText"],["_score","Int32"]],["search",2],["search engine",2]],"correct":[[1],[["_key","ShortText"],["_score","Int32"]],["search",2]],"suggest":[[2],[["_key","ShortText"],["_score","Int32"]],["search engine",1],["web search realtime",1]]}]
+.ft P
+.fi
+.SS 参考
+.INDENT 0.0
+.IP \(bu 2
+.
+\fB/suggest\fP
+.IP \(bu 2
+.
+\fB/executables/groonga\-suggest\-create\-dataset\fP
+.UNINDENT
 .SS table_create
 .SS 名前
 .sp