Перейти к содержанию

Для LLM и ИИ-агентов

Раздел задает правила для ИИ-агентов, которые анализируют интеграцию или формируют запросы к API CARGO.RUN Загрузки.

Машиночитаемые материалы

Начинайте с краткого индекса. Полную версию используйте для базы знаний, RAG или проверки связей между сценариями и моделями.

Приоритет источников

Если описания расходятся, используйте следующий порядок:

  1. контракт конкретного метода в API Reference;
  2. общие форматы, ошибки, статусы и минимальные требования;
  3. интеграционный сценарий;
  4. пример запроса.

Пример не отменяет таблицу полей. Если расхождение влияет на изменяющий запрос, остановите автоматическое выполнение и запросите подтверждение владельца интеграции.

Правила выполнения

  1. Получайте <baseUrl> и учетные данные из защищенной конфигурации.
  2. Не передавайте секреты и персональные данные в промпт или журнал.
  3. Передавайте в поля ...Id только значения, полученные из справочников целевой среды.
  4. После создания сохраните ID CARGO.RUN; не считайте externalId гарантированно уникальным ключом.
  5. Перед изменением существующего заказа прочитайте его актуальную карточку.
  6. Считайте создание, обновление, запуск, назначение перевозчика, отмену и удаление изменяющими операциями.
  7. После изменяющей операции повторно прочитайте объект и проверьте результат.
  8. Не считайте отсутствие truckCurrentLocation ошибкой и не называйте координаты текущими без проверки fixedAt.

Минимальный контекст

Для формирования запроса агенту достаточно передать:

  • целевой сценарий и разрешенные изменяющие действия;
  • базовый URL без секретов;
  • описание конкретного метода;
  • связанные модели, справочники и enum;
  • правила ошибок и форматов;
  • соответствие внешнего ID идентификатору CARGO.RUN.