Erste Schritte
Erstellen Sie einen API-Schlüssel und führen Sie Ihre erste Dokumentensuche mit Nordvec durch.
Dieser Leitfaden führt Sie von Grund auf zu Ihrem ersten Suchergebnis.
1. Erstellen Sie einen API-Schlüssel
Melden Sie sich an und erstellen Sie einen Schlüssel in den Einstellungen Ihres Arbeitsbereichs. Der Rohschlüssel wird einmalig angezeigt und ist anschließend nicht mehr verfügbar. Speichern Sie ihn daher sicher. Schlüssel sind auf Ihren Arbeitsbereich beschränkt und authentifizieren sich als Bearer-Token.
Weitere Informationen zum gesamten Lebenszyklus (Rotation, Widerruf, Grace-Perioden) finden Sie unter Authentifizierung.
2. Durchsuchen Sie Ihre Dokumente
Richten Sie einen beliebigen HTTP-Client auf die API-Basis, https://nordvec.com/api/v1, und senden Sie Ihre Abfrage. Die Ergebnisse werden nach Relevanz sortiert zurückgegeben, wobei jedes Ergebnis das ursprüngliche Dokument enthält, aus dem es stammt. query ist erforderlich; limit (1–50, Standardwert 20) ist optional.
curl https://nordvec.com/api/v1/documents/search \
-H "Authorization: Bearer $NORDVEC_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "query": "quarterly revenue", "limit": 10 }'Jedes Ergebnis verweist auf sein Quelldokument, sodass Sie die Übereinstimmung überprüfen können, anstatt ihr einfach zu vertrauen. Das ist der gesamte Zweck der Plattform.
3. Arbeiten Sie mit Konversationen
Eine Konversation ist ein Chat, der auf Ihren Dokumenten basiert, wobei jede Antwort zitiert wird. Die API ermöglicht Ihnen das Erstellen, Auflisten, Abrufen und Durchsuchen von Konversationen:
# Create a conversation owned by your workspace
curl -X POST https://nordvec.com/api/v1/conversations \
-H "Authorization: Bearer $NORDVEC_API_KEY"