Документацию удобно давать ИИ-ассистенту как контекст: он будет отвечать на вопросы об интеграции, опираясь на актуальные инструкции.
Способы
| Что | Где | Формат |
|---|---|---|
| Одна страница | Кнопки ⬇ PDF и ⬇ MD вверху страницы | PDF / Markdown |
| Весь раздел продукта | «⬇ Весь раздел одним PDF» в левом меню или на странице Документация | PDF с оглавлением и закладками |
| Раздел в Markdown | /api/docs/bundle?space=ssai&format=md |
Markdown |
| Вся публичная база | /llms-full.txt | текст |
| Индекс для ИИ-агентов | /llms.txt | по стандарту llms.txt |
Выгрузка делается на языке, выбранном на портале (добавьте к ссылке &lang=ru, &lang=uk или &lang=en, чтобы выбрать явно), и учитывает ваши права: в файл попадают только страницы, которые вы видите на портале.
Что именно в файле
- Настоящий текст (не картинки) — ИИ читает его без распознавания.
- Абсолютные ссылки: ссылки между страницами, изображения и видео ведут на портал, поэтому файл понятен и вне его.
- Шапка с источником: адрес страницы, язык, продукт, уровень доступа, дата обновления.
- Видео в PDF — ссылкой (воспроизводятся на портале).
Совет
Для ИИ лучше Markdown: он компактнее и сохраняет структуру таблиц. PDF — для людей и для ассистентов, которые принимают только PDF.
Внимание
Материалы «для клиентов» конфиденциальны. Не загружайте их в публичные ИИ-сервисы, если политика вашей компании этого не разрешает.