校正支援

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

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

リクエストURL

JSON
https://jlp.yahooapis.jp/KouseiService/V2/kousei

リクエストパラメータ(POST)

JSON-RPC 2.0の仕様 に準拠しています。

パラメータ 説明
id(必須) string,integer JSON-RPC 2.0のid。値は任意で、指定した値がレスポンスのidにも返ります。
jsonrpc(必須) string 値は「2.0」としてください。
method(必須) string 値は「jlp.kouseiservice.kousei」としてください。
params object
params/q(必須) string 校正対象のテキストです。

サンプルリクエスト

{
    "id": "1234-1",
    "jsonrpc" : "2.0",
    "method" : "jlp.kouseiservice.kousei",
    "params" : {
      "q" : "セキュリティー,食べれる"
    }
  }

サンプルコード

校正支援を使用したサンプルコードです。

レスポンスフィールド

JSON-RPC 2.0の仕様 に準拠しています。

フィールド 説明
id string,integer リクエストのidの値が返ります。
jsonrpc string 固定で「"2.0"」が返ります。
result object 校正結果のすべてを含みます。
result/suggestions array(object) 校正結果の配列です。
result/suggestions/word string 指摘対象です。
result/suggestions/suggestion string 指摘対象の置換先候補です。空の場合があります。
result/suggestions/note string 指摘の補足情報です。空の場合があります。
result/suggestions/rule string 指摘理由です。指摘理由には以下の種類が存在しています。
1. 表記・表現の間違いや不適切な表現に関する指摘
・誤変換
・誤用
・使用注意
・不快語
・機種依存または拡張文字
・外国地名
・固有名詞
・人名
・ら抜き
2. わかりやすい表記にするための指摘
・当て字
・表外漢字あり
・用字
3. 文章をよりよくするための指摘
・用語言い換え(商標など)
・二重否定
・助詞不足の可能性あり
・冗長表現
・略語
result/suggestions/offset string マッチした部分の始まりの位置。
result/suggestions/length string マッチした部分の長さ。

サンプルレスポンス

以下は、q="セキュリティー,食べれる"のリクエストに対するレスポンスです。

{
  "id": "1234-1",
  "jsonrpc": "2.0",
  "result": {
    "suggestions": [
      {
        "length": "7",
        "note": "語末が-tyだが昨今のネット上の慣習に準ず",
        "offset": "0",
        "rule": "用字",
        "suggestion": "セキュリティ",
        "word": "セキュリティー"
      },
      {
        "length": "4",
        "note": "",
        "offset": "8",
        "rule": "ら抜き",
        "suggestion": "食べられる",
        "word": "食べれる"
      }
    ]
  }
}

エラー

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

また、リクエストパラメータが本ドキュメント記載の仕様と異なる場合、ステータスコード200でJSON-RPC 2.0の仕様に準拠したレスポンスが返ることがあります。

フィールド 説明
id string,integer リクエストのidの値が返ります。
jsonrpc string 固定で「"2.0"」が返ります。
error object
error/code integer JSON-RPC 2.0の仕様に準拠したエラーコードです。
error/message string JSON-RPC 2.0の仕様に準拠したエラーメッセージです。

例1:不正なJSONの場合

リクエスト

{
    "id": "1234-1",
    "jsonrpc" : "2.0",
    "method" : "jlp.kouseiservice.kousei",
    "params" : {
      "q" : "セキュリティー,食べれる"
    }

レスポンス

{
  "id": null,
  "jsonrpc": "2.0",
  "error": {
    "code": -32700,
    "message": "Parse error"
  }
}

例2:必須のパラメータがない場合

リクエスト

{
  "id": "1234-1",
  "jsonrpc" : "2.0",
  "params" : {
    "q" : "セキュリティー,食べれる"
  }
}

レスポンス

{
  "id": "1234-1",
  "jsonrpc": "2.0",
  "error": {
    "code": -32600,
    "message": "Invalid request"
  }
}

例3:存在しないmethodを指定した場合

リクエスト

{
  "id": "1234-1",
  "method": "invalid.method.name",
  "jsonrpc" : "2.0",
  "params" : {
    "q" : "セキュリティー,食べれる"
  }
}

レスポンス

{
  "id": "1234-1",
  "jsonrpc": "2.0",
  "error": {
    "code": -32601,
    "message": "Method not found"
  }
}

利用制限

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

アプリケーションの管理

目次

開発のヒント