gss3プロトコル

Top > gss3プロトコル

gss3プロトコルは、GETAssocの検索系の操作をWebアプリケーションから簡単に利用するために定義された規約です。WebアプリケーションとGETAssocの通信路にはHTTPを利用し、データのフォーマット形式にはXMLを利用します。このためHTTPで通信できる機能を持った任意のプログラム言語でクライアントを作成することができますし、Javascriptを用いて直接ブラウザ上からGETAssocへアクセスすることもできます。

基本

• 送受信(Request, Response)ともにXML形式です。
• Rootタグは<gss></gss>です。
• 名前空間は http://gss3.cs.nii.ac.jp/ です。

Gss3 Protocol Analyzer

gss3プロトコルを用いた実装例として、Javascriptで作成されブラウザ上で動作するサンプルアプリケーションGSS3 Protocol Analyzerがあります。gss3プロトコルを用いた実際のRequest、Response形式を簡単に確認することができます。使用するためには、Webページから次のファイルを直接ダウンロードし、同じディレクトリに置いてください。

• http://getassoc.cs.nii.ac.jp/gpa/gss3.html
• http://getassoc.cs.nii.ac.jp/gpa/gss3.js
• 
  次にgss3.jsの866行目を環境に合わせて書き換えます。同一マシンで動作させるときは、次のようにします。

  gss3.url = 'http://localhost/getassoc/gss3';

assoc (連想検索)

GETAssocの検索系の動作を指定します。連想検索のデータの流れについては詳細/GETAssocにおける連想計算もご覧ください。

Request

<?xml version="1.0" encoding="UTF-8"?>
<gss version="3.0" xmlns="http://gss3.cs.nii.ac.jp/">
  <assoc target="ja_document" niwords="70" cutoff-df="10000"
         narticles="10" nkeywords="10" yykn="10" nacls="1" nkcls="1" a-offset="0" a-props="title,link" 
         cross-ref="aw,wa" stage1-sim="WT_SMARTAW" stage2-sim="WT_SMARTWA">
    <freetext cutoff-df="30000" stemmer="MECAB">getassocを使って連想検索を効率的にしたい。</freetext>
    <article name="12345"/>
    <article vec="[[&quot;晴れ&quot;,1],[&quot;曇り&quot;,1],[&quot;雨&quot;,1]]"/>
    <filter expression="(&quot;雨&quot; &amp; !&quot;雪&quot;)"/>
    <filter>
      <search>
        <join>
          <p>効率的にしたい</p>
          <n>したくない</n>
        </join>
      </search>
    </filter>
  </assoc>
</gss>

連想検索のRequestは主に次の3つのパートから成り立っています

<assoc>タグの属性

連想検索の計算法、検索結果の出力の指定

<freetext>、<article>タグ

クエリーの表現

<filter>タグ

検索結果の絞り込み条件の指定

<assoc>タグの属性

stage1に関連する属性

stage2に関連する属性

<freetext>、<article>タグによるクエリーの表現

<freetext>タグ

<freetext stemmer="MECAB" cutoff-df="0">getassocを使って連想検索を効率的にしたい。</freetext>

<article>タグ

<article name="12345"/>
<article vec="[[&quot;晴れ&quot;,1],[&quot;曇り&quot;,1],[&quot;雨&quot;,1]]"/>
<article name="12345" source="wikipedia_en">

<filter>タグによる検索結果の絞り込み

<filter expression="〜">

<filter expression="(&quot;雨&quot; &amp; !&quot;雪&quot;) | &quot;雷&quot;"/>

expression属性内ではstemmerによりstemmingされた単語を使います。ブール式を組み合わせることで絞り込み条件が指定できます。

<filter><search><join>〜</join><join>〜</join></search></filter>

    <filter>
      <search>
        <join>
          <p>効率的にしたい</p>
          <n>したくない</n>
        </join>
        <join>
          <p>お世話になっています</p>
        </join>
      </search>
    </filter>

この形式では特定のフレーズにより検索結果の絞り込み条件が指定できます。ただし全文一致インデックスを作成している場合のみ有効です。書式の詳細は全文検索の項をご覧ください。

Response

stage1,2で分割

assoc (全文検索)

GETAssocで全文一致検索を実行します。stpでのインデックス作成時に全文検索オプション(@fss)を指定したときにのみ使用できます。

Request

<?xml version="1.0" encoding="UTF-8"?>
<gss version="3.0">
  <assoc target="wikipedia_ja" narticles="10" nkeywords="10" yykn="10" nacls="1" 
     nkcls="1" a-offset="0" a-props="title,link">
    <search segments="0-31">
      <join segments="0" options="match-tail">
        <p>サイン</p>
        <n>コサイン</n>
      </join>
      <join>
        <p segments="0,2-5">署名</p>
      </join>
    </search>
  </assoc>
</gss>

<assoc>タグの属性

連想検索の<assoc>タグのstage2と同じです。ただしstage2-simは使用しません。

<search>タグ

全文一致検索の一致条件を書きます。

<search>タグ内では<join>タグを1つ以上含み、それぞれはOR関係となります。<join>タグ内では、<p>タグに必ず含むフレーズを、<n>タグに含まないフレーズを指定します。<join>内では複数の<p>、<n>タグが記述でき、それぞれはAND関係となりますが、<n>タグのみの指定はできません。

<search>、<join>、<p>、<n>タグには、それぞれ独自に次の属性を付加することができます。

segments

全文一致部分を指定します。segmentsは、itbファイル内の全文検索用文字列の行に対応します。例えば「!123\n!456」のとき、segments=0は「123」に、segments=1は「456」に対応します。現在、segmentsは0から31までしか対応していません。

options

全文一致条件を指定します。詳しくは次の表をご覧ください。

options について

optionsは、全文検索インデックスがあれば適用できるものと、インデックス作成時に予め指定しておかないと適用できないものがあります。

• 全文検索インデックスがあれば適用できるオプション

• インデックス作成時に指定しておかないと適用できないオプション

インデックス作成時にオプションを指定するためには、itbファイルの先頭で次のように指定します。

@title=データベース1
$ignore-case,collapse-hirakata,collapse-zdz

ただし、これらのオプションを指定して作成された全文一致検索用インデックスは、検索速度が大きく低下する場合があります。

Response

getprop

各ドキュメントのpropertyを取得します。

Request

<?xml version="1.0" encoding="UTF-8"?>
<gss version="3.0" xmlns="http://gss3.cs.nii.ac.jp/" >
  <getprop target="handle" a-props="title,link,vec" >
    <article name="A1" />
    <article name="A2" />
  </getprop>
</gss>

• targetには、情報を取得したいコーパスのnameを指定ください。
• a-propsには、取得するドキュメントの情報を指定します。
  • titleやlinkは、stpによるコーパスのインデックス時に指定したプロパティに対応するものです。
  • vecを指定すると、ドキュメントを構成する用語と頻度のリストを取得することができます。
• 一度に複数のドキュメントを指定することができます。

Response

<?xml version="1.0" encoding="UTF-8"?>
<gss version="3.0" xmlns="http://gss3.cs.nii.ac.jp/" user-time="0.019">
  <result status="OK" >
    <article name="A1" title="A1 title" link="http://..." vec='[["T1",3],["T2",5], ... ,["T100",1]]'/>
    <article name="A2" title="A2 title" link="http://..." vec='[["T2",1],["T3",8], ... ,["T200",1]]'/>
  </result>
</gss>

• 各ドキュメントごとにタグがあり、その属性値に情報が付与されます。
• vecには、用語とその頻度のリストがJSON形式の文字列として格納されています。

inquire

GETAssocで現在検索できるデータの情報(catalogueといいます)を取得します。

Request

<?xml version="1.0" encoding="UTF-8"?>
<gss version="3.0" xmlns="http://gss3.cs.nii.ac.jp/">
  <inquire type="catalogue" />
</gss>

• このRequestには、ユーザが指定できる属性はありません。

Response

<?xml version="1.0" encoding="UTF-8"?>
<gss version="3.0" xmlns="http://gss3.cs.nii.ac.jp/" user-time="0.005">
  <result status="OK" >
    <corpus name="hdhcx" title="Encyclopedia Galactica" properties="title,link" created="1141782415" ... />
    <corpus name="senya" title="..." properties=... created="..." />
    ...
  </result>
</gss>

• 各コーパスの情報が返ってきます。

エラーについて

Requestに不備がある場合、もしくはGETAssoc内部で何らかのエラーが発生した場合、Responseからはエラー情報が返ってきます。以下に代表的なエラー情報を示します。

loading XML document error

RequestのXMLが間違っています。

unknown attribute

定義されていない属性が使われています。

unknown weight type

定義されていない類似度名が使われています。

最終更新日: 2014-12-09 (火) 18:25:46 (1386d)