Один текст на входе, один результат
REST-контракт требует одно текстовое поле. Поэтому проверку легко добавить в существующий процесс подачи или редактирования материалов.
REST API / анализ плагиата
API проверки на плагиат для проверки с учетом источника
Добавьте поиск совпадений в образовательный, редакционный или издательский продукт, не отправляя проверяющих в отдельный сервис. Передайте текст со своего сервера и покажите результат в привычном рабочем процессе.
Используйте ключ из среды частного сервера.
cURL запрос
curl --request POST \
--url https://api.detecting-ai.com/api/plagiarism/ \
--header "Content-Type: application/json" \
--header "Idempotency-Key: plagiarism-review-001" \
--header "X-API-Key: YOUR_API_KEY" \
--data '{
"text": "Paste the text you want to check."
}'01
POST-запросы к /api/plagiarism/
02
X-API-Key аутентификация
03
Idempotency-Key от клиента для безопасных повторных попыток
04
Одно обязательное текстовое поле
05
Отдельный лимит слов для функции
Не теряйте контекст источника
Оценка сходства полезна, когда понятно, чем оно вызвано
API возвращает результат поиска совпадений и данные об использовании. Показывайте его вместе с отправленным отрывком, доступным контекстом источника и правилами, которыми руководствуется проверяющий.
Запросы только с сервера
Храните ключ клиента вне браузера и возвращайте только те данные отчета, которые ваше приложение готово объяснить.
Сначала проверка, затем решение
Рассматривайте совпадение как повод для проверки источников. Цитирование, разрешение и политика по-прежнему определяют, что означает совпадение.
Контракт запроса
У тела запроса одна задача
Отправьте полный текст, который вы хотите проверить, в виде строки JSON. Выполняйте анализ документов, контроль доступа и любые метаданные отправки в своем собственном приложении.
| Поле | Тип | Обязательно | Что он делает |
|---|---|---|---|
| text | string | Да | Текст, который необходимо проанализировать службе плагиата. |
Изучите ответ до разработки пользовательского интерфейса
Поле результата содержит анализ, а words_processed показывает расход. Сохраняйте исходный ответ в закрытом журнале тестирования, пока обработчик не научится корректно работать и с обычными, и с пустыми результатами.
Пример ответа
{
"result": "Plagiarism analysis is returned here",
"words_processed": 8
}Процесс интеграции
Начните с небольшого, отслеживаемого цикла проверки.
Понятная интеграция сохраняет связь между отправленным текстом, анализом и действиями проверяющего.
- 1
Выполните закрытый серверный запрос
Храните API-ключ в секрете и принимайте текст только от пользователей и систем, уже авторизованных вашим приложением.
- 2
Предоставьте реалистичные документы
Сохраните уникальный Idempotency-Key, а затем проверьте реалистичные эссе, статьи, списки, материалы с цитатами и без них. Повторно используйте ключ только при точном повторе запроса.
- 3
Создайте состояние проверки
Покажите достаточно данных об источнике и контексте отрывка, чтобы человек мог понять совпадение, прежде чем отметить его, отклонить или передать на дополнительную проверку.
Подходящие применения
Создан для очередей, где оригинальность уже имеет значение.
Результат API должен оставаться связанным с документом и его историей. Так проще разобраться в совпадении и не превратить процент в окончательное решение.
Совпадение требует контекста
Цитируемый текст, ссылки, стандартные фразы и лицензионные материалы могут дублировать друг друга. Прежде чем предпринимать какие-либо действия, просмотрите, что совпало и почему.
Проверка задания
Поместите результат плагиата на тот же экран, что и отправку, сведения о цитировании, рубрику и примечания преподавателя.
Редакция
Проверьте предоставленную работу перед публикацией и отправьте значимое совпадение редактору для проверки источника.
Содержание каталога
Просмотрите повторяющиеся описания продуктов или торговых площадок, прежде чем добавлять их в большой каталог.
Внутренние проверки качества
Пропускайте авторизованный текст через частный сервер и храните ключ отдельно от интерфейса браузера.
Вопросы об API
Практические ответы перед запуском
Начните с запроса на стороне сервера, запишите форму ответа, а затем добавьте результат в существующий поток проверки.
Какой эндпоинт использует API проверки на плагиат?+
Отправьте POST-запрос на https://api.detecting-ai.com/api/plagiarism/. В теле JSON требуется поле text. Передайте X-API-Key и сохраняйте стабильный Idempotency-Key, чтобы безопасно повторять запрос.
Что включает в себя успешный ответ?+
Ответ содержит результат плагиата и words_processed. Проверьте результат в тестовой среде, прежде чем отображать его в интерфейсе собственного отчета.
Означает ли совпадение автоматически плагиат?+
Нет. Совпавший текст может быть цитатой, лицензированным материалом, общепринятой формулировкой или частью списка литературы. В рабочем процессе должна оставаться возможность проверить источник и контекст.
Можно ли отправлять API-ключ из браузера?+
Нет. Храните ключ в доверенной серверной среде и вызывайте оттуда эндпоинт проверки на плагиат. Браузерный пакет или общедоступный репозиторий не защитят личный ключ.
Как учитывается использование плагиата?+
Расход зависит от количества входных слов и списывается из лимита проверки на плагиат в подписке API. Успешный ответ содержит words_processed.
Создайте первый запрос
Проверьте API на образцах с цитатами и без них
В тестовый набор стоит включить оригинальный текст, распространённые фразы, цитаты и заведомо скопированный отрывок. Это поможет команде правильно спроектировать состояния проверки.