キーフレーズ抽出

日本語文を解析し、特徴的な表現(キーフレーズ)を抽出します。

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

リクエストURL

JSON
https://jlp.yahooapis.jp/KeyphraseService/V2/extract

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

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

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

サンプルリクエスト

{
  "id": "1234-1",
  "jsonrpc" : "2.0",
  "method" : "jlp.keyphraseservice.extract",
  "params" : {
    "q" : "東京ミッドタウンから国立新美術館まで歩いて5分で着きます。"
  }
}

サンプルコード

キーフレーズ抽出を使用したサンプルコードです。

レスポンスフィールド

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

フィールド 説明
id string,integer リクエストのidの値が返ります。
jsonrpc string 固定で「"2.0"」が返ります。
result object キーフレーズ抽出結果のすべてを含みます。
result/phrases(注1) array(object) キーフレーズ抽出結果の配列です。
result/phrases/score(注2) integer キーフレーズの重要度です。
result/phrases/text string キーフレーズです。

(注1)result/phrases (キーフレーズ抽出結果の配列) は、最大20です。
(注2)result/phrases/scoreは、キーフレーズの重要度を示す目安の数値です。最大値を100とし、以下相対的な重要度に応じて 100以下の値が割り当てられます。

サンプルレスポンス

以下は、q="東京ミッドタウンから国立新美術館まで歩いて5分で着きます。"のリクエストに対するレスポンスです。

{
  "id": "1234-1",
  "jsonrpc": "2.0",
  "result": {
    "phrases": [
      {
        "score": 100,
        "text": "東京ミッドタウン"
      },
      {
        "score": 73,
        "text": "国立新美術館"
      },
      {
        "score": 37,
        "text": "5分"
      }
    ]
  }
}

エラー

キーフレーズ抽出は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.keyphraseservice.extract",
    "params" : {
      "q" : "東京ミッドタウンから国立新美術館まで歩いて5分で着きます。"
    }

レスポンス

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

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

リクエスト

{
  "id": "1234-1",
  "jsonrpc" : "2.0",
  "params" : {
    "q" : "東京ミッドタウンから国立新美術館まで歩いて5分で着きます。"
  }
}

レスポンス

{
  "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" : "東京ミッドタウンから国立新美術館まで歩いて5分で着きます。"
  }
}

レスポンス

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

利用制限

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

アプリケーションの管理

目次

開発のヒント