メインコンテンツまでスキップ

ShodoのAI校正APIを使ってみよう

ShodoではAI校正APIを使って、日本語の文章を校正できます。 Shodo Python CLI（以下、Shodo CLI）を提供しており、簡単にAI校正APIを使用できます。

備考

APIを使用するためには、Shodoのアカウントが必要です。
アカウントを作成しようを参照してください。

Shodo CLIのインストール​

Shodo CLIは、Pythonのパッケージとして提供されています。

pip install shodo

上記コマンドの実行によって、 shodo コマンドがインストールされ実行可能になります。

詳細なShodo CLIの使用方法はShodo CLIリファレンスを参照してください。

Shodo CLIのログイン​

アカウントを作成しようで作成したAPIトークンを使用して、Shodo CLIにログインします。

shodo login

ログイン時にAPIルートとAPIトークンを入力するプロンプトが表示されるので、それぞれを入力してください。
以下は入力のサンプルとなります。お客様の環境に合わせた値を入力してください。

APIルート：https://api.shodo.ink/@{organization}/{project}/
APIトークン：

APIトークンは入力しても表示されません。コピー&ペーストで入力していただくことを推奨いたします。

Shodo CLIでAI校正を実行する​

Shodo CLIは lint コマンドを提供しており、ファイルを指定することでAI校正を実行できます。

README.md
# Shodo AI校正

飛行機の欠便があり、運行状況が変わった。
バスの運行状況は変わりません。

これが私で自己紹介です。

こんにちは。なんでも相談ください。
こちらをご確認してください。こちらで拝見いたします。

はい。タイポを見つけるのも得意です。
なんでも問題を解決しいます。
日本語ののよくある問題はあ得意です。

Youtubeに動画を投稿しました。Githubで開発しました。

こちらで会計してください。
すぐに食べれる。
shodo lint README.md

README.md というファイルを用意し、コマンドを実行した結果が以下のように表示されます。

Linting...
1:3 表記ゆれがあります
     Shodo AI校正（→ Shodo：AI校正）  飛行機の欠便があ
3:11 もしかして：変換ミス
     飛行機の欠便があり、運行（→ 運航）状況が変わった。 バ
6:5 もしかして：タイプミス
     ません。  これが私で（→ での）自己紹介です。  こ
8:9 もしかして：タイプミス
       こんにちは。なんでも（→ でもご）相談ください。 こち
8:11 「ご」や「して」を付けると日本語として正しくなります
     こんにちは。なんでも相談（→ 相談して）ください。 こちらを
9:5 謙譲語になっています。「ご」か「して」を取ってください
     ください。 こちらをご（→ トル）確認してください。こ
9:8 謙譲語になっています。「ご」か「して」を取ってください
     い。 こちらをご確認して（→ トル）ください。こちらで拝
9:21 謙譲語には「いたす」でなく「する」を使います
     ださい。こちらで拝見いたし（→ し）ます。  はい。タイ
12:10 もしかして：タイプミス
      なんでも問題を解決し（→ して）います。 日本語のの
13:5 もしかして：タイプミス
     しいます。 日本語のの（→ トル）よくある問題はあ得意
13:13 もしかして：タイプミス
     語ののよくある問題はあ（→ トル）得意です。  You
15:1 IT用語の表記
     題はあ得意です。  Youtube（→ YouTube）に動画を投稿しました
15:19 IT用語の表記
     動画を投稿しました。Github（→ GitHub）で開発しました。
18:4 ら抜き言葉です
     てください。 すぐに食べれる（→ 食べられる）。

入力するテキストは上記のようにテキストファイルの他にHTMLファイルが対応しています。出力方法は上記の方式の他にJSON形式にも対応しています。 詳しくは shodo lint リファレンスを参照してください。