Skip to content

AI раздел#254

Closed
gromdron wants to merge 2 commits intobitrix-tools:mainfrom
gromdron:ai_improve
Closed

AI раздел#254
gromdron wants to merge 2 commits intobitrix-tools:mainfrom
gromdron:ai_improve

Conversation

@gromdron
Copy link
Copy Markdown

@gromdron gromdron commented Mar 1, 2026

Переработал статьи по добавлению/удалению своего сервиса и получения списка сервисов.
Вынес описание работы бекенд механизма в отдельную статью и дополнил описания.

@vk-bitrix-doc
Copy link
Copy Markdown
Contributor

Добрый день, Андрей!

Большое спасибо за проделанную работу и за идею вынести описание бекенд-механики сервиса в отдельный блок — это правда помогло заметить, что в нашей документации не хватает ряда важных деталей.

К сожалению, принять PR целиком мы не можем: с момента его создания статьи раздела AI были независимо переработаны (коммит 6ad8886), поэтому при мёрже получаются конфликты, а версии файлов из PR оказались менее полными, чем текущие — там уже есть MCP-нотификация, подробное описание фильтров и полей в ai.engine.list, расширенные коды ошибок, секция Endpoint в ai.engine.register и т.д.

Тем не менее, из вашего PR мы взяли важные моменты и дополнительно опубликовали их в ai-engine-register.md (коммит a278d74):

  • параметр ttl — время жизни callbackUrl в секундах, приходит в payload запроса к endpoint;
  • таймаут в 5 секунд на первичный ответ endpoint;
  • новая секция «Особенности для категории image» со структурой объекта prompt (prompt, style, format, images_number);
  • дополнили секцию audio полем fileExtension.

По остальным пунктам хотим пояснить наше решение:

  1. Подраздел prompts/ (ai.prompt.register / ai.prompt.unregister) мы осознанно удалили — в текущей реализации модуля оба метода всегда отдают исключения PROMPT_NOT_REGISTER_BY_REST / PROMPT_NOT_UNREGISTER_BY_REST и через REST не работают. Возвращать документацию, описывающую нерабочие методы, мы посчитали некорректным — вернём, когда/если функционал будет реализован.
  2. «При повторном вызове ai.engine.register обновляет сервис» — мы сверились с кодом (ThirdPartyRegisterService::validateUniqueCode), и в текущей реализации проверка ENGINE_REGISTER_ERROR_CODE_UNIQUE срабатывает раньше, чем стадия update, поэтому повторная регистрация с тем же code возвращает ошибку. Поэтому эту формулировку в документацию мы не добавляли.
  3. Саму ai-engine-service.md как отдельную статью решили не заводить, чтобы не расщеплять описание endpoint — вся полезная информация из неё вошла в существующую секцию Endpoint в ai-engine-register.md.

Закрываем PR, но ещё раз — спасибо за внимательность и за то, что нашли пробелы в описании: благодаря вам документация стала точнее. Будем очень рады и дальнейшему фидбеку!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants