语法和拼写检查API文档

TextGears API允许您将最新的文本分析技术 实际集成到任何产品中。从简单的移动应用 程序到庞大的企业发展。该API允许您以一 种灵活的方式检查文本中的各种错误,确定 文本的可读性,评估作者的近似词汇表,等等。

该API能做些什么?

Postman的文件

您可以为Postman或任何其他HTTP调试程序 下载API文档文件。在Postman中,你可以在 集合变量选项卡上设置一个键。.

Download TextGears.postman.json

从哪里开始

它非常简单。该API可用于常规的HTTP和 HTTPS请求。输出数据以JSON的形式发送。 所有的请求都被发送到api.textgears.com服务器

为了加快来自世界各地的访问,我们在三个 国家:美国、爱沙尼亚和新加坡。当向api.textgeres.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参数 发送): en-US、en-GB、en-ZA、en-ZA、en-AU、en-NZ、FR、DE、AT、CH、PT、bR、it-IT、ES、Ja-JP、zh-CN、el-GR

授权和参数传输

通过以下方式之一传输密钥和其他参数 来授权请求:

  • 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

根据最常见的算法及其自适应算法来计 算文本的可读性

非常重要!

在确定文本指标时,准确性与文本的大小 直接相关。确定两个字句子的文本的可读性 或其他参数是没有意义的。建议检查至少有 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点的尺度评分拼写,并评 估文本的情绪。

非常重要!

在确定文本指标时,准确性与文本的大小 直接相关。确定两个字句子的文本的可读性 或其他参数是没有意义的。建议检查至少有 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

如果您需要一个灵活的设置来检查文本的错误, 请使用自定义异常设置。这对于使用充满特殊 词汇单词的文本的公司特别有用。将单词或 短语标记为\correct",以便系统停止判定它们 的错误。您也可以使用它来允许系统根据特 定单词的列表来查找错误。自定义规则可以 合并并转换为字典。这种方法使产品的不同 功能能够使用不同的规则。同时,您产品 的每个用户都可以有自己的特殊方式。"

请求程序的参数
参数参数 描述
id 自定义词典的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

在确定文本指标时,准确性与文本的大小直接 相关。确定两个字句子的文本的可读性或其他 参数是没有意义的。建议检查至少有30个单词 的文本。效果越多,效果就越好。

请求程序的参数
参数参数 描述
text 要用另一种自定义方式进行标记的单词或文本。最大长度为500个字符.
type 异常类型。可能的值:1&ndashtext是错的,2 – text 没错.
lang 语言代码。例外情况将仅应用于此语言中的 文本.
description 不需要的。自定义异常情况说明.
dictionary_id 非必需的参数。自定义字典(一组例外情况)ID。 字符串,长度最多可以为64个字符或null。您可以在发送analyze 时设置dictionary_id参数,或 check请求以选择要应用的字典.
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-20T12:51:07+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-20T12:51:07+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 : {}
}