Retrieval

Synchronisierte Quellen und hochgeladene Dokumente bilden einen semantischen Suchindex. Agenten greifen per Retrieval-Augmented Generation (RAG) auf die Inhalte zu.

Überblick

Retrieval macht die Inhalte hochgeladener Dokumente für Agenten durchsuchbar. Wenn ein Agent das Tool retrieval_query verwendet, führt es eine semantische Suche über die hochgeladenen Inhalte aus und gibt die relevantesten Passagen zurück. Dieses Verfahren wird als Retrieval-Augmented Generation (RAG) bezeichnet.

Retrieval ist über den Tab Retrieval im Projekt erreichbar. Es gilt jeweils für das aktive Environment, sodass Produktivumgebung und Staging unterschiedliche Inhalte haben können.

Text- und Datei-Uploads werden als Ingestion Jobs in die Warteschlange gestellt und sind nach Abschluss der Indexierung durchsuchbar.

Inhalte hinzufügen

Klicke auf Add content, um Inhalte hochzuladen. Dafür gibt es zwei Möglichkeiten:

Namespaces

Namespaces organisieren Retrieval-Einträge über durch Punkte getrennte Pfade in einer Hierarchie. Zum Beispiel policies.hr.leave, policies.legal und products.pricing.

• Durchsuche Namespaces in der Baumansicht in der Seitenleiste des Retrieval-Bereichs. Klicke auf einen Namespace, um Einträge zu filtern; untergeordnete Namespaces werden einbezogen
• Agenten können innerhalb eines Namespaces und aller untergeordneten Namespaces suchen. Eine Abfrage von policies durchsucht beispielsweise auch policies.hr.leave
• Agenten können die Namespace-Hierarchie zur Laufzeit mit dem Tool retrieval_list_namespaces ermitteln
• Die maximale Namespace-Tiefe beträgt 10 Ebenen

Retrieval abfragen

Retrieval lässt sich auf zwei Arten abfragen:

Über das Dashboard

Klicke im Retrieval-Bereich auf Search, um den Abfragedialog zu öffnen. Gib eine natürlichsprachliche Anfrage ein und filtere optional nach Namespace. Die Ergebnisse zeigen passende Passagen nach Relevanz-Score sortiert und verlinken auf den Quelleneintrag. So lässt sich prüfen, ob Retrieval für repräsentative Abfragen die erwarteten Inhalte zurückgibt.

version: "1.0"

name: support-agent
type: llm
model: connic/gpt-5.6-terra
description: "Beantwortet Kundenfragen mithilfe von Retrieval"
system_prompt: |
  Du bist ein Agent für den Kundensupport.
  Verwende das Tool retrieval_query, um relevante Informationen
  zu finden, bevor du Fragen beantwortest.
tools:
  - retrieval_query

Synchronisierte Quellen

Verbinde unter Retrieval → Sources Notion, Confluence Cloud, Superhuman Docs (Coda) oder eine Website. Jede Quelle gilt für das aktive Environment und schreibt Einträge in den ausgewählten Namespace.

• Notion, Confluence und Superhuman Docs unterstützen Zeitpläne im Abstand von 15 Minuten, stündlich, alle 6 Stunden, täglich oder wöchentlich
• Website-Quellen unterstützen Zeitpläne alle 12 Stunden, täglich oder wöchentlich
• Lege fest, ob Inhalte, die in der verbundenen Quelle fehlen, aus Retrieval entfernt oder beibehalten werden
• Verwende Sync now für einen Run bei Bedarf und prüfe Anzahl und Fehler der Source Runs in den Quelldetails
• Jedes während eines Source Runs aufgenommene Element wird mit dem Projektguthaben verrechnet

Einträge verwalten

Die Retrieval-Tabelle zeigt indexierte Einträge. Aktuelle Uploads und Ingestion-Fehler werden separat im Panel Ingestion erfasst.

• Details anzeigen: Klicke auf einen Eintrag, um seinen vollständigen Inhalt, alle Chunks mit Token-Anzahl und die Metadaten zu sehen. Bei PDFs enthält jeder Chunk die Seitenzahl.
• Filtern: Grenze die Liste durch Auswahl eines Namespaces in der Seitenleiste, Suche nach Eintrags-IDs oder Filterung nach Inhaltstyp ein
• Löschen: Entferne einen Eintrag und alle seine Chunks aus dem Suchindex.
• Upload-Status: Überwache im Ingestion-Panel Jobs mit den Statuswerten queued, processing, retrying, completed und failed.

Retrieval über Agenten verwalten

Neben dem Dashboard können Agenten Retrieval-Einträge mithilfe vordefinierter Tools programmatisch hinzufügen und entfernen:

Agenten können mit diesen Tools Zusammenfassungen verarbeiteter Dokumente speichern und Einträge löschen. Details zur Verwendung stehen in den Dokumentation der vordefinierten Tools, vollständige Konfigurationsoptionen in den Dokumentation der Retrieval-Tools.

Retrieval über die REST API verwalten

Die REST API unterstützt Retrieval-Uploads, Abfragen, Browsing, Löschen und Quellenverwaltung. Die hier gezeigten Endpunkte zum Hochladen, Abfragen, Durchsuchen und Löschen erfordern retrieval.manage. Quellenlisten und Ergebnisse von Source Runs erfordern retrieval.view; zum Verbinden, Bearbeiten, Synchronisieren und Entfernen von Quellen ist retrieval.manage erforderlich.

Alle Retrieval-Endpunkte benötigen den Query-Parameter environment_id, da Retrieval jeweils für ein Environment gilt.

curl -X POST "https://api.connic.co/v1/projects/{project_id}/retrieval/text?environment_id={env_id}" \
  -H "Authorization: Bearer cnc_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "Dokumenttext...",
    "namespace": "docs.api",
    "entry_id": "api-reference-v2"
  }'

curl -X POST "https://api.connic.co/v1/projects/{project_id}/retrieval/file?environment_id={env_id}&namespace=reports.q1" \
  -H "Authorization: Bearer cnc_your_api_key" \
  -F "file=@quarterly-report.pdf"

# Nach Namespace gefilterte Einträge auflisten
curl "https://api.connic.co/v1/projects/{project_id}/retrieval/entries?environment_id={env_id}&namespace=docs&limit=50" \
  -H "Authorization: Bearer cnc_your_api_key"

# Alle Chunks eines bestimmten Eintrags abrufen
curl "https://api.connic.co/v1/projects/{project_id}/retrieval/entries/api-reference-v2?environment_id={env_id}" \
  -H "Authorization: Bearer cnc_your_api_key"

# Namespace-Hierarchie auflisten
curl "https://api.connic.co/v1/projects/{project_id}/retrieval/namespaces?environment_id={env_id}&depth=3" \
  -H "Authorization: Bearer cnc_your_api_key"

# Einen einzelnen Eintrag löschen
curl -X DELETE "https://api.connic.co/v1/projects/{project_id}/retrieval/entries/api-reference-v2?environment_id={env_id}" \
  -H "Authorization: Bearer cnc_your_api_key"

# Einen vollständigen Namespace mit allen untergeordneten Inhalten löschen
curl -X DELETE "https://api.connic.co/v1/projects/{project_id}/retrieval/namespaces/reports.q1?environment_id={env_id}" \
  -H "Authorization: Bearer cnc_your_api_key"