ShodoのAI校正APIを一般公開しました

ShodoのAI校正APIを一般公開しました

ShodoのAI校正APIを一般公開しました！
Shodoにユーザーアカウントがあれば、誰でも校正APIをご利用いただけます。

こんな文章のタイポや変換ミスをチェックしてくれます：

• 手元で書いたドキュメント
• Markdownで書いている技術書
• エディターで書いた記事

ShodoのCLIコマンドもオープンソースで公開されています：

$ pip3 install shodo
$ shodo login
$ shodo lint README.md
Linting...
3:11 もしかしてAI
     飛行機の欠便があり、運行（→ 運航）状況が変わった。 バ
6:5 もしかしてAI
     ません。  これが私で（→ の）自己紹介です。  こ
8:11 「ご」や「して」を付けると日本語として正しくなります
     こんにちは。なんでも相談（→ 相談して）ください。 こちらを...

pypi.org

APIの仕様

簡単に言うと、記事をPOSTして、結果をGETするという仕様です。

本文を投稿するリクエスト：

{
  "body": "校正する本文"
}

結果を取得した結果：

{
  "messages": [
    {
      "after": "の",
      "before": "で",
      "from": {
        "ch": 21,
        "line": 669
      },
      "index": 17619,
      "index_to": 17620,
      "message": "もしかしてAI",
      "severity": "warning",
      "to": {
        "ch": 22,
        "line": 669
      }
    }
  ],
  "status": "done",
  "updated": ...
}

詳しくはこちらのAPI仕様をご確認ください。

github.com

認証する方法

プロジェクトの「設計」から「API連携」を開いてください。
APIルートと、APIキーを取得できます。

このAPIキーをAuthorizationヘッダーに指定します。
shodo コマンドの場合は、事前に shodo login からAPIルートとトークンを設定します。

校正の設定はプロジェクトごとに指定されたものを使います。

料金や利用範囲

校正APIは月当たり以下の範囲でご利用いただけます。

• ビジネスプラン：40,000文字×チームの人数
• プレミアムプラン：20,000文字
• ライトプラン：4,000文字

Shodoのアプリを使った執筆の場合、これまでと変わらず文字数に制限はありません。
校正APIのベータ版にお申し込みいただいた方は10月中旬までの間、10万文字を追加でご利用いただけます。

APIのみを利用できるプランも公開されました！

100万文字や1,000万文字という単位でご利用の際や、システム連携をして校正したい場合などにお買い求めください。

shodo.ink

おわりに

Shodoはどんなところにある日本語のストレスもなくしたいと思っています。

Shodo校正APIも今後も機能拡張しますので、ご要望があればお伝えください。
たくさん使っていただければ、その分良くなっていきます。自分の環境や仕事の中で使ってくれると嬉しいです。

執筆：Kiyohara Hiroki (@hirokiky)
（Shodoで執筆されました）