文法とスペルチェックのAPIドキュメント

Textgears APIで、文章分析を行う最新技術を、シンプルなモバイルアプリから大規模な企業開発まで、あらゆる製品に統合することができます。APIを用いることで、あらゆる種類の誤りを柔軟にチェックしたり、文章の読みやすさを判断したり、著者のおおよその語彙力を評価したりすることなどができます。

APIにできることとは?

Postmanのためのドキュメント

Postmanやその他のHTTPデバッグプログラムへのAPIドキュメントファイルをダウンロードすることができます。Postmanでは、コレクションのVariablesタブでキーを設定することができます。.

Download TextGears.postman.json

始め方

シンプルで簡単です。APIは、通常のHTTPおよびHTTPSリクエストに対応しています。出力データはJSONで送信されます。すべてのリクエストは、api.textgears.comサーバーで行われます。

世界各地からのアクセスを高速化するために、米国、エストニア、シンガポールの3ヵ国にサーバーを設置しました。api.textgears.comにリクエストを送信する際には、最も近いクラスタを選択します。しかし、応答の遅れを減らすために、あなたから明示的に近くのクラスターにリクエストすることができます。

https://eu.api.textgears.com – Europe
https://us.api.textgears.com – America
https://sg.api.textgears.com – Asia

すべてのAPIエンドポイントは、独立したサーバーのクラスタです。私たちは、それぞれのサーバーについて、99.9%の保守性を保証しています。もしこれが不十分であると思われる場合は、接続エラーが発生した際にクラスタを変更することができます。

                                                    
import textgears from 'textgears-api';

const textgearsApi = textgears('YOUR_KEY', {language: 'en-US'});
textgearsApi.checkGrammar('I is a engineer')
    .then((data) => {
        for (const error of data.errors) {
            console.log('Error: %s. Suggestions: %s', error.bad, error.better.join(', '));
        }
    })
    .catch((err) => {});
                                                    
                                                

Javascript library

他の言語やフレームワークでAPIを操作するためのライブラリを実装した場合、GitHubやGitLabにリンクを送っていただければ、私たちがそちらも公開します。

対応言語

TextGearsは、文章の言語を考慮するだけでなく、方言も考慮して文章を分析します。対応言語の一覧はこちらです: 英語、フランス語、ドイツ語、ポルトガル語、イタリア語、スペイン語、日本語、中国語、ギリシャ語

対応している方言(languageパラメータで送信する必要があります)。

認証とパラメータの転送

このリクエストは、以下のいずれかの方法で、あなたのキーを他のパラメータと一緒に転送すること承認されます:

  • POST parameter key
  • GET parameter key
    ?key=YOURKEY
  • Json-request
    {
        "key": "YOURKEY",
        // Other params
    }
  • HTTP Header
    Authorization: Basic YOURKEY
    YOURKEYがあなたのキーのところ。

エラーコード

エラーの場合、statusパラメータはfalseの値を持ちます。

{
    status : false,
    error_code : 600,  // API error code
    description : "Invalid license key. Go to https://textgears.com/signup.php to get one"
}
  • 600 - 無効なキー
  • 606 - 対応していない言語
  • 607 - 許可されたリクエスト数を超えました
  • 500 - 不明な内部サービスエラー
  • 501 - 文章の長さがレート上限を超えました

文章検証API

文章の文法をチェック

https://api.textgears.com/grammar

この方法で、文章中に文法、スペル、句読点、文体の誤りがないかをチェックすることができます。

リクエストパラメータ
パラメータ 記述
text UTF-8でエンコードされた文章。HTMLタグや無効なUTF-8文字を含まない純粋な文章を送信することをお勧めします。最大の長さは、あなたの課金プランのパラメータによって制限されます。
language 言語コーす。これは任意のパラメータで、デフォルト値はen-USとなっています。 対応コード一覧
whitelist 必要ありません. 誤りとして検出されるべきではない単語やフレーズの配列.
dictionary_id 必要ありません. カスタム辞書のID。辞書は、カスタムルールのグループです。. 辞書の作成と編集.
key あなたのAPIキーです。キーをお持ちではありませんか? ワンクリックで取得しましょう!.
リクエストの例
https://api.textgears.com/grammar?key=DEMO_KEY&text=I+is+an+engeneer!&language=en-GB

リクエストを送信する 結果は下に表示されます

サーバーレスポンス
                                            
{
    status : true, // false in case of checking error
    response : {
        errors : [  // array of errors info
            0 : {
                id : "e492411846",  // unique error id
                offset : 2,  // error text offset
                length : 2,  // error text length
                bad : "is",  // error text
                better : [  // array of suggestions
                    0 : "am"
                ],
                type : "grammar"
            },
            1 : {
                id : "e627659964",  // unique error id
                offset : 8,  // error text offset
                length : 8,  // error text length
                bad : "engeneer",  // error text
                better : [  // array of suggestions
                    0 : "engineer",
                    1 : "engender"
                ],
                type : "spelling"
            }
        ]
    }
}
                                            
                                        

文章のスペルをチェック

https://api.textgears.com/spelling

この方法は、更新された辞書を使用して文章の誤字をチェックします。

リクエストパラメータ
パラメータ 記述
text UTF-8でエンコードされた文章。HTMLタグや無効なUTF-8文字を含まない純粋な文章を送信することをお勧めします。最大の長さは、あなたの課金プランのパラメータによって制限されます。
language 言語コーす。これは任意のパラメータで、デフォルト値はen-USとなっています。 対応コード一覧
whitelist 必要ありません. 誤りとして検出されるべきではない単語やフレーズの配列.
dictionary_id 必要ありません. カスタム辞書のID。辞書は、カスタムルールのグループです。. 辞書の作成と編集.
key あなたのAPIキーです。キーをお持ちではありませんか? ワンクリックで取得しましょう!.
リクエストの例
https://api.textgears.com/spelling?key=DEMO_KEY&text=I+is+an+engeneer!&language=en-GB

リクエストを送信する 結果は下に表示されます

サーバーレスポンス
                                            
{
    status : true, // false in case of checking error
    response : {
        errors : [  // array of errors info
            0 : {
                id : "e627659964",  // unique error id
                offset : 8,  // error text offset
                length : 8,  // error text length
                bad : "engeneer",  // error text
                description: "Error description",
                better : [  // array of suggestions
                    0 : "engineer",
                    1 : "engender"
                ],
                type : "spelling"
            }
        ]
    }
}
                                            
                                        

文章の自動修正

https://api.textgears.com/suggest

検証システムは、文章中の誤りを自動で修正し、最後の文の続きを提案します。

重要!

誤字が検出されると、その単語は辞書に載っている最も近い単語に置き換えられます。似た単語が複数ある場合は、現代語で最もよく使われる単語が選択されます。TextGearsはまだテレパシーとは程遠いため、誤字が多いと最終的な文章の意味が変わってしまう可能性があります。

リクエストパラメータ
パラメータ 記述
text UTF-8でエンコードされた文章。HTMLタグや無効なUTF-8文字を含まない純粋な文章を送信することをお勧めします。最大の長さは、あなたの課金プランのパラメータによって制限されます。
language 言語コーす。これは任意のパラメータで、デフォルト値はen-USとなっています。 対応コード一覧
key あなたのAPIキーです。キーをお持ちではありませんか? ワンクリックで取得しましょう!.
リクエストの例
https://api.textgears.com/suggest?key=DEMO_KEY&text=I+is+an+engeneer!+My+na

リクエストを送信する 結果は下に表示されます

サーバーレスポンス
                                            
{
    status : true,  // false in case of checking error
    response : {
        corrected : "My name is Seth. My family",  // corrected text
        suggestions : [  // array of suggested text endings
            0 : {
                text : "My name is Seth. My family wishes",
                next_word : "wishes"
            },
            1 : {
                text : "My name is Seth. My family traditions",
                next_word : "traditions"
            },
            2 : {
                text : "My name is Seth. My family together",
                next_word : "together"
            },
            3 : {
                text : "My name is Seth. My family support",
                next_word : "support"
            },
            4 : {
                text : "My name is Seth. My family respectfully",
                next_word : "respectfully"
            }
        ]
    }
}
                                            
                                        

文章の読みやすさ

https://api.textgears.com/readability

最も一般的なアルゴリズムと多くの言語への適応に従って、文章の読みやすさを計算します。読みやすさの指標については、別記事をご覧ください。

重要!

文章の指標を判定する際、精度は文章のサイズに直結します。2語の文章で読みやすさなどを判断しても意味がありません。最低でも30語以上の文章をチェックすることをお勧めします。多ければ多いほど良いです。

リクエストパラメータ
パラメータ 記述
text UTF-8でエンコードされた文章。HTMLタグや無効なUTF-8文字を含まない純粋な文章を送信することをお勧めします。最大の長さは、あなたの課金プランのパラメータによって制限されます。
language 言語コーす。これは任意のパラメータで、デフォルト値はen-USとなっています。 対応コード一覧
key あなたのAPIキーです。キーをお持ちではありませんか? ワンクリックで取得しましょう!.
リクエストの例
text
https://api.textgears.com/readability?key=DEMO_KEY&text=...

リクエストを送信する 結果は下に表示されます

サーバーレスポンス
                                            
{
    status : true,  // false in case of checking error
    response : {
        stats : {
            fleschKincaid : { // Flesch–Kincaid index (https://en.wikipedia.org/wiki/Flesch–Kincaid_readability_tests)
                readingEase : 53.4, // Index value
                grade : "10th to 12th grade", // Flesch–Kincaid grade
                interpretation : "Fairly difficult to read" // index value interpretation
            },
            gunningFog : 12.2, // https://en.wikipedia.org/wiki/Gunning_fog_index
            colemanLiau : 12, // https://en.wikipedia.org/wiki/Coleman–Liau_index
            SMOG : 12, // https://en.wikipedia.org/wiki/SMOG
            vocabularySize : {
                active : null, // How many words author uses every day
                passive : null // How many words author knows
            },
            emotion : { // text emotion classifier
                positive : 0.79,
                negative : 0.21
            },
            counters : {
                length : 1128,
                clearLength : 936,
                words : 187,
                sentences : 10
            }
        }
    }
}
                                            
                                        

文章分析

https://api.textgears.com/analyze

包括的な文章分析。あらゆる種類の誤りを発見し、読みやすさの指標を計算し、スペルを100点満点で評価し、さらに文章の情緒を評価します。

重要!

文章の指標を判定する際、精度は文章のサイズに直結します。2語の文章で読みやすさなどを判断しても意味がありません。最低でも30語以上の文章をチェックすることをお勧めします。多ければ多いほど良いです。

リクエストパラメータ
パラメータ 記述
text UTF-8でエンコードされた文章。HTMLタグや無効なUTF-8文字を含まない純粋な文章を送信することをお勧めします。最大の長さは、あなたの課金プランのパラメータによって制限されます。
language 言語コーす。これは任意のパラメータで、デフォルト値はen-USとなっています。 対応コード一覧
whitelist 必要ありません. 誤りとして検出されるべきではない単語やフレーズの配列.
dictionary_id 必要ありません. カスタム辞書のID。辞書は、カスタムルールのグループです。. 辞書の作成と編集.
key あなたのAPIキーです。キーをお持ちではありませんか? ワンクリックで取得しましょう!.
リクエストの例
https://api.textgears.com/analyze?key=DEMO_KEY&text=...
サーバーレスポンス
                                            
{
    status : true, // false in case of checking error
    response : {
        errors : [  // array of errors info
            0 : {
                id : "e492411846",  // unique error id
                offset : 2,  // error text offset
                length : 2,  // error text length
                description: "Error description",
                bad : "is",  // error text
                better : [  // array of suggestions
                    0 : "am"
                ],
                type : "grammar"
            },
            1 : {
                id : "e627659964",  // unique error id
                offset : 8,  // error text offset
                length : 8,  // error text length
                bad : "engeneer",  // error text
                description: "Error description",
                better : [  // array of suggestions
                    0 : "engineer",
                    1 : "engender"
                ],
                type : "spelling"
            }
        ],
        stats: {
             fleschKincaid : { // Flesch–Kincaid index (https://en.wikipedia.org/wiki/Flesch–Kincaid_readability_tests)
                readingEase: 63.3, // Index value
                grade : "8th or 9th grade", // Flesch–Kincaid grade
                interpretation: "Plain English. Easily understood by 13- to 15-year-old students", // index value interpretation
             }
            gunningFog : 9.4, // https://en.wikipedia.org/wiki/Gunning_fog_index
            colemanLiau : 12, // https://en.wikipedia.org/wiki/Coleman–Liau_index
            SMOG : 6.5, // https://en.wikipedia.org/wiki/SMOG
            vocabularySize : {
                active: 5000, // How many words author uses every day
                passinve: 60000, // How many words author knows
            }
            emotion: { // text emotion classifier
                positive: 0.79, // probability
                negative: 0.21,
            }
        }
    }
}
                                            
                                        

言語検出

https://api.textgears.com/detect

文章の言語を決定し、その方言を想定します。この方法は、各言語の可能性のあるオプションの配列を返します。言語を明確に特定できない場合は、languageフィールドはnullを返します。

リクエストパラメータ
パラメータ 記述
text UTF-8でエンコードされた文章。HTMLタグや無効なUTF-8文字を含まない純粋な文章を送信することをお勧めします。最大の長さは、あなたの課金プランのパラメータによって制限されます。
key あなたのAPIキーです。キーをお持ちではありませんか? ワンクリックで取得しましょう!.
リクエストの例
text
https://api.textgears.com/detect?key=DEMO_KEY&text=...

リクエストを送信する 結果は下に表示されます

サーバーレスポンス
                                            
{
    status : true, // false in case of checking error
    response : {
        language : "en", // null if language was not detected
        dialect : "en-GB", // language dialect suggestion
        probabilities : { // descending
            "en" : 0.95,
            "fr" : 0.61,
            "ge" : 0.60,
            "fi" : 0.51,
        }
    }
}
                                            
                                        

要約とキーワードの抽出

https://api.textgears.com/summarize
リクエストパラメータ
パラメータ 記述
text UTF-8でエンコードされた文章。HTMLタグや無効なUTF-8文字を含まない純粋な文章を送信することをお勧めします。最大の長さは、あなたの課金プランのパラメータによって制限されます。
language 言語コーす。これは任意のパラメータで、デフォルト値はen-USとなっています。 対応コード一覧
max_sentences 任意のパラメータ。要約に含まれる最大文章数
key あなたのAPIキーです。キーをお持ちではありませんか? ワンクリックで取得しましょう!.
リクエストの例
language
text
https://api.textgears.com/summarize?key=DEMO_KEY&language=en-GB&text=...

リクエストを送信する 結果は下に表示されます

サーバーレスポンス
                                            
{
    status : true,  // false in case of checking error
    response : {
        keywords : [
            0 : "text",
            1 : "readability",
            2 : "english",
            3 : "printing",
            4 : "fewer",
            5 : "words",
            6 : "terms",
            7 : "higher",
            8 : "features",
            9 : "indexes"
        ],
        highlight : [ // Most important paragraph, starting with main sentence
            0 : "The two main factors of readability are the printing and linguistic features of the text.",
            1 : "In other words, pages containing simple and clear text get higher positions in the search results."
        ],
        summary : [ // Text summary sentences
            0 : "The two main factors of readability are the printing and linguistic features of the text.",
            1 : "The Flesch Kinkaid Score is the most popular way to measure the readability of English text.",
            2 : "It works on the principle of “the fewer words in the text, and the fewer syllables in them, the easier it is to perceive” and is most often used for checking essays in schools and universities."
        ]
    }
}
                                            
                                        

Admin API

プラン枠

https://api.textgears.com/account/resourcequota

現在のプラン枠のデータを受信する。この方法は、プラン内で何件のリクエストがすでに行われているか、あるいは請求期間内に何件のリクエストが可能かを追跡するために使用することができます。

リクエストパラメータ
パラメータ 記述
key あなたのAPIキーです。キーをお持ちではありませんか? ワンクリックで取得しましょう!.
リクエストの例
https://api.textgears.com/account/resourcequota?key=DEMO_KEY

リクエストを送信する 結果は下に表示されます

サーバーレスポンス
                                            
{
    status : true,
    response : {
        api : { // Resource type, "api" if you use TextGears API
            type : "api", // Resource type
            total : 1000000, // Total resource quota size
            used : 123000, // How many requests was made using this quota
            period_start: "2018-10-20T00:00:00+0000", // Quota paid period start (ISO8601 format)
            period_end: "2019-10-20T00:00:00+0000", // End of the quota paid period (ISO8601 format)
        },
    },
}
                                            
                                        

使用状況の統計

https://api.textgears.com/account/usage

あなたののアカウントのAPI使用量の統計を日別に取得します

リクエストパラメータ
パラメータ 記述
period_start 期間の開始。任意のパラメータ。.
period_end 期間の終了。任意のパラメータ。期間が指定されていない場合は、過去30日分のデータが表示されます.
key あなたのAPIキーです。キーをお持ちではありませんか? ワンクリックで取得しましょう!.
リクエストの例
https://api.textgears.com/account/usage?key=DEMO_KEY

リクエストを送信する 結果は下に表示されます

サーバーレスポンス
                                            
{
    status : true,  // false in case of checking error
    response : [
        0 : {
            date : "2020-04-20",
            request_count : 11875
        },
        1 : {
            date : "2020-04-21",
            request_count : 10588
        }
    ]
}
                                            
                                        

辞書の作成と編集

https://api.textgears.com/custom/createdictionary

文章の誤りのチェックに柔軟な設定が必要な場合は、カスタムの例外設定を使用します。この設定は、特殊な語彙を含む文章を扱う企業にとっては特に便利です。単語やフレーズを「正しい」とマークすることで、システムがそれらを誤りとみなさないようにします。また、特定の単語リストに基づいて、システムが誤りを見つけるようにすることもできます。カスタムルールは、組み合わせて辞書化することができます。このようなアプローチにより、製品のさまざまな機能で異なるルールを使用することが可能になります。同時に、製品のユーザーごとに独自の例外を設定することもできます

リクエストパラメータ
パラメータ 記述
id カスタム辞書のID。はい、あなたのご自身でIDを設定します。数字、文字列、またはnullも可能です。デフォルトの辞書はid === nullです。これは、dictionary_idパラメータなしで作成された例外で満たされます.
title 辞書のタイトル。最大文字数:500文字.
key あなたのAPIキーです。キーをお持ちではありませんか? ワンクリックで取得しましょう!.
https://api.textgears.com/custom/updatedictionary
パラメータ 記述
id 辞書ID。64文字以内の任意の文字列またはnullが使用可能です。.
title 辞書のタイトル。最大文字数:500文字.
key あなたのAPIキーです。キーをお持ちではありませんか? ワンクリックで取得しましょう!.
https://api.textgears.com/custom/listdictionaries
パラメータ 記述
limit 結果に表示される記録の最大数。500件以内。.
offset いくつの記録が無視されるか.
key あなたのAPIキーです。キーをお持ちではありませんか? ワンクリックで取得しましょう!.
https://api.textgears.com/custom/deletedictionary
パラメータ 記述
id 辞書ID。64文字以内の任意の文字列またはnullが使用可能です。
key あなたのAPIキーです。キーをお持ちではありませんか? ワンクリックで取得しましょう!.

例外の追加

https://api.textgears.com/custom/addexception

非常に特殊な語彙を含む文章をチェックしており、システム上で誤りとしてマークされている場合は、単語やフレーズを例外に追加することができます。それ以降、誤りとはみなされません。

リクエストパラメータ
パラメータ 記述
text 別のカスタム方法でマークされる単語または文章。最大文字数は500文字です。.
type 例外タイプ。可能な値は 1 – textは間違いである、2 – textは誤りではない。.
lang 言語コード。例外はこの言語の文章のみに適用されます.
description 必要ありません。カスタムの例外情報.
dictionary_id 必須ではないパラメータです。カスタム辞書(例外のグループ)のID。文字列、長さは最大64文字またはNULLです。適用する辞書を選択するために analyze または check リクエストを送信する際に dictionary_id パラメータを設定することができます。.
key あなたのAPIキーです。キーをお持ちではありませんか? ワンクリックで取得しましょう!.
リクエストの例
https://api.textgears.com/custom/addexception?text=foobaring&type=2&lang=en-US&key=DEMO_KEY
サーバーレスポンス
                                            
{
    status : true,
    response : {
        id: 20, // New exception id
        text: "foobaring",
        type: 1,
        lang: "en-US",
        creation_time: "2021-06-20T13:51:33+0000",
        update_time: null,
        description: null,
    },
}
                                            
                                        

例外のリスト

https://api.textgears.com/custom/listexceptions

過去にリストに追加された除外語

リクエストパラメータ
パラメータ 記述
limit 結果に表示される記録の最大数。500件以内。.
offset 文章によって並べられた記録のうち、何件分をスキップして出力するか。ページ出力に使用されます。.
dictionary_id 必要ありません. 辞書(例外グループ)のID。デフォルトの辞書のすべての例外を取得するには、null値を使用することができます。.
text 必要ありません. 文章フィルター.
type 必要ありません. 例外タイプフィルター.
lang 必要ありません. 言語フィルター.
key あなたのAPIキーです。キーをお持ちではありませんか? ワンクリックで取得しましょう!.
リクエストの例
https://api.textgears.com/custom/addexception?text=foobaring&key=DEMO_KEY
サーバーレスポンス
                                            
{
    status : true,
    response : {
        exceptions : [
            {
                id: 20,
                text: "foobaring",
                type: 1,
                lang: "en-US",
                creation_time: "2021-06-20T13:51:33+0000",
                update_time: null,
                description: null,
            },
        ],
    },
}
                                            
                                        

例外の取り消し

https://api.textgears.com/custom/deleteexception

チェックのための例外ワードを削除します。以前に削除した単語を削除しようとしても、エラーは発生しません。

リクエストパラメータ
パラメータ 記述
id 消去する例外ID。.
dictionary_id 辞書ID。64文字以内の任意の文字列またはnullが使用可能です。.
key あなたのAPIキーです。キーをお持ちではありませんか? ワンクリックで取得しましょう!.
リクエストの例
https://api.textgears.com/custom/deleteexception?id=20&key=DEMO_KEY
サーバーレスポンス
                                            
{
    status : true,
    response : {}
}