校正支援（V1）

日本語文の校正作業を支援します。文字の入力ミスや言葉の誤用がないか、わかりにくい表記や不適切な表現が使われていないかなどをチェックします。

こちらは旧バージョン（V1）のAPIです。
新バージョン（V2）に関してはこちらをご覧ください。

V1終了予定時期に関してはこちらをご覧ください。

リクエストURL

XML

https://jlp.yahooapis.jp/KouseiService/V1/kousei

リクエストパラメータ

パラメータ	値	説明
appid（必須）	string	アプリケーションID。詳細はこちらをご覧ください。
sentence（必須）	string	校正対象のテキストです。
filter_group	string	指摘グループの番号をコンマで区切って指定します。 1: 表記・表現の間違いや不適切な表現に関する指摘　－誤変換、誤用、使用注意語、不快語（使用不適切な語や隠語など）、　機種依存文字または拡張文字、外国地名、固有名詞、人名、ら抜き言　葉が指摘されます。 2: わかりやすい表記にするための指摘　－当て字、表外漢字、用字（※）が指摘されます。　 ※文化庁の基準などを主な参考としています。 3: 文章をよりよくするための指摘　－用語言い換え、二重否定、助詞不足の可能性あり、冗長表現、　略語が指摘されます。無指定の場合は、すべての指摘を返します。
no_filter	string	filter_groupで指定した指摘グループから除外する指摘を指定します。指摘番号をコンマで区切って指定します。 1: 誤変換　　例：人事異同→人事異動 2: 誤用　　例：煙に巻く→けむに巻く 3: 使用注意　　例：外人墓地→外国人墓地 4: 不快語　　例：がんをつける→にらむ 5: 機種依存または拡張文字（EUC表示不可の場合も指摘されます）　例：○付き数字、一部の旧字体など 6: 外国地名　　例：モルジブ→モルディブ 7: 固有名詞　　例：ヤフーブログ→Yahoo!ブログ 8: 人名　　例：ベートーヴェン→ベートーベン 9: ら抜き　　例：食べれる→食べられる 10: 当て字　　例：出鱈目、振り仮名 11: 表外漢字あり　　例：灯籠→灯● 12: 用字　　例：曖昧→あいまい 13: 用語言い換え（商標など）　　例：セロテープ→セロハンテープ 14: 二重否定　　例：聞かなくはない 15: 助詞不足の可能性あり　　例：学校行く 16: 冗長表現　　例：ことができます 17: 略語　　例：ADSL→非対称デジタル加入者線(ADSL)

サンプルリクエストURL

https://jlp.yahooapis.jp/KouseiService/V1/kousei?appid=<あなたのアプリケーションID>&sentence=%e9%81%99%e3%81%8b%e5%bd%bc%e6%96%b9%e3%81%ab%e5%b0%8f%e5%bd%a2%e9%a3%9b%e8%a1%8c%e6%a9%9f%e3%81%8c%e8%a6%8b%e3%81%88%e3%82%8b

レスポンスフィールド

校正支援のスキーマの記述は、以下のURLをご覧ください。
https://jlp.yahooapis.jp/KouseiService/V1/kousei.xsd

フィールド	説明
ResultSet	校正結果のすべてを含みます。
Result	指摘を返します。
StartPos	対象文字列開始位置（先頭からの文字数）。
Length	対象文字列長（対象文字数）。
Surface	対象表記。
ShitekiWord	言い換え候補文字列。複数の候補が返される際には、間に読点がはさまれます。
ShitekiInfo	指摘の詳細情報。リクエストパラメータ no_filterの説明で挙げた指摘内容のうち、どれか1つを表示します。

サンプルレスポンス

以下は、sentence=遙か彼方に小形飛行機が見える。のリクエストに対するレスポンスです。

<?xml version="1.0" encoding="UTF-8" ?>
  <ResultSet xmlns="urn:yahoo:jp:jlp:KouseiService" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="urn:yahoo:jp:jlp:KouseiService https://jlp.yahooapis.jp/KouseiService/V1/kousei.xsd">
    <Result>
    　<StartPos>0</StartPos>
      <Length>2</Length>
      <Surface>遙か</Surface>
      <ShitekiWord>●か</ShitekiWord>
      <ShitekiInfo>表外漢字あり</ShitekiInfo>
    </Result>
    <Result>
      <StartPos>2</StartPos>
      <Length>2</Length>
      <Surface>彼方</Surface>
      <ShitekiWord>彼方（かなた）、かなた</ShitekiWord>
      <ShitekiInfo>用字</ShitekiInfo>
    </Result>
    <Result>
      <StartPos>5</StartPos>
      <Length>5</Length>
      <Surface>小形飛行機</Surface>
      <ShitekiWord>小型飛行機</ShitekiWord>
      <ShitekiInfo>誤変換</ShitekiInfo>
    </Result>
  </ResultSet>

エラー

校正支援はYahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。

利用制限

校正支援Web APIは、24時間以内で1つのアプリケーションIDにつき50000件のリクエストが上限となっています。また、1リクエストの最大サイズを100KBに制限しています。詳しくは「利用制限」をご参照ください。