وثائق API للتدقيق النحوي والإملائي

تتيح لك TextGears API دمج أحدث التقنيات لتحليل النص تقريبًا في أي منتج. بدءًا من تطبيقات الأجهزة المحمولة البسيطة وحتى عمليات تطوير المؤسسات الضخمة. تتيح لك واجهة برمجة التطبيقات فحص النص بحثًا عن جميع أنواع الأخطاء بطريقة مرنة ، وتحديد قابلية قراءة النص ، وتقييم المفردات التقريبية للمؤلف ، وغير ذلك الكثير.

هل تبحث عن مكون إضافي لموقع الويب؟

يمكنك بسهولة إضافة فحص النص إلى موقع الويب الخاص بك. يمكن العثور على مزيد من المعلومات حول المكوّن الإضافي ونموذج التعليمات البرمجية على صفحة الوثائق.

مستندات لpostman

يمكنك تنزيل ملف توثيق API لـ Postman أو أي برنامج تصحيح أخطاء HTTP آخر. في Postman ، يمكنك تعيين مفتاح في علامة تبويب متغيرات المجموعة..

Download TextGears.postman.json

من أين نبدأ

الأمر بسيط وسهل. واجهة برمجة التطبيقات متاحة لطلبات 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

جميع نقاط نهاية واجهة برمجة التطبيقات عبارة عن مجموعات مستقلة من الخوادم. نحن نضمن إمكانية الخدمة بنسبة 99.9٪ لكل منها إذا كان هذا يبدو غير كافٍ بالنسبة لك ، فيمكنك تغيير الكتلة عند حدوث خطأ في الاتصال.

Javascript

                                                    
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

إذا كنت قد نفذت مكتبة للعمل مع واجهة برمجة التطبيقات بلغة أخرى لإطار عمل آخر ، فقط أرسل لنا رابطًا على GitHub أو GitLab ، بينما سننشرها أيضًا.

اللغات المعتمدة

يحلل TextGears النص ليس فقط من خلال أخذ لغة النص في الاعتبار ، ولكن أيضًا مع مراعاة اللهجة. القائمة الكاملة للغات المدعومة: الإنجليزية والفرنسية والألمانية والبرتغالية والإيطالية والإسبانية والعربية والروسية واليابانية والصينية واليونانية

اللهجات المدعومة (يجب إرسالها في معلمة language): en-US, en-GB, en-ZA, en-AU, en-NZ, fr-FR, de-DE, de-AT, de-CH, pt-PT, pt-BR, it-IT, ar-AR, ru-RU, es-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		غير مطلوب. معرف القاموس المخصص. القاموس عبارة عن مجموعة من القواعد المخصصة. إنشاء القواميس وتحريرها.
ai		`true`, `false`, `1`, `0`. استخدم TextGears AI لتحسين جودة تحليل النص.
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		غير مطلوب. معرف القاموس المخصص. القاموس عبارة عن مجموعة من القواعد المخصصة. إنشاء القواميس وتحريرها.
ai		`true`, `false`, `1`, `0`. استخدم TextGears AI لتحسين جودة تحليل النص.
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/correct

هناك طريقتان للتصحيح التلقائي للنص. طريقة "correct" أكثر دقة بشكل ملحوظ ، لكنها تنطبق على طلبات الذكاء الاصطناعي.

مهم!

في الوقت الحالي ، تعمل الطريقة فقط مع اللغة الإنجليزية.

معلمات الطلب

معامل	مثال	الوصف
text		نص بترميز UTF-8. نوصي بإرسال نص خالص بدون علامات HTML وأحرف UTF-8 غير صالحة. الحد الأقصى للطول محدد بمعلمات خطة الفواتير الخاصة بك.
language		رمز اللغة. إنها معلمة اختيارية ، والقيمة الافتراضية هي `en-US`. قائمة الرموز المدعومة
key		مفتاح API الخاص بك. أليس لديك مفتاح؟ احصل عليه بنقرة واحدة!.

مثال طلب

https://api.textgears.com/correct?text=What+are+you+name%3F&language=en-GB&key=DEMO_KEY

ارسل طلب سيتم عرض النتيجة أدناه

استجابة الخادم

                                            
{
    status : true,  // false in case of checking error
    response : {
        corrected : "What is your name?"  // corrected text
    }
}

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 نقطة ، ويقيم أيضًا الحالة المزاجية العاطفية للنص.

مهم!

معلمات الطلب

معامل	الوصف
text	نص بترميز UTF-8. نوصي بإرسال نص خالص بدون علامات HTML وأحرف UTF-8 غير صالحة. الحد الأقصى للطول محدد بمعلمات خطة الفواتير الخاصة بك.
language	رمز اللغة. إنها معلمة اختيارية ، والقيمة الافتراضية هي `en-US`. قائمة الرموز المدعومة
whitelist	غير مطلوب. مجموعة من الكلمات والعبارات التي يجب عدم اكتشافها كأخطاء.
dictionary_id	غير مطلوب. معرف القاموس المخصص. القاموس عبارة عن مجموعة من القواعد المخصصة. إنشاء القواميس وتحريرها.
ai		`true`, `false`, `1`, `0`. استخدم TextGears AI لتحسين جودة تحليل النص.
key	مفتاح API الخاص بك. أليس لديك مفتاح؟ احصل عليه بنقرة واحدة!.

مثال طلب

https://api.textgears.com/analyze?key=DEMO_KEY&text=...

استجابة الخادم

                                            
{
    status : true, // false in case of checking error
    response : {
        grammar: {
            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

الحصول على إحصائيات استخدام واجهة برمجة التطبيقات لحسابك مع تصنيف حسب اليوم

معلمات الطلب

معامل	مثال	الوصف
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	معرف القاموس المخصص. نعم ، قمت بتعيين معرف بنفسك. يمكن لحسابين مختلفين إنشاء قواميس بنفس المعرفات ، يمكن أن يكون رقمًا أو سلسلة أو حتى `null`. يحتوي القاموس الافتراضي على `id === null`. سيتم ملؤها بالاستثناءات التي تم إنشاؤها بدون معلمة `Dictionary_id`.
title	عنوان القاموس. أقصى طول: 500 حرف.
key	مفتاح API الخاص بك. أليس لديك مفتاح؟ احصل عليه بنقرة واحدة!.

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

معامل	الوصف
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	معرف القاموس. يمكن أن يكون أي سلسلة تصل إلى 64 حرفًا أو null
key	مفتاح API الخاص بك. أليس لديك مفتاح؟ احصل عليه بنقرة واحدة!.

أضف استثناء

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

إذا كنت تتحقق من نصوص بمفردات محددة جدًا تم تمييزها على أنها أخطاء في نظامك ، فيمكنك إضافة كلمات أو عبارات إلى الاستثناءات. بعد ذلك ، لن يتم اعتبارهم أخطاء.

معلمات الطلب

معامل	الوصف
text	كلمة أو نص ليتم تمييزها بطريقة مخصصة أخرى. الحد الأقصى للطول 500 حرف.
type	نوع الاستثناء. القيم الممكنة: 2 – `نص` خطأ, 1 – `النص` ليس خطأ.
lang	رمز اللغة. سيتم تطبيق الاستثناء فقط على النص بهذه اللغة.
description	غير مطلوب. وصف الاستثناء المخصص.
dictionary_id	المعلمة غير مطلوبة. معرف القاموس المخصص (مجموعة من الاستثناءات). يمكن أن يصل طول السلسلة إلى 64 حرفًا أو `NULL`. يمكنك تعيين معلمة `Dictionary_id` أثناء إرسال `تحليل` أو `طلب تحقق` واختيار قاموس ليتم تطبيقه.
suggestions	غير مطلوب. اقتراحات تصحيح النص. مصفوفة سلسلة أو سلسلة من القيم المفصولة بفواصل. الحد الأقصى للعدد: 16. يتم تجاهل المعلمة إذا كان `type=2`.
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: "2024-04-26T13:55:40+0000",
        suggestions: [],
        update_time: null,
        description: null,
    },
}

قائمة الاستثناءات

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

قائمة كلمات الاستبعاد المضافة سابقا

معلمات الطلب

معامل	الوصف
limit	الحد الأقصى لعدد السجلات في النتيجة. لا يزيد عن 500..
offset	كم عدد السجلات المرتبة حسب النص التي تم تخطيها في الإخراج. تستخدم للإخراج المقسم إلى صفحات..
dictionary_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: "2024-04-26T13:55:40+0000",
                update_time: null,
                description: null,
            },
        ],
    },
}

إزالة الاستثناء

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

قم بإزالة كلمة الاستثناء للتدقيق. إذا حاولت حذف كلمة تم حذفها مسبقًا ، فلن يحدث خطأ.

معلمات الطلب

معامل	الوصف
id	معرّف الاستثناء المطلوب إزالته..
dictionary_id	معرف القاموس. يمكن أن يكون أي سلسلة تصل إلى 64 حرفًا أو null.
key	مفتاح API الخاص بك. أليس لديك مفتاح؟ احصل عليه بنقرة واحدة!.

مثال طلب

https://api.textgears.com/custom/deleteexception?id=20&key=DEMO_KEY

استجابة الخادم

                                            
{
    status : true,
    response : {}
}

كيف تستخدم

التحقق من صحة النص API

Admin API

أخرى

وثائق API للتدقيق النحوي والإملائي

هل تبحث عن مكون إضافي لموقع الويب؟

ماذا يمكن أن تفعل API؟

مستندات لpostman

من أين نبدأ

اللغات المعتمدة

إذن وخاصية النقل

رموز الخطأ

التحقق من صحة النص API

التحقق من القواعد النحوية للنص

معلمات الطلب

مثال طلب

استجابة الخادم

التدقيق الإملائي للنص

معلمات الطلب

مثال طلب

استجابة الخادم

نص التصحيح التلقائي

مهم!

معلمات الطلب

مثال طلب

استجابة الخادم

مهم!

معلمات الطلب

مثال طلب

استجابة الخادم

سهولة قراءة النص

مهم!

معلمات الطلب

مثال طلب

استجابة الخادم

تحليل النص

مهم!

معلمات الطلب

مثال طلب

استجابة الخادم

كشف اللغة

معلمات الطلب

مثال طلب

استجابة الخادم

التلخيص واستخراج الكلمات المفتاحية

معلمات الطلب

مثال طلب

استجابة الخادم

Admin API

حصة الخطة

معلمات الطلب

مثال طلب

استجابة الخادم

إحصائيات الاستخدام

معلمات الطلب

مثال طلب

استجابة الخادم

إنشاء القواميس وتحريرها

معلمات الطلب

أضف استثناء

معلمات الطلب

مثال طلب

استجابة الخادم

قائمة الاستثناءات

معلمات الطلب

مثال طلب

استجابة الخادم

إزالة الاستثناء

معلمات الطلب

مثال طلب

استجابة الخادم