第 2 章 JSVR-Web サービスのインタフェース
2.4 JSVR-CSV インタフェース
2.4.11 手書き文字認識 ( 簡易文字 ) のリファレンス
参考
各機能のリファレンスの説明中では、リクエスト先のサーバを次のように表記しています。
表記 解説
SERVER_NAME Charset-Web入力の部門サーバの公開ドメイン名。例えば"www.foo.bar.com"など。
PORT_NO Charset-Web入力の部門サーバのHTTPサービスが利用するポート。例えば"8080"など。
WEBAPL JSVR-CSVサービスのコンテキスト名。例えば"jsvr_csv"など。
2.4.1 リクエストとレスポンス
◆リクエストの方法
各辞書の検索を行うには、必要なパラメータをHTTPのGETメソッドまたはPOSTメソッドのパラメータとして、JSVR-CSVサービスのURL を呼び出します。
参考
各辞書のリファレンスでは、GETメソッドによるリクエストの例を示しています。
◆候補数の取得方法
・ 「2.2 JSVR-Webサービスのインタフェースを利用する際の制限・注意事項」で説明したように、各辞書を検索する場合は、得られ る検索結果の数を先に取得して、ページングしながら候補を取得することを推奨します。JSVR-CSVサービスで候補数を取得す るためには、各辞書を検索する際のパラメータとして、"getCount=true"を指定してください。
・ リクエストパラメータwithCountを使用すると、HTTPの1回のリクエストで候補と候補数を取得することができて便利です。しかし、
どちらか片方の情報だけが必要な場合に本パラメータを使用すると、不要な検索処理が実行されてしまうため、1回のリクエストで 取得したい情報の種類に応じて本パラメータを使用するようにしてください。
・ リクエストパラメータgetCountとwithCountの関係は次のとおりです。getCount=trueの場合、withCountの指定は無視されます。
getCount=true getCount=false
withCount=true getCount=trueの動作 withCount=trueの動作
withCount=false getCount=trueの動作 getCount=falseかつwithCount=falseの動作
◆リクエスト時のパラメータ指定について
パラメータに何も設定せず空でリクエストを行うと、そのパラメータに空文字("")を設定した場合と同じことになります。「パラメータに値を 設定しない」という意味を表す場合は、パラメータ自体を指定しないでリクエストを行ってください。
◆リクエスト/レスポンスでの値の表現方法について
リクエストやレスポンスで値を表現する際の方法を次の表に示します。
値の種類 表現方法 例
範囲表現 "-"をデリミタとして値を結ぶ。 E000-FFFF
1次元配列表現 ","をデリミタとして値を結ぶ。 あや,あきら,かい 2次元配列表現 ";"をデリミタとして1次元配列表現を結ぶ。 10,20;30,40;50,60
3次元配列表現 "|"をデリミタとして2次元配列表現を結ぶ。 10,20;30,40;50,60|5,10;15,20|1,2;3,4
◆レスポンスについて
JSVR-CSVインタフェースでの検索結果は、次のCSV形式となります。
例)
JSVRVersion 3.0 *情報ヘッダ ColumnHeader true *情報ヘッダ UnlimitedRecordCount 27 *情報ヘッダ *デリミタ行 CODE GLYPHCODE GROUPODE YOMI KAKUSU *以降、CSV本体 07801 KW0BE599 078 いちた 5
08502 KW0CE238 085 みず 5
・
・
・
注意
字形辞書および文字字形辞書のレスポンスは、CSV形式ではなく、メディアタイプが"contentType=image/png"となります。
情報ヘッダ
JSVR-CSVインタフェースの検索結果に情報ヘッダを付加する設定にした場合に、次の形式で出力されます。
－ キーと値をタブコード(¥t)で区切る
－ レコードは0個以上
－ レコードのデリミタは改行コード(¥r¥n)
－ 情報ヘッダとCSV本体はデリミタ行(改行コードのみの行)で区切る
JSVR-CSVインタフェースの検索結果に情報ヘッダを付加するには、JSVR-Webサービス環境ファイルでの設定が必要です。「5.2.1
項目の一覧」の「WEBSERVICE.SYSTEM_OPT_CSVHEADER」の説明を参照してください。
CSV本体
次の項目を満たすCSV形式で出力されます。
－ レスポンスの先頭行は「カラムヘッダ行」
－ カラムのデリミタはタブコード(¥t)
－ レコードのデリミタは改行コード(¥r¥n)
－ メディアタイプおよび文字エンコーディングは、"contentType=plain/text, charset=Windows-31J"
「カラムヘッダ行」には、そのレスポンスのレコード形式が記述されます。その情報を元にして、残りのレコードから各カラムの情報を 取得するようにしてください。
注意
各辞書のレスポンスのレコード形式は、Charset-Web入力のバージョンによって変更される可能性があります。JSVR-CSVインタフェー スのレスポンス利用時には、インタフェースの初回利用時に必ずそのカラムヘッダ行を参照してレコード形式を確認し、各カラムの情 報を取得するようにしてください。
2.4.2 文字辞書のリファレンス
◆リクエスト先の
URLhttp://SERVER_NAME:PORT/WEBAPL/csv/getCharacters
◆パラメータ
名称 解説
getCount 候補数を取得したい場合はtrue、それ以外はfalse。
withCount 候補と候補数を一緒に取得したい場合はtrue、それ以外はfalse。
limitRange 検索結果のページング範囲を1以上の整数で表す。getCount=trueの場合、この指定は無
視される。
codeRanges 一意なIDを持つ辞書エレメントのコード範囲を1次元配列で指定する。
glyphCodeRanges 字形を持つ辞書エレメントの字形コード範囲を1次元配列で指定する。
kakusuRanges 画数範囲を1次元配列で指定する。
kakusuRangesOperant 画数範囲を複数指定した場合の検索指示子をORまたはANDで指定する。
oyajiCodeRanges 親字コード範囲を1次元配列で指定する。
partCodeRanges 文字部品コード範囲を1次元配列で指定する。
partCodeRangesOperant 文字部品コード範囲を複数指定した場合の検索指示子をORまたはANDで指定する。
radicalGroupCodeRanges 部首グループコード範囲を1次元配列で指定する。
radicalGroupCodeRangesOperant 部首グループコード範囲を複数指定した場合の検索指示子をORまたはANDで指定す
る。
yomis 読みを1次元配列で指定する。
yomisOperant 読みを複数指定した場合の検索指示子をORまたはANDで指定する。
名称 解説
sortOrders ソートオーダを1次元配列で指定する。各辞書の検索結果ソートオーダクラスの列挙値を
指定する。
◆カラムヘッダ
カラム名 同義となるJSVR-SOAPインタフェースのクラスプロパティ
CODE WSCharacter.code
GLYPHCODE WSCharacter.glyphCode
YOMIsFORSEARCH WSCharacter.yomisForSearch
ONYOMIs WSCharacter.onyomis
KUNYOMIs WSCharacter.kunyomis
NANORIs WSCharacter.nanoris
JIGI1 ～ JIGI15 WSCharacter.jigis (各配列の要素をJIGI1、JIGI2、…、JIGI15)に展開したもの)
KAKUSUs WSCharacter.kakusus
REPRADICALCODEs WSCharacter.repRadicals[i].code
PARTCODEs WSCharacter.parts[i].code
OYAJICODE WSCharacter.oyaji.code
◆使用例
読みが「あや」かつ「あきら」の文字の1～10番目の候補を取得する場合
http://www.foo.bar.com:8080/jsvr_csv/csv/getCharacters?getCount=false&limitRange=1-10&yomis=あや,あき ら&yomisOperant=AND
2.4.3 部首辞書のリファレンス
◆リクエスト先の
URLhttp://SERVERNAME:PORT/WEBAPL/csv/getRadicals
◆パラメータ
名称 解説
getCount 候補数を取得したい場合はtrue、それ以外はfalse。
withCount 候補と候補数を一緒に取得したい場合はtrue、それ以外はfalse。
limitRange 検索結果のページング範囲を1以上の整数で表す。getCount=trueの場合、この指定は無視される。
codeRanges 一意なIDを持つ辞書エレメントのコード範囲を1次元配列で指定する。
glyphCodeRanges 字形を持つ辞書エレメントの字形コード範囲を1次元配列で指定する。
groupCodeRanges 部首グループコード範囲を1次元配列で指定する。
kakusuRanges 画数範囲を1次元配列で指定する。
yomi 読み。
◆カラムヘッダ
カラム名 同義となるJSVR-SOAPインタフェースのクラスプロパティ
CODE WSRadical.code
GLYPHCODE WSRadical.glyphCode
GROUPCODE WSRadical.groupCode
YOMI WSRadical.yomi
KAKUSU WSRadical.kakusu
◆使用例
部首グループコードが001～002の部首の1～10番目の候補を取得する場合
http://www.foo.bar.com:8080/jsvr_csv/csv/getRadicals?getCount=false&limitRange=1-10
&groupCodeRanges=001-002
2.4.4 文字部品辞書のリファレンス
◆リクエスト先の
URLhttp://SERVERNAME:PORT/WEBAPL/csv/getParts
◆パラメータ
名称 解説
getCount 候補数を取得したい場合はtrue、それ以外はfalse。
withCount 候補と候補数を一緒に取得したい場合はtrue、それ以外はfalse。
limitRange 検索結果のページング範囲を1以上の整数で表す。getCount=trueの場合、この指定は無視される
codeRanges 一意なIDを持つ辞書エレメントのコード範囲を1次元配列で指定する。
glyphCodeRanges 字形を持つ辞書エレメントの字形コード範囲を1次元配列で指定する。
◆カラムヘッダ
カラム名 同義となるJSVR-SOAPインタフェースのクラスプロパティ
CODE WSPart.code
GLYPHCODE WSPart.glyphCode
◆使用例
文字部品コードが4E00～4E05の文字部品の1～10番目の候補を取得する場合
http://www.foo.bar.com:8080/jsvr_csv/csv/getParts?getCount=false&limitRange=1-10
&codeRanges=4E00-4E05
2.4.5 字形辞書のリファレンス
◆リクエスト先の
URLhttp://SERVERNAME:PORT/WEBAPL/csv/getGlyph
注意
V7.0では、リクエスト先のURLが、"http://～/getGlyphs"となっていました。本バージョンでもこの形式で字形辞書を使用できますが、
V8.0からの新しい形式(http://～/getGlyph)の使用を推奨します。
◆パラメータ
名称 解説
code 字形コード。
size 文字画像の四方サイズ。px単位。
foreColor 前景色(いわゆる文字色)。
backColor 背景色。
transparent 背景を透過にする場合はtrue、それ以外はfalse。
antialias このパラメータは使用しないでください。
◆使用例
字形コードがKW01E000の文字画像を48px四方の文字色#FF0000(赤), 背景色#FFFFFF(白)で取得する場合 http://www.foo.bar.com:8080/jsvr_csv/csv/getGlyph?code=KW01E000&size=48&backColor=FFFFFF
&foreColor=FF0000&transparent=true
注意
字形辞書のレスポンスは、CSV形式ではなく、メディアタイプが"contentType=image/png"の画像データとなります。そのため、カラム ヘッダ行はありません。
2.4.6 文字字形辞書のリファレンス
◆リクエスト先の
URLhttp://SERVERNAME:PORT/WEBAPL/csv/getGlyphOfCharacter
◆パラメータ
名称 解説
code 文字コード(運用文字コードで指定)。
glyphSize 文字画像の四方サイズ。px単位。
glyphForeColor 前景色(いわゆる文字色)。
glyphBackColor 背景色。
glyphTransparent 背景を透過にする場合はtrue、それ以外はfalse。
glyphAntialias このパラメータは使用しないでください。
◆使用例
文字コードが3042の文字画像を48px四方の文字色#FF0000(赤), 背景色#FFFFFF(白)で取得する場合 http://www.foo.bar.com:8080/jsvr_csv/csv/getGlyphOfCharacter?code=3042&glyphSize=48
&glyphBackColor=FFFFFF&glyphForeColor=FF0000&glyphTransparent=true
注意
・ 文字字形辞書のレスポンスは、CSV形式ではなく、メディアタイプが"contentType=image/png"の画像データとなります。そのため、
カラムヘッダ行はありません。
・ リクエスト中で使用するパラメータ名がログ情報に出力される場合は、次の対応表のとおりの名称で出力されます。
リクエスト中で使用するパラメータ名 ログ情報に出力されるパラメータ名
code code
glyphSize size
glyphForeColor foreColor
glyphBackColor backColor
glyphTransparent transparent
2.4.7 単語辞書/KUIN 氏名辞書のリファレンス
◆リクエスト先の
URL 単語辞書http://SERVERNAME:PORT/WEBAPL/csv/getWords KUIN氏名辞書
http://SERVERNAME:PORT/WEBAPL/csv/getWordsByKuinName
◆パラメータ
名称 解説
getCount 候補数を取得したい場合はtrue、それ以外はfalse。
withCount 候補と候補数を一緒に取得したい場合はtrue、それ以外はfalse。
limitRange 検索結果のページング範囲を1以上の整数で表す。getCount=trueの場合、この指定は無視される。
yomi 読み。
sortOrders ソートオーダ1次元配列。各辞書の検索結果ソートオーダクラスの列挙値を指定する
characterCodes 文字コード1次元配列。
hinshi 品詞。単語辞書の品詞クラスの列挙値を指定する
groups グループ化。単語辞書のグループ化クラスの列挙値を指定する
◆カラムヘッダ
カラム名 同義となるJSVR-SOAPインタフェースのクラスプロパティ
CHARACTERCODEs WSWord.characters[i].code
GLYPHCODEs WSWord.characters[i].glyph[j].code
YOMI WSWord.yomi
HINSHI WSWord.hinshi
◆使用例
読みが"あや"の単語の1～10番目の候補を取得する場合