OpenQCoreAI
Loslegen

Ressourcen · Knowledge API

Knowledge API-Dokumentation

Umfassende Referenz für das Einpflegen, Abrufen und Abfragen von Workspace-Wissen sowie produktionstaugliche Einschränkungen.

Zurück zur DokumentationZu den Endpunkten springen

Endpunkte

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

Erforderliche Header

Authorization: Bearer [token] oder API-Schlüssel-AuthentifizierungX-Scope-Type: workspaceX-Workspace-ID: [workspace_uuid]Content-Type: application/json (oder multipart/form-data für Upload)

Upload-Beispiel

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"

Beispielanfrage

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

Antwortbeispiel

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

Wissensbeschränkungen

  • Maximale Dateigröße: 20 MB pro Upload.
  • Unterstützte Formate: PDF, DOC, DOCX, TXT, Markdown.
  • Die Ingestion läuft asynchron in Hintergrund-Workern.
  • Der Workspace-Scope ist für Console-Knowledge-Operationen erforderlich.

Ingestions-Lebenszyklus

  1. pending: Datei akzeptiert und in die Warteschlange gestellt.
  2. processing: Extraktion/Chunking/Embedding läuft.
  3. processed: Element ist indexiert und abfragebereit.
  4. failed: Ingestion fehlgeschlagen mit diagnostischen Metadaten.

Fehlermodelle

400

Ungültige Nutzlast oder fehlerhafte Filter.

401

Fehlende oder ungültige Authentifizierung.

403

Zugriff auf den Arbeitsbereich aufgrund der Rolle/des Scopes verweigert.

404

Wissenseintrag nicht gefunden.

413

Die hochgeladene Datei überschreitet die zulässige Größe.

415

Nicht unterstützter Inhaltstyp der Datei.

422

Validierungsfehler im Anfrageschema/-kontext.

429

Rate-Limit überschritten.