1. TOP
  2. PRODUCT
  3. Proofreading API

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

DETAIL

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

NOTES

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

REFERENCE

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

エンドポイント

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

リクエストパラメータ

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

レスポンスフィールド

No. フィールド名 説明 値サンプル 返却条件 複数項目
1 status 処理ステータス 0 int 常に返却 -
2 message メッセージ ok string 常に返却 -
3 alerts 指定内容を格納した配列 - list 指摘箇所を検出した時に返却 -
checkedSentence 指摘箇所を<<>>で示した文 システムの<<規格>>から開発・運用まで幅広く関われます。 string 指摘箇所を検出した時に返却
alertCode 指摘の種類を表すコード
※ alertCode/alertDetail 対応表を参照
2 int 誤字を検出したときに返却
alertDetail 指摘の詳細を表す文字列
※ alertCode/alertDetail 対応表を参照
typographical error string 誤字を検出したときに返却
word 指摘単語 企画 string 指摘箇所を検出した時に返却
rankingScore 指摘した単語の疑わしさを示す指標です。0〜1の範囲の値をとり、1に近いほど疑わしい事を意味します。算出方法は以下です。
※算出方法=その単語の出現頻度の順位/全単語数
0.2 float 指摘箇所を検出した時に返却

alertCode/alertDetail 対応表

No. alertCode alertDetail 説明
1 0 a little unnatural やや疑わしい単語です。もっと良い表現がある可能性があります。
2 1 unnatural 疑わしい単語です。あまり使われない表現であったり、珍しい単語である可能性があります。
3 2 typographical error かなり疑わしい単語です。誤字の可能性が高いです。

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

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 1404 404 not found 指定したオブジェクト見つからない
12 1405 405 method not allowed メソッドが正しくない
13 1413 413 request entity too long リクエストパラメータの値が長すぎる
14 1500 500 internal server error サーバ処理中に想定外のエラーが発生

制限事項

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

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

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

SAMPLE REQUEST

1)正常時(指摘なし)

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

{
	"status":0,
	"message":"ok",
}

												

2)正常時(指摘あり)

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

{
	"status":1,
	"message":"pointed out.",
	"alerts":[
		{"checkedSentence": "システムの<<規格>>から開発・運用まで幅広く関われます。",
		"alertCode":2,
		"alertDetail":"typographical error",
		"word":"規格",
		"rankingScore":0.8},
	]
}

												

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

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

jQuery18308453692126555485_1471946187158(
	{
		"status":1,
		"message":"pointed out.",
		"alerts":[
			{"checkedSentence": "システムの<<規格>>から開発・運用まで幅広く関われます。",
			"alertCode":2,
			"alertDetail":"typographical error",
			"word":"規格",
			"rankingScore":0.8},
		]
	}
)

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

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

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

												

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

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

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