テキスト解析
ルビ振り
リクエストURL
XML
https://jlp.yahooapis.jp/FuriganaService/V1/furigana
漢字かな交じり文に、ひらがなとローマ字のふりがな(ルビ)を付けます。
リクエストパラメータ
「RESTリクエストの構築(GET)」および、「RESTリクエストの構築(POST)」をご参照ください。
パラメータ | 値 | 説明 |
---|---|---|
appid(必須) | string | アプリケーションID。詳細はこちらをご覧ください。 |
sentence(必須) | string | ふりがなを付ける対象のテキストです。 |
grade | string | 学年(注1)を指定します。 1: 小学1年生向け。漢字(注2)にふりがなを付けます。 2: 小学2年生向け。1年生で習う漢字にはふりがなを付けません。 3: 小学3年生向け。1~2年生で習う漢字にはふりがを付けません。 4: 小学4年生向け。1~3年生で習う漢字にはふりがなを付けません。 5: 小学5年生向け。1~4年生で習う漢字にはふりがなを付けません。 6: 小学6年生向け。1~5年生で習う漢字にはふりがなを付けません。 7: 中学生以上向け。小学校で習う漢字にはふりがなを付けません。 8: 一般向け。常用漢字にはふりがなを付けません。 無指定の場合、ひらがなを含むテキストにふりがなを付けます。 注1:学年は「小学校学習指導要領」の付録「学年別漢字配当表」(1989年3月15日文部科学省告示。1992年4月施行)を参考に設定されています。 注2:JIS X 0208が定める漢字 |
サンプルリクエストURL
https://jlp.yahooapis.jp/FuriganaService/V1/furigana?レスポンスフィールド
ルビ振りのスキーマの記述は、以下のURLをご覧ください。
https://jlp.yahooapis.jp/FuriganaService/V1/furigana.xsd
フィールド | 説明 |
---|---|
ResultSet | ふりがなを付けた結果のすべてを含みます。 |
Result | ふりがなを付けた結果を含みます。 |
WordList | 単語(注3)のリストを返します。 |
Word | 単語を返します。 |
Surface | 単語の表記を返します。 |
Furigana | 単語のよみをひらがなで返します。 |
Roman | 単語のよみをローマ字で返します。 |
SubWordList | 単語が漢字かな交じりのとき、その単語を、さらに細かく漢字部分とひらがな部分に分割した結果のリストを返します。 |
SubWord | 漢字かな交じりの単語を、漢字部分とひらがな部分に分割した結果を返します。 |
注3:単語は、このサービス独自の区切り方となり、形態素とは異なるものです。
サンプルレスポンス
以下は、grade=1、sentence=漢字かな交じり文にふりがなを振ること。のリクエストに対するレスポンスです。
<?xml version="1.0" encoding="UTF-8"?> <ResultSet xmlns="urn:yahoo:jp:jlp:FuriganaService" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="urn:yahoo:jp:jlp:FuriganaService https://jlp.yahooapis.jp/FuriganaService/V1/furigana.xsd"> <Result> <WordList> <Word> <Surface>漢字</Surface> <Furigana>かんじ</Furigana> <Roman>kanzi</Roman> </Word> <Word> <Surface>かな交じり</Surface> <Furigana>かなまじり</Furigana> <Roman>kanamaziri</Roman> <SubWordList> <SubWord> <Surface>かな</Surface> <Furigana>かな</Furigana> <Roman>kana</Roman> </SubWord> <SubWord> <Surface>交</Surface> <Furigana>ま</Furigana> <Roman>ma</Roman> </SubWord> <SubWord> <Surface>じり</Surface> <Furigana>じり</Furigana> <Roman>ziri</Roman> </SubWord> </SubWordList> </Word> <Word> <Surface>文</Surface> <Furigana>ぶん</Furigana> <Roman>bun</Roman> </Word> <Word> <Surface>に</Surface> </Word> <Word> <Surface>ふりがな</Surface> </Word> <Word> <Surface>を</Surface> </Word> <Word> <Surface>振る</Surface> <Furigana>ふる</Furigana> <Roman>huru</Roman> <SubWordList> <SubWord> <Surface>振</Surface> <Furigana>ふ</Furigana> <Roman>hu</Roman> </SubWord> <SubWord> <Surface>る</Surface> <Furigana>る</Furigana> <Roman>ru</Roman> </SubWord> </SubWordList> </Word> <Word> <Surface>こと</Surface> </Word> <Word> <Surface>。</Surface> </Word> </WordList> </Result> </ResultSet>
エラー
ルビ振りはYahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。
利用制限
ルビ振りWeb APIは、24時間以内で1つのアプリケーションIDにつき50000件のリクエストが上限となっています。また、1リクエストの最大サイズを100KBに制限しています。詳しくは「利用制限」をご参照ください。