SumibiWebAPI(testing)

このドキュメントについて

このドキュメントはperl等の様々な言語からsumibi.org上の漢字変換サービスを利用する方法を解説しています。

Sumibi Web APIとは

• Sumibi Web APIは、sumibi.orgで公開しているSOAP 1.1準拠の漢字変換Webサービスです。
• SOAPライブラリを持つ言語ならどの言語からでも利用できます。
• WSDLを公開していますので、SOAPの詳細な知識なしにSumibi Web APIを利用することができます。
• WSDLファイル(テスト版)

Sumibi Web API仕様

メソッド

1. getStatusメソッド
   • パラメータ

     なし

   • 戻り値

     SumibiStatus型

     名前	値
     version	APIのバージョン番号(例:0.7.3)

2. doSumibiConvertメソッド
   • パラメータ

     名前	値
     query	変換したいローマ字文字列
     sumi	変換に使用する辞書名(未使用)
     history	変換履歴文字列(変換候補IDのリストを;記号で分離したもの)
     dummy	(未使用)

   • 戻り値

     SumibiResult型

     名前	値
     convertTime	変換処理に要した秒数(未実装)
     resultElements	変換候補の配列(下記ResultElementArray型参照)

     ResultElementArray型(以下の構造体の配列となります)

     名前	値
     id	単語ID(DB内での識別番号:ヒストリデータの返信に使用)
     no	文節番号
     candidate	変換候補番号(ゼロが一番適合率が高い)
     spaces	文節と文節の間のスペースの数
     type	変換候補タイプ( j:漢字、h:平仮名、k:カタカナ、l:アルファベット)
     word	変換候補文字列

3. doSumibiConvertHiraメソッド
   • パラメータ

     名前	値
     query	変換したいローマ字文字列
     sumi	変換に使用する辞書名(未使用)
     history	変換履歴文字列(変換候補IDのリストを;記号で分離したもの)
     dummy	(未使用)

   • 戻り値

     ローマ字を平仮名に変換した文字列(UTF-8固定)

4. doSumibiConvertSexpメソッド(Emacs専用)
   • パラメータ

     名前	値
     query	変換したいローマ字文字列
     sumi	変換に使用する辞書名(未使用)
     history	変換履歴文字列(変換候補IDのリストを;記号で分離したもの)
     dummy	(未使用)

   • 戻り値

     base64エンコードされたEmacs用S式

     (注意:S式の日本語エンコードは常にEUC-JPです)

サンプルプログラムを動かす

perlからsumibi.orgのサービスを呼びだす

サンプルプログラムの中にはGPLではなくLGPLのものもあります。

ライセンスはサンプルプログラムに明記していますので、再配布する場合は、ファイルの中身を良く確認してください。

以下の手順で perl のサンプルプログラムを動かすことができます。

尚、http proxyサーバーを経由した通信には対応していません。

• SOAP::Liteモジュールをインストールする

  CPAN等からSOAP::Liteモジュールを取得してインストールしてください。

  * Debianの場合は、libsoap-lite-perlパッケージをインストールしてください。

  * ActivePerlの場合は ppm で SOAP::Liteモジュールをインストールしてください。

• Crypt-SSLeayモジュールをインストールする

  * Debianの場合は、libcrypt-ssleay-perlパッケージをインストールしてください。

  * ActivePerlの場合は ppm で install http://theoryx5.uwinnipeg.ca/ppms/Crypt-SSLeay.ppdをインストールしてください。

• SumibiWebApiSample.plを起動する

  ./SumibiWebApiSample.pl sumibi

  [結果]

  version : 0.3.3
  sexp : \
      KCgoaiAiw7qy0CIgMCAwKSAoaCAipLmk36TTIiAwIDEpIChrICKluaXfpdMiIDAgMikgKGwgInN1bWliaSIgMCAzKSkp \
  time    : 1
  dump    : $VAR1 = [
            {
              'no' => '0',
              'type' => 'j',
              'word' => '炭火',
              'candidate' => '0'
            },
            {
              'no' => '0',
              'type' => 'h',
              'word' => 'すみび',
              'candidate' => '1'
            },
            {
              'no' => '0',
              'type' => 'k',
              'word' => 'スミビ',
              'candidate' => '2'
            },
            {
              'no' => '0',
              'type' => 'l',
              'word' => 'sumibi',
              'candidate' => '3'
            }
          ];
  hiragana: すみび
  

rubyからsumibi.orgのサービスを呼びだす

サンプルプログラムの中にはGPLではなくLGPLのものもあります。

ライセンスはサンプルプログラムに明記していますので、再配布する場合は、ファイルの中身を良く確認してください。

以下の手順で ruby のサンプルプログラムを動かすことができます。

• Ruby 1.8.3をインストールする
• SumibiWebApiSample.rbを起動する

  ./SumibiWebApiSample.rb sumibi

  [結果]

  version : 0.7.3
  sexp : \
      KCgoaiAiw7qy0CIgMzE3ODg1IDAgMCAwKSAoaCAipLmk36TTIiAzMTc4ODUgMCAxIDApIChrICKluaXfpdMiIDMxNzg4NSAwIDIgMCkgKGwgInN1bWliaSIgMzE3ODg1IDAgMyAwKSkp \
  time    : 1
  dump    : 
   cand:0 id:317885 no:0 spaces:0 type:j word:炭火
   cand:1 id:317885 no:0 spaces:0 type:h word:すみび
   cand:2 id:317885 no:0 spaces:0 type:k word:スミビ
   cand:3 id:317885 no:0 spaces:0 type:l word:sumibi
  hiragana: すみび
  

Pythonからsumibi.orgのサービスを呼びだす

サンプルプログラムの中にはGPLではなくLGPLのものもあります。

ライセンスはサンプルプログラムに明記していますので、再配布する場合は、ファイルの中身を良く確認してください。

以下の手順で ruby のサンプルプログラムを動かすことができます。

• Python 2.4.3以上をインストールする
• 必要なモジュール-SOAPpy -PyXML -fpconst
• SumibiWebApiSample.pyを起動する

  ./SumibiWebApiSample.py sumibi

  [結果]

  version :  0.7.3
  sexp : \
      KCgoaiAiw7qy0CIgMzE3ODg1IDAgMCAwKSAoaCAipLmk36TTIiAzMTc4ODUgMCAxIDApIChrICKluaXfpdMiIDMxNzg4NSAwIDIgMCkgKGwgInN1bWliaSIgMzE3ODg1IDAgMyAwKSkp \
  cand:0 id:317885 no:0 spaces:0 type:j word:炭火
  cand:1 id:317885 no:0 spaces:0 type:h word:すみび
  cand:2 id:317885 no:0 spaces:0 type:k word:スミビ
  cand:3 id:317885 no:0 spaces:0 type:l word:sumibi
  hiragana:  すみび
  

サンプルが提供されているサイトの紹介

SumibiWebAPIを呼びだすサンプル(PHP版)

• タカさんが、PHPからSumibiWebAPIを呼びだすサンプルを公開されています。公開ありがとうございます。

  サンプルについて解説されたブログ記事

サンプルプログラム提供のおねがい

Sumibiプロジェクトでは、SumibiWebAPIを様々な言語から試せるように、様々な言語で書いたサンプルプログラムを集めています。

貴方の得意な言語で書いた、分かりやすいサンプルプログラムを送って下さい。次のリリースに含めさせて頂きます。

送って頂く場合は、ライセンスを明記してください。ライセンスは自由ですが、サンプルプログラムを元にクライアントソフトを作りたい人のためになるべくLGPLが良いと考えています。