[Groonga-commit] groonga/groonga at 3fcf8d3 [master] doc: update example for RK search

Back to archive index

HAYASHI Kentaro null+****@clear*****
Fri Oct 18 15:18:59 JST 2013


HAYASHI Kentaro	2013-10-18 15:18:59 +0900 (Fri, 18 Oct 2013)

  New Revision: 3fcf8d311552f92b78983a3d49d120f6b17472b2
  https://github.com/groonga/groonga/commit/3fcf8d311552f92b78983a3d49d120f6b17472b2

  Message:
    doc: update example for RK search

  Added files:
    doc/source/example/suggest/complete/registered-word-japan.log
    doc/source/example/suggest/complete/registered-word-japanese.log
    doc/source/example/suggest/complete/rk-search-nihon.log
    doc/source/example/suggest/complete/rk-search-nippon.log
    doc/source/example/suggest/complete/update-rk-data.log
  Modified files:
    doc/source/suggest/completion.txt

  Added: doc/source/example/suggest/complete/registered-word-japan.log (+7 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/example/suggest/complete/registered-word-japan.log    2013-10-18 15:18:59 +0900 (9cccfad)
@@ -0,0 +1,7 @@
+Execution example::
+
+  load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)'
+  [
+  {"sequence": "1", "time": 1312950805.86058, "item": "日本", "type": "submit"}
+  ]
+  # [[0, 1337566253.89858, 0.000355720520019531], 1]

  Added: doc/source/example/suggest/complete/registered-word-japanese.log (+93 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/example/suggest/complete/registered-word-japanese.log    2013-10-18 15:18:59 +0900 (019de56)
@@ -0,0 +1,93 @@
+Execution example::
+
+  load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)'
+  [
+  {"sequence": "1", "time": 1312950805.86059, "item": "日本語", "type": "submit"}
+  {"sequence": "1", "time": 1312950805.86060, "item": "日本人", "type": "submit"}
+  ]
+  # [[0, 1337566253.89858, 0.000355720520019531], 2]
+  load --table item_query
+  [
+  {"_key":"日本語", "kana":"ニホンゴ"}
+  {"_key":"日本人", "kana":"ニホンジン"}
+  ]
+  # [[0, 1337566253.89858, 0.000355720520019531], 2]
+  suggest --table item_query --column kana --types complete --frequency_threshold 1 --query nihon
+  # [
+  #   [
+  #     0, 
+  #     1337566253.89858, 
+  #     0.000355720520019531
+  #   ], 
+  #   {
+  #     "complete": [
+  #       [
+  #         3
+  #       ], 
+  #       [
+  #         [
+  #           "_key", 
+  #           "ShortText"
+  #         ], 
+  #         [
+  #           "_score", 
+  #           "Int32"
+  #         ]
+  #       ], 
+  #       [
+  #         "日本", 
+  #         2
+  #       ], 
+  #       [
+  #         "日本人", 
+  #         2
+  #       ], 
+  #       [
+  #         "日本語", 
+  #         2
+  #       ]
+  #     ]
+  #   }
+  # ]
+  load --table item_query
+  [
+  {"_key":"日本人", "boost": 100},
+  ]
+  # [[0, 1337566253.89858, 0.000355720520019531], 1]
+  suggest --table item_query --column kana --types complete --frequency_threshold 1 --query nihon
+  # [
+  #   [
+  #     0, 
+  #     1337566253.89858, 
+  #     0.000355720520019531
+  #   ], 
+  #   {
+  #     "complete": [
+  #       [
+  #         3
+  #       ], 
+  #       [
+  #         [
+  #           "_key", 
+  #           "ShortText"
+  #         ], 
+  #         [
+  #           "_score", 
+  #           "Int32"
+  #         ]
+  #       ], 
+  #       [
+  #         "日本人", 
+  #         102
+  #       ], 
+  #       [
+  #         "日本", 
+  #         2
+  #       ], 
+  #       [
+  #         "日本語", 
+  #         2
+  #       ]
+  #     ]
+  #   }
+  # ]

  Added: doc/source/example/suggest/complete/rk-search-nihon.log (+31 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/example/suggest/complete/rk-search-nihon.log    2013-10-18 15:18:59 +0900 (9842079)
@@ -0,0 +1,31 @@
+Execution example::
+
+  suggest --table item_query --column kana --types complete --frequency_threshold 1 --query nihon
+  # [
+  #   [
+  #     0, 
+  #     1337566253.89858, 
+  #     0.000355720520019531
+  #   ], 
+  #   {
+  #     "complete": [
+  #       [
+  #         1
+  #       ], 
+  #       [
+  #         [
+  #           "_key", 
+  #           "ShortText"
+  #         ], 
+  #         [
+  #           "_score", 
+  #           "Int32"
+  #         ]
+  #       ], 
+  #       [
+  #         "日本", 
+  #         2
+  #       ]
+  #     ]
+  #   }
+  # ]

  Added: doc/source/example/suggest/complete/rk-search-nippon.log (+31 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/example/suggest/complete/rk-search-nippon.log    2013-10-18 15:18:59 +0900 (b3fc7c2)
@@ -0,0 +1,31 @@
+Execution example::
+
+  suggest --table item_query --column kana --types complete --frequency_threshold 1 --query nippon
+  # [
+  #   [
+  #     0, 
+  #     1337566253.89858, 
+  #     0.000355720520019531
+  #   ], 
+  #   {
+  #     "complete": [
+  #       [
+  #         1
+  #       ], 
+  #       [
+  #         [
+  #           "_key", 
+  #           "ShortText"
+  #         ], 
+  #         [
+  #           "_score", 
+  #           "Int32"
+  #         ]
+  #       ], 
+  #       [
+  #         "日本", 
+  #         2
+  #       ]
+  #     ]
+  #   }
+  # ]

  Added: doc/source/example/suggest/complete/update-rk-data.log (+7 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/example/suggest/complete/update-rk-data.log    2013-10-18 15:18:59 +0900 (862a9a3)
@@ -0,0 +1,7 @@
+Execution example::
+
+  load --table item_query
+  [
+  {"_key":"日本", "kana":["ニホン", "ニッポン"]}
+  ]
+  # [[0, 1337566253.89858, 0.000355720520019531], 1]

  Modified: doc/source/suggest/completion.txt (+53 -8)
===================================================================
--- doc/source/suggest/completion.txt    2013-10-18 14:17:24 +0900 (550d299)
+++ doc/source/suggest/completion.txt    2013-10-18 15:18:59 +0900 (de46b9d)
@@ -199,21 +199,66 @@ following command::
 How to update RK reading data
 -----------------------------
 
-Groonga requires its reading for RK search, so load reading data in the advance.
+Groonga requires registered word and its reading for RK search, so load such data in the advance.
 
-Here is the sample RK data to complete "エンジン" which means engine in english::
+
+Here is the example to register "日本" which means Japanese in english.
+
+.. groonga-command
+.. include:: ../example/suggest/complete/registered-word-japan.log
+.. load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)'
+.. [
+.. {"sequence": "1", "time": 1312950805.86058, "item": "日本", "type": "submit"}
+.. ]
+
+
+Here is the example to update RK data to complete "日本".
 
 .. groonga-command
-.. include:: ../example/suggest/update-rk-data.log
+.. include:: ../example/suggest/complete/update-rk-data.log
 .. load --table item_query
 .. [
-.. {"_key":"engine", "kana":"エンジン"}
+.. {"_key":"日本", "kana":["ニホン", "ニッポン"]}
 .. ]
 
-Then you can complete registered word "engine" by RK input - "エン".
+Then you can complete registered word "日本" by RK input - "nihon".
 
 .. groonga-command
-.. include:: ../example/suggest/complete-rk-engine.log
-.. suggest --table item_query --column kana --types complete --frequency_threshold 1 --query エン
+.. include:: ../example/suggest/complete/rk-search-nihon.log
+.. suggest --table item_query --column kana --types complete --frequency_threshold 1 --query nihon
+
+Without loading above RK data, you can't complete registered word "日本" by query - "nihon".
+
+As the column type of item_query table is VECTOR_COLUMN, you can register multiple readings for registered word.
+
+This is the reason that you can also complete the registered word "日本" by query - "nippon".
+
+.. groonga-command
+.. include:: ../example/suggest/complete/rk-search-nippon.log
+.. suggest --table item_query --column kana --types complete --frequency_threshold 1 --query nippon
+
+This feature is very convenient because you can search registered word even though Japanese IM is disabled.
+
+If there are multiple candidates as completed result, you can customize priority to set the value of "boost" column in item_query table.
+
+Here is the example to customize priority for RK search.
+
+.. groonga-command
+.. include:: ../example/suggest/complete/registered-word-japanese.log
+.. load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)'
+.. [
+.. {"sequence": "1", "time": 1312950805.86059, "item": "日本語", "type": "submit"}
+.. {"sequence": "1", "time": 1312950805.86060, "item": "日本人", "type": "submit"}
+.. ]
+.. load --table item_query
+.. [
+.. {"_key":"日本語", "kana":"ニホンゴ"}
+.. {"_key":"日本人", "kana":"ニホンジン"}
+.. ]
+.. suggest --table item_query --column kana --types complete --frequency_threshold 1 --query nihon
+.. load --table item_query
+.. [
+.. {"_key":"日本人", "boost": 100},
+.. ]
+.. suggest --table item_query --column kana --types complete --frequency_threshold 1 --query nihon
 
-Without loading above RK data, you can't complete registered word "engine" by query which contains Katakana - "エン".
-------------- next part --------------
HTML����������������������������...
Download 



More information about the Groonga-commit mailing list
Back to archive index