1. TOP
  2. PRODUCT
  3. Proofreading API

Proofreading APIはLSTMを利用して文章として怪しい箇所を検知するAPIです。
例えば、"経験や視覚を活かせる職場です"という文章に対して"経験や <<視覚>>を活かせる職場です"という形で不自然な箇所を指摘し、その怪しさ度を返します。また、文章として書き換えた方が良さそうな単語も検知をします。
今回提供するモデルでは求人系の文章を学習データとしているため、是非近いドメインの文章をインプットにして試してみてください。

DETAIL

機械学習を用いて、大量の日本語文章データから正しい文章の構成や文法、単語の流れを学習し、異常検知的に誤字脱字を発見するAPIです。
例えば、"システムの規格から開発・運用まで幅広く関われます。"といった文章をAPIに投げてみてください。助詞の間違いや変換ミスによる間違いを検出してアラートを返してくれます。

NOTES

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

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

DEMO

DEMOの使用には、API KEYが必要になります。


DEMO

VERSION

Proofreading API Version 2

指摘精度が向上しました。また、指摘箇所に対して、修正候補のサジェスト機能を追加しました。


変更点:
・指摘精度が向上しました。
・APIのレスポンスフィールドのフォーマットを変更しました。



Version 1は公開を終了しました。(2018/03/15)

REFERENCE

入力されたテキストで文法的に疑わしい部分を指摘します。
疑わしい部分とは、誤字の可能性が高い部分や、誤字では無いが珍しい使い方、他により良い表現がありそうな部分等を指します。

エンドポイント

URL:
https://api.a3rt.recruit-tech.co.jp/proofreading/v2/typo
メソッド:
GET/POST

リクエストパラメータ

No. パラメータ名 説明 値サンプル 制約 必須
1 apikey APIキーを指定します AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA 半角英数字
2 callback コールバックを指定します jQuery18308453692126555485_1471946187158 レスポンス ContentType は
callback 未指定時:application/json
callback 指定時:applocation/javascript
-
3 sentence チェック対象となる文を入力します システムの規格から開発・運用まD幅広く関われます。 UTF-8
4 sensitivity チェック感度を3段階で指定します。highが誤字の指摘が多く、lowは少なく、mediumはその中間です。 low 半角英字で以下のいずれかを指定。
・low
・medium
・high
※未指定時はmedium
-

レスポンスフィールド

No. フィールド名 説明 値サンプル 返却条件 複数
項目
1 resultID 結果ID 0123abcd string 常に返却 -
2 status 処理ステータス 0 int 常に返却 -
3 message メッセージ ok string 常に返却 -
4 inputSentence リクエストで指定したチェック対象文 システムの規格から開発・運用まD幅広く関われます。 string 常に返却 -
5 normalizedSentence チェックロジック入力用に正規化した文 システムの規格から開発・運用まD幅広く関われます。 string 常に返却 -
6 checkedSentence チェック後の文。指摘箇所を<<>>で示す。 システムの<<規>><<格>>から開発・運用ま<<D>>幅広く関われます。 string 常に返却 -
7 alerts 指定内容を格納した配列 - list 誤字を検出したときに返却 -
pos 指摘箇所。文の先頭からの文字数で表す。0オリジン。 5 int 誤字を検出したときに返却
word 指摘文字 string 誤字を検出したときに返却
score 指摘した単語の疑わしさを示す指標。0〜1の範囲の値をとり、1に近いほど疑わしい事を意味する。 0.8873 int 誤字を検出したときに返却
suggestions 指摘箇所を置き換える候補。より自然な文字から順にlistに格納。 [“企”, “価”, “資”] list 誤字を検出したときに返却

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

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

制限事項

パラメータ長さに関する制限事項

sentenceで送信できる文字列は500文字までです。

ブラウザによるファイルのアップロードは、今後対応していく予定です。

SAMPLE REQUEST

1)正常時(指摘なし)

リクエスト https://api.a3rt.recruit-tech.co.jp/proofreading/v2/typo?
apikey=AAAAAAAAAAAAAA&
sentence=システムの企画から開発・運用まで幅広く関われます。
レスポンス

{
	"resultID": "874778e99a36",
	"status": 0,
	"message": "ok",
	"inputSentence": "システムの企画から開発・運用まで幅広く関われます。",
	"normalizedSentence": "システムの企画から開発・運用まで幅広く関われます。",
	"checkedSentence": "システムの企画から開発・運用まで幅広く関われます。"
}

												

2)正常時(指摘あり)

リクエスト https://api.a3rt.recruit-tech.co.jp/proofreading/v2/typo?
apikey=AAAAAAAAAAAAAA&
sentence=システムの規格から開発・運用まD幅広く関われます。
レスポンス

{
	"resultID": "874778e99a36",
	"status": 1,
	"message": "pointed out",
	"inputSentence": "システムの規格から開発・運用まD幅広く関われます。",
	"normalizedSentence": "システムの規格から開発・運用まD幅広く関われます。",
	"checkedSentence": "システムの <<規>> <<格>> から開発・運用ま <> 幅広く関われます。",
	"alerts":[
		{"pos": 5, "word": "規", "score": 0.9985831706768766, "suggestions":["企", "価", "資"]},
		{"pos": 6, "word": "格", "score": 0.9988025347553782, "suggestions":["画", "定", "模"]},
		{"pos": 15, "word": "D", "score": 1, "suggestions":["で", "が", "と"]}
	]
}

												

3)正常時(callback パラメータ指定)

リクエスト https://api.a3rt.recruit-tech.co.jp/proofreading/v2/typo?apikey=AAAAAAAAAAAAAA&
sentence=システムの規格から開発・運用まで幅広く関われます。&
callback=jQuery18308453692126555485_1471946187158
レスポンス

jQuery18308453692126555485_1471946187158(
	{
		"resultID": "874778e99a36",
		"status": 1,
		"message": "pointed out",
		"inputSentence": "システムの規格から開発・運用まD幅広く関われます。",
		"normalizedSentence": "システムの規格から開発・運用まD幅広く関われます。",
		"checkedSentence": "システムの <<規>> <<格>> から開発・運用ま <> 幅広く関われます。",
		"alerts":[
			{"pos": 5, "word": "規", "score": 0.9985831706768766, "suggestions":["企", "価", "資"]},
			{"pos": 6, "word": "格", "score": 0.9988025347553782, "suggestions":["画", "定", "模"]},
			{"pos": 15, "word": "D", "score": 1, "suggestions":["で", "が", "と"]}
		]
	}
);

												

4)異常時(callback パラメータ未指定)

リクエスト https://api.a3rt.recruit-tech.co.jp/proofreading/v2/typo?apikey=AAAAAAAAAAAAAA
レスポンス

{
	status: 1400,
	message: "bad request",
}

												

5)異常時(callback パラメータ指定)

リクエスト https://api.a3rt.recruit-tech.co.jp/proofreading/v2/typo?apikey=AAAAAAAAAAAAAA&
callback=jQuery18308453692126555485_1471946187158
レスポンス

jQuery18308453692126555485_1471946187158({
	status: 1400,
	message: "bad request",
});