1. TOP
  2. PRODUCT
  3. Text Summarization API

Text Summarization API

Text Summarization APIは、文章要約を行うAPIです。
入力された文章それぞれの意味を読み取り、特徴的な文章を抽出することができます。

DETAIL

Text Summarization APIでは、文章ごとの意味を分類し特徴的な文章を抽出します。
リクルートには文章要約を行う複数のアルゴリズムが存在しますが、
今回公開するversion1は、Doc2Vecを用いたモデルのみになります。

NOTES

個人情報について:
  他人の名称・メールアドレス・住所・電話番号など個人を特定しうる情報はアップロードしないでください。

推奨ブラウザについて:
  本ページはGoogle Chromeを推奨しています。
  Google Chrome以外のブラウザでは正しく作動しないケースがあります。

REFERENCE

エンドポイント

URL:
https://api.a3rt.recruit-tech.co.jp/text_summarization/v1
メソッド:
POST

リクエストパラメータ

No. パラメータ名 説明 値サンプル 制約 必須
1 apikey APIキーを指定します AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA 半角英数字
2 sentences 要約する文章を入力します センテンス1。センテンス2。センテンス3。 UTF-8
3 linenumber 抽出文章数を指定できます。
未指定の場合はデフォルトで1に設定されます。
1 1以上の整数で、入力した文章数より少ない数。 -
4 separation 文章の切れ目を定義します。デフォルトは”。”です。 UTF-8 -

レスポンスフィールド

No. フィールド名 説明 値サンプル 返却条件 複数
項目
1 status 処理ステータス 0 int 常に返却 -
2 message メッセージ Summarization is completed. string 常に返却 -
3 summary 抽出結果を格納した配列 [ "センテンス1" ] list 常に返却 -

ステータスコード / メッセージ

No. status HTTP status message 返却条件
1 0 200 ok 正常応答
2 1000 400 apikey is null APIキー未指定
3 1001 400 apikey not found APIキーが見つからない
4 1002 400 deleted account 退会済み
5 1003 400 temporary account アカウント未承認
6 1010 400 server not found サーバが見つからない
7 1011 400 server parameter error サーバ設定エラー
8 1030 403 access deny アクセス拒否
9 1400 400 bad request リクエストパラメータが不正
10 1404 400 not found 指定したオブジェクト見つからない
11 1405 405 method not allowed メソッドが正しくない
12 1413 413 request entity too long リクエストパラメータの値が長すぎる
13 1500 500 internal server error API処理で異常が発生しました

制限事項

要約できる1文の最大文字数は200文字、且つ最大文章数は10です。
「&」記号や半角スペースがある場合には、URLエンコードをしてください(curlでは-data-urlencodeを使用) 。
入力する文章に文字の切れ目となるseparationを必ずいれてください。デフォルトのseparationは「。」です。デフォルトの場合は「。」を必ず文章に入れてください。

SAMPLE REQUEST

1)正常時

リクエスト curl -X POST -d 'apikey=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA' --data-urlencode 'sentences=センテンス1。センテンス2。センテンス3。' 'https://api.a3rt.recruit-tech.co.jp/text_summarization/v1/'
レスポンス

{
	"message": "Summarization is completed",
	"status": 0,
	"summary": [
	 	"センテンス1"
	]
}

												

2)異常時

リクエスト curl -X POST -d 'apikey=AAAAAAAAAAAAAA' --data-urlencode 'sentences=センテンス1。センテンス2。センテンス3。センテンス4。センテンス5。センテンス6。センテンス7。センテンス8。センテンス9。センテンス10。センテンス11。' 'https://api.a3rt.recruit-tech.co.jp/text_summarization/v1/'
レスポンス

{
	"message": "Request Entity Too Large",
	"status": 1413
}