Як використовувати документацію CometAPI з LLM?

Використовуйте llms.txt, коли вам потрібен компактний індекс сторінок документації CometAPI. Використовуйте llms-full.txt, коли ваш інструмент може обробляти повний текст документації для retrieval, відповідей на запитання або допомоги з кодуванням.

Отримання компактного індексу

Наведений нижче запит завантажує індекс CometAPI llms.txt:

curl https://apidoc.cometapi.com/llms.txt

Відповідь починається із заголовка документації та списку сторінок із посиланнями:

# CometAPI Documentation

> CometAPI developer documentation for unified API access...

## Docs

- [Create a new API key](https://apidoc.cometapi.com/api/api-keys/create-api-key.md)

Отримання повного тексту

Наведений нижче запит завантажує повний текстовий експорт:

curl https://apidoc.cometapi.com/llms-full.txt

Відповідь містить вміст сторінок, згрупований за вихідним URL:

# Create a new API key
Source: https://apidoc.cometapi.com/api/api-keys/create-api-key

Create a new CometAPI API key for the authenticated account.

Додавання документації до retrieval job

Наведений нижче приклад Python завантажує повний текст і записує його до локального файлу для індексації:

from pathlib import Path

import requests

url = "https://apidoc.cometapi.com/llms-full.txt"
response = requests.get(url, timeout=60)
response.raise_for_status()

Path("cometapi-docs.txt").write_text(response.text, encoding="utf-8")
print(len(response.text))

Результатом є кількість збережених символів. Це лише приклад виводу; ваше значення буде відрізнятися щоразу, коли документація змінюється:

Поширені помилки

Помилка	Виправлення
Контекст інструмента занадто малий	Спочатку використайте `llms.txt`, а потім отримайте лише ті пов’язані сторінки, які мають значення.
Повний текст занадто великий	Розбийте `llms-full.txt` на частини за heading або source URL перед індексацією.
Пошкоджений локальний кеш	Оновлюйте файл під час вашого завдання синхронізації документації.
Сторінка відсутня в AI-результатах	Переконайтеся, що сторінка присутня в навігації та в `llms.txt`.

Documentation Index

​Отримання компактного індексу

​Отримання повного тексту

​Додавання документації до retrieval job

​Поширені помилки

​Пов’язані посилання

Отримання компактного індексу

Отримання повного тексту

Додавання документації до retrieval job

Поширені помилки

Пов’язані посилання