テキスト解析
かな漢字変換
リクエストURL
XML
https://jlp.yahooapis.jp/JIMService/V1/conversion
ローマ字、ひらがなの文を文節に区切り、変換候補を提示します。短い文字列から変換候補を推測するモードも提供します。VJEと同じ方式のかな漢字変換です。
リクエストパラメータ
「RESTリクエストの構築（GET）」および、「RESTリクエストの構築（POST）」をご参照ください。
| パラメータ | 値 | 説明 |
|---|---|---|
| appid（必須） | string | アプリケーションID。詳細はこちらをご覧ください。 |
| sentence（必須） | string | かな漢字変換対象のテキストです。文節の区切りを指定したい場合は、テキストを半角スペースで区切ってください。ローマ字変換モード（roman）、推測変換モード（predictive）では機能しません。 半角スペースが2文字連続して並ぶ場合は、文節の区切りではなく1文字の半角スペースとして処理します。 最大文字数は80文字（ひらがな換算時）までとします。 |
| format | string: roman | "sentence"のテキストフォーマットを指定します。かな漢字変換の対象となるテキスト情報はひらがなのみとなります。 "roman"を指定すると、リクエストされたテキスト情報中のひらがなと半角英小文字が変換対象となります。 |
| mode | string: normal, roman, predictive | かな漢字変換処理で通常変換、ローマ字変換、推測変換のいずれかを指定します。
|
| response | string: katakana, hiragana, alphanumeric, half_katakana, half_alphanumeric | 通常のかな漢字変換のほかに、指定の変換候補を返します。複数指定できます。
|
| dictionary | string: default, name, place, zip, symbol | 変換候補用の辞書を指定します。複数指定できます。
|
| results | integer: 999（デフォルトかつ最大） | 文節単位の変換候補の数を指定します。 |
サンプルリクエストURL
https://jlp.yahooapis.jp/JIMService/V1/conversion?レスポンスフィールド
かな漢字変換のスキーマの記述は、以下のURLをご覧ください。
https://jlp.yahooapis.jp/JIMService/V1/conversion.xsd
| フィールド | 説明 |
|---|---|
| ResultSet | かな漢字変換結果のすべてを含みます。 |
| Result | 文節ごとの変換結果で各個別レスポンスを含みます。 |
| SegmentList | かな漢字変換によって区切られたテキスト情報の文節のリストです。各文節の情報を含みます。 |
| Segment | 文節の変換候補を含みます。 |
| SegmentText | 文節ごとの読みにあたる文字列です。 |
| Alphanumeric | 全角英数字の変換結果です。 |
| HalfAlphanumeric | 半角英数字の変換結果です。 |
| Katakana | 全角カタカナの変換結果です。 |
| HalfKatakana | 半角カタカナの変換結果です。 |
| Hiragana | 全角ひらがなの変換結果です。 |
| CandidateList | 変換候補をすべて含みます。 |
| Candidate | 変換候補です。 |
サンプルレスポンス
以下は、sentence=きょうはよいてんきです。のリクエストに対するレスポンスです。
<?xml version="1.0" encoding="UTF-8"?>
<ResultSet xmlns="urn:yahoo:jp:jlp:JIMService" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="urn:yahoo:jp:jlp:JIMService https://jlp.yahooapis.jp/JIMService/V1/conversion.xsd">
<Result>
<SegmentList>
<Segment>
<SegmentText>きょうは</SegmentText>
<CandidateList>
<Candidate>今日は</Candidate>
<Candidate>きょうは</Candidate>
<Candidate>教派</Candidate>
<Candidate>興は</Candidate>
<Candidate>京は</Candidate>
<Candidate>強は</Candidate>
<Candidate>経は</Candidate>
<Candidate>教は</Candidate>
<Candidate>境は</Candidate>
<Candidate>凶は</Candidate>
<Candidate>卿は</Candidate>
<Candidate>峡は</Candidate>
<Candidate>協は</Candidate>
<Candidate>香は</Candidate>
<Candidate>恭は</Candidate>
<Candidate>享は</Candidate>
</CandidateList>
</Segment>
<Segment>
<SegmentText>よい</SegmentText>
<CandidateList>
<Candidate>よい</Candidate>
<Candidate>良い</Candidate>
<Candidate>宵</Candidate>
<Candidate>酔い</Candidate>
<Candidate>四位</Candidate>
<Candidate>４位</Candidate>
<Candidate>余威</Candidate>
<Candidate>好い</Candidate>
<Candidate>善い</Candidate>
<Candidate>佳い</Candidate>
<Candidate>吉い</Candidate>
<Candidate>快い</Candidate>
</CandidateList>
</Segment>
<Segment>
<SegmentText>てんきです。</SegmentText>
<CandidateList>
<Candidate>天気です。</Candidate>
<Candidate>転機です。</Candidate>
<Candidate>転記です。</Candidate>
<Candidate>転帰です。</Candidate>
<Candidate>天機です。</Candidate>
<Candidate>てんきです。</Candidate>
</CandidateList>
</Segment>
</SegmentList>
</Result>
</ResultSet>
エラー
かな漢字変換はYahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。
利用制限
かな漢字変換Web APIは、24時間以内で1つのアプリケーションIDにつき50000件のリクエストが上限となっています。また、1リクエストの最大サイズを10KBに制限しています。詳しくは「利用制限」をご参照ください。