Глоссарий
Канонические термины Konergy API: определения, англоязычные эквиваленты и правила употребления.
В документации Konergy API используется единая терминология. При первом упоминании термин приводится на русском с английским эквивалентом в скобках, далее используется каноническая форма из таблицы ниже.
Термины
| Термин (RU) | Term (EN) | Определение |
|---|---|---|
| API-ключ | API key | Токен аутентификации в формате sk_konergy_{publicId}_{secret}, используемый для доступа к API |
| Лимит запросов | Rate limit | Ограничение на количество запросов к API в единицу времени |
| Квота | Quota | Допустимый объём использования API за биллинговый период |
| Вебхук | Webhook | HTTP-callback, отправляемый сервером при наступлении события (например, завершение задачи) |
| Полезная нагрузка | Payload | Тело HTTP-запроса или ответа, содержащее передаваемые данные |
| Ключ идемпотентности | Idempotency key | Уникальный идентификатор (UUIDv4), передаваемый в заголовке idempotency-key для предотвращения повторной обработки мутаций |
| Лимит расходов | Spend limit | Максимальная сумма, которую можно потратить за биллинговый период; при достижении запросы блокируются |
| Предоплатный кошелёк | Prepaid wallet | Баланс предоплаченных средств организации, списываемый при каждом API-вызове |
| Токен | Token | Единица тарификации inference-вызовов; различают входные (input) и выходные (output) токены |
| Инференс | Inference | Вызов модели машинного обучения для получения предсказания или классификации |
| ETIM | ETIM | European Technical Information Model — международный стандарт классификации технических продуктов |
| OCR | OCR | Optical Character Recognition — оптическое распознавание текста на изображениях |
| SDK | SDK | Software Development Kit — набор инструментов и библиотек для интеграции с API |
| Эндпоинт | Endpoint | URL-адрес конкретного ресурса API, к которому направляются запросы |
| Биллинговый контекст | Billing context | Набор параметров (организация, кошелёк, лимиты), определяющих условия тарификации API-вызова |
| Организация | Organization | Верхнеуровневая сущность в системе биллинга, объединяющая пользователей, API-ключи и биллинг |
| Оценка уверенности | Confidence score | Числовое значение (0–1), отражающее степень уверенности модели в результате классификации |
| Экспоненциальная задержка | Backoff | Стратегия повторных запросов с экспоненциально увеличивающимся интервалом между попытками |
| Повторный запрос | Retry | Автоматическая повторная отправка запроса после временной ошибки (например, 429 или 503) |
| Тарифный план | Plan | Набор условий использования API: лимиты запросов, лимиты расходов, цена за токен |
| Биллинговый период | Billing period | Временной интервал (обычно календарный месяц), в рамках которого учитывается использование и квоты |
| Область видимости | Scope | Набор разрешений, определяющих, какие операции доступны API-ключу |
| Ротация ключей | Key rotation | Процедура замены API-ключа новым без прерывания работы сервиса |
| Журнал изменений | Changelog | Хронологический список изменений и обновлений API |
| Идентификатор запроса | Request ID | Уникальный UUID, возвращаемый в поле request_id каждого ответа API для отладки и поддержки |
Правила употребления
- Первое упоминание— русский термин с английским в скобках: «лимит запросов (rate limit)»
- Последующие упоминания— каноническая форма из таблицы: «rate limit»
- Аббревиатуры — всегда в английском написании: ETIM, OCR, SDK, API
- Имена полей — моноширинным шрифтом в оригинале:
request_id,idempotency-key