Файл llms.txt
Обычная карта Markdown, доступная в корне или по определённому пути для совместимых агентов. На этой странице рассматриваются расположение, структура v2, обнаружение и проверка.
Последнее обновление:
Что представляет собой файл
Файл llms.txt — это документ Markdown, который сопоставляет выбранные ресурсы совместимым агентам, с необязательной заметкой для каждой ссылки. Он был предложен Джереми Ховардом (Answer.AI) в 09.2024 как соглашение, а не обязательный стандарт. Если вам нужны концепция и картина внедрения, начните с что такое llms.txt; эта страница посвящена самому файлу самому файлу.
Где он находится
V2 разрешает корень источника, https://yourdomain.com/llms.txt, или более
конкретный путь например https://yourdomain.com/docs/llms.txt. Наиболее специфичный
применимый файл описывает область страницы. Объявите его с помощью rel="describedby" в HTML или HTTP Link
заголовок, когда возможно. Сопутствующий llms-full.txt может содержать
объединённое содержимое страниц для клиентов, которые явно поддерживают это соглашение.
Структура с первого взгляда
- Один H1 с названием сайта или проекта. Обязательно, первая строка.
- Необязательная цитата после H1: фактическое резюме.
- Необязательное свободное тело Markdown для контекста (без заголовков).
- Разделы H2, каждый из которых представляет собой список
- [name](url): noteэлементов. Раздел с названиемOptionalможет редакционно помечать вторичные ссылки без особой семантики v2.
Полные правила с аннотированными примерами находятся в справочник формата.
Минимальный корректный пример
# Acme
> Acme is a hosted analytics platform for product teams.
## Documentation
- [Quickstart](https://acme.example/docs/start): install, init, first dashboard.
- [API reference](https://acme.example/docs/api): full endpoint catalogue.
## Optional
- [Blog](https://acme.example/blog): product updates and tutorials. Распространённые ошибки
- Неоднозначные относительные URL. Абсолютные ссылки безопаснее, если файл может быть скопирован.
- Маркетинговый текст в резюме. Сохраняйте фактический характер цитаты.
- Выгрузка всего sitemap. Файл представляет собой подготовленную карту, а не индекс.
- HTML вместо Markdown. Файл должен быть обычным текстом в формате Markdown.
- Раздача с неправильным MIME-типом. Используйте
text/plain(UTF-8).
Корректная раздача файла
В большинстве стеков это статический файл в вашем публичном каталоге: см. руководства для
каждого стека для
Next.js, Astro,
WordPress, Hugo или
Cloudflare Pages. Установите
Content-Type: text/plain; charset=utf-8 и короткий кэш, чтобы обновления распространялись.
FAQ
То же ли самое llms.txt и llm.txt?
Название спецификации — llms.txt (во множественном числе). llm.txt — распространённая
ошибка написания; используйте каноническое имя.
Нужно ли обновлять файл?
Да, как и карту сайта: устаревшие ссылки подрывают доверие читающих файл инструментов. Создавайте его заново, когда меняются ваши ключевые страницы.
Какого размера он должен быть?
В предложении не задано ограничение в байтах. Сосредоточьтесь на предполагаемых задачах, проверьте клиентов, которых вы поддерживаете, и при необходимости разделите реальные области на файлы уровня путей.