ライティングラボ by Shodo

執筆・ライティングについてのノウハウを共有するブログです。 ブログや本の執筆、コンテンツマーケティングにお役立てください!

Shodoの校正APIがHTML形式の入力に対応しました

Shodoの校正APIがHTMLの本文入力に対応しました!

これでお客様のHTMLファイル、Webサイトやページの文章を校正していただけます。

shodo コマンドを使う場合は --html オプションを指定するだけです。

$ shodo lint mypage.html --html

これだけでShodoはHTML内の日本語文を抜き出してAI校正にかけてくれます。HTMLのテキストに対応したインデックス番号なども返してくれるので便利です。

プログラムから呼びだす場合は is_html オプションを有効にします。

>>> from shodo import lint
>>> lint("<p>これは<strong>テストの文章</strong>えす</p>", is_html=True)

APIを呼びだす際には "type": "html" を指定します。

$ http ... https://api.shodo.ink/... body="<p>これは<strong>テストの文章</strong>えす</p>" type="html"

詳細なAPI仕様はこちらからご確認ください

テキストの校正との違いは?

HTML形式で入力された場合と通常のテキストでは以下のような相違点があります。

  • <h1><li> などのHTML構造を元に見出しや一覧を解釈して校正
  • インラインのHTMLタグを除外して文を校正
  • HTMLのテキスト長ではなく日本語文の長さで文字数をカウント

与えられたHTML内の日本語を校正しますので、記事の校正などに利用する場合は特定の要素(たとえば <article>)以下をお送りください。ルート要素がない場合も動作しますので、本文以下や <contenteditable> 内の要素をそのまま指定できます。

AI校正をより便利に

HTMLのAI校正機能によって、お客様のページやすでに公開済みの記事・リリース文などを一気に校正できるようになりました。

自社のサイトをスクレイピングして校正したいHTML要素を抜き出し shodo.lint(...) を呼びだす、そんなプログラムの実装にぜひお役立てください!

執筆:@hirokiky、レビュー:@nnsnodnb
Shodoで執筆されました