OpenQCoreAI
Commencer

Ressources · Knowledge API

Documentation de l'API Knowledge

Référence complète pour l'ingestion des connaissances de l'espace de travail, la récupération, les workflows de type 'ask' et les contraintes sécurisées pour la production.

Retour à la documentationAller aux points de terminaison

Points de terminaison

GET /api/v1/console/knowledge
POST /api/v1/console/knowledge
POST /api/v1/console/knowledge/upload
GET /api/v1/console/knowledge/{item_id}
PATCH /api/v1/console/knowledge/{item_id}
DELETE /api/v1/console/knowledge/{item_id}
POST /api/v1/console/knowledge/ask

En-têtes requis

Authorization: Bearer [token] ou authentification par clé APIX-Scope-Type: workspaceX-Workspace-ID: [workspace_uuid]Content-Type: application/json (ou multipart/form-data pour le téléversement)

Exemple de téléversement

bash
curl -X POST "/api/v1/console/knowledge/upload" \
  -H "Authorization: Bearer [token]" \
  -H "X-Scope-Type: workspace" \
  -H "X-Workspace-ID: [workspace_uuid]" \
  -F "file=@handbook.pdf" \
  -F "title=Team Handbook" \
  -F "tags=hr,policy"

Exemple de requête

json
{
  "question": "What is our remote-work policy?",
  "top_k": 5,
  "filters": {
    "tags": ["hr", "policy"]
  },
  "session_id": "sess_123"
}

Exemple de réponse

json
{
  "success": true,
  "answer": "Employees may work remotely up to 3 days per week...",
  "citations": [
    {
      "item_id": "kb_456",
      "title": "Team Handbook",
      "score": 0.91
    }
  ],
  "usage": {
    "input_tokens": 180,
    "output_tokens": 72
  },
  "metadata": {
    "retrieved_items": 5
  }
}

Contraintes de la base de connaissances

  • Taille maximale du fichier : 20 Mo par téléversement.
  • Formats pris en charge : PDF, DOC, DOCX, TXT, Markdown.
  • L'ingestion s'exécute de manière asynchrone dans des processus en arrière-plan.
  • Une portée de type workspace est requise pour les opérations de knowledge dans la console.

Cycle de vie d'ingestion

  1. pending: fichier accepté et mis en file d'attente.
  2. processing: extraction/découpage/embeddings en cours.
  3. processed: l'élément est indexé et prêt pour les requêtes.
  4. failed: l'ingestion a échoué avec des métadonnées de diagnostic.

Modèles d'erreur

400

Charge utile invalide ou filtres malformés.

401

Authentification manquante ou invalide.

403

Accès à l'espace de travail refusé par rôle/portée.

404

Élément de connaissance introuvable.

413

Le fichier téléchargé dépasse la taille autorisée.

415

Type de contenu du fichier non pris en charge.

422

Échec de validation dans le schéma/contexte de la requête.

429

Limite de requêtes dépassée.