Comment utiliser la documentation CometAPI avec des LLM ?

Utilisez llms.txt lorsque vous avez besoin d’un index compact des pages de documentation CometAPI. Utilisez llms-full.txt lorsque votre outil peut ingérer le texte complet de la documentation pour le retrieval, les questions-réponses ou l’assistance au code.

Récupérer l’index compact

La requête suivante télécharge l’index llms.txt de CometAPI :

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

La réponse commence par le titre de la documentation et la liste des pages liées :

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

Récupérer le texte complet

La requête suivante télécharge l’export du texte complet :

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

La réponse contient le contenu des pages regroupé par URL source :

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

Ajouter la documentation à une tâche de retrieval

L’exemple Python suivant télécharge le texte complet et l’écrit dans un fichier local pour l’indexation :

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

Le résultat correspond au nombre de caractères enregistrés. Il s’agit uniquement d’un exemple de sortie ; votre valeur sera différente à chaque modification de la documentation :

Erreurs courantes

Erreur	Correction
Le contexte de l’outil est trop petit	Utilisez d’abord `llms.txt`, puis récupérez uniquement les pages liées qui comptent.
Le texte complet est trop volumineux	Découpez `llms-full.txt` par titre ou par URL source avant l’indexation.
Cache local corrompu	Actualisez le fichier pendant votre tâche de synchronisation de documentation.
Page manquante dans les résultats AI	Vérifiez que la page apparaît dans la navigation et dans `llms.txt`.

Documentation Index

​Récupérer l’index compact

​Récupérer le texte complet

​Ajouter la documentation à une tâche de retrieval

​Erreurs courantes

​Liens associés

Récupérer l’index compact

Récupérer le texte complet

Ajouter la documentation à une tâche de retrieval

Erreurs courantes

Liens associés