Jak używać dokumentacji CometAPI z LLM-ami?

Używaj llms.txt, gdy potrzebujesz kompaktowego indeksu stron dokumentacji CometAPI. Używaj llms-full.txt, gdy Twoje narzędzie może przetwarzać pełny tekst dokumentacji do retrieval, odpowiadania na pytania lub wsparcia programistycznego.

Pobieranie kompaktowego indeksu

Poniższe żądanie pobiera indeks CometAPI llms.txt:

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

Odpowiedź zaczyna się od tytułu dokumentacji i listy podlinkowanych stron:

# 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)

Pobieranie pełnego tekstu

Poniższe żądanie pobiera eksport pełnego tekstu:

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

Odpowiedź zawiera treść stron pogrupowaną według źródłowego 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.

Dodawanie dokumentacji do zadania retrieval

Poniższy przykład w Pythonie pobiera pełny tekst i zapisuje go do pliku lokalnego w celu indeksowania:

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))

Wynikiem jest liczba zapisanych znaków. To tylko przykładowe dane wyjściowe; Twoja wartość będzie inna za każdym razem, gdy dokumentacja się zmieni:

Typowe błędy

Błąd	Poprawka
Kontekst narzędzia jest zbyt mały	Najpierw użyj `llms.txt`, a następnie pobierz tylko te podlinkowane strony, które są istotne.
Pełny tekst jest zbyt duży	Podziel `llms-full.txt` na fragmenty według nagłówków lub źródłowego URL przed indeksowaniem.
Uszkodzony lokalny cache	Odśwież plik podczas zadania synchronizacji dokumentacji.
Brak strony w wynikach AI	Potwierdź, że strona pojawia się w nawigacji oraz w `llms.txt`.

Documentation Index

​Pobieranie kompaktowego indeksu

​Pobieranie pełnego tekstu

​Dodawanie dokumentacji do zadania retrieval

​Typowe błędy

​Powiązane linki

Pobieranie kompaktowego indeksu

Pobieranie pełnego tekstu

Dodawanie dokumentacji do zadania retrieval

Typowe błędy

Powiązane linki