Search-API-Schnellstart

Die Search-API bietet programmatischen Zugriff auf dieselbe Retrieval-Engine, die Vulgates Suche und Chat antreibt. Sie können neuronale (bedeutungsbasierte) und Stichwort-Suchen (wörtliche Übereinstimmung) durchführen, mit optionalen Filtern für Autor, Erscheinungsjahr, ISBN und Dokument-ID.

Die vollständige Referenz finden Sie unter /developers/search/overview. Diese Anleitung behandelt die häufigsten Muster.

Neuronale Suche

Passagen finden, deren Bedeutung einer Abfrage entspricht:

curl -G "https://vulgate.ai/api/search" \
  -H "Authorization: Bearer $VULGATE_API_KEY" \
  --data-urlencode "search=early church councils on civic authority" \
  --data-urlencode "mode=neural" \
  --data-urlencode "per_page=5"

Antwort (gekürzt):

{
  "data": [
    {
      "id": "part-abc123",
      "document_id": "doc-xyz789",
      "index": "urn:vulgate:doc-xyz789:42",
      "content_rendered": "<p>The fathers reasoned that civic governance...</p>",
      "language": "en",
      "namespace": "mai",
      "documents": {
        "id": "doc-xyz789",
        "title": "The Council of Nicaea",
        "author": "...",
        "publication_date": "1995",
        "document_format": "PDF",
        "scope": "organization"
      }
    }
  ],
  "count": 42,
  "error": null
}

Stichwortsuche

Passagen finden, die die wörtlichen Wörter enthalten. Setzen Sie mode=keyword:

curl -G "https://vulgate.ai/api/search" \
  -H "Authorization: Bearer $VULGATE_API_KEY" \
  --data-urlencode "search=Constantine" \
  --data-urlencode "mode=keyword" \
  --data-urlencode "per_page=10"

Filtern

Filter über Query-Parameter hinzufügen:

curl -G "https://vulgate.ai/api/search" \
  -H "Authorization: Bearer $VULGATE_API_KEY" \
  --data-urlencode "search=grace" \
  --data-urlencode "author=Augustine" \
  --data-urlencode "mode=neural"

Verfügbare Filter: author, publication_date (Jahr), isbn, id (Dokument-ID für exakte Übereinstimmung) und document_id (um innerhalb eines einzelnen Dokuments zu suchen).

Bibliotheken auswählen

Der Query-Parameter libraries beschränkt die Suche auf eine oder mehrere Bibliotheken. Übergeben Sie ihn als wiederholten Query-Parameter:

curl -G "https://vulgate.ai/api/search" \
  -H "Authorization: Bearer $VULGATE_API_KEY" \
  --data-urlencode "search=liturgical calendar" \
  --data-urlencode "libraries=mai" \
  --data-urlencode "libraries=orientale"

Wenn libraries weggelassen wird, verwendet die API standardmäßig Ihre private Bibliothek.

Dokumente suchen (nicht Passagen)

Um Dokumente aufzulisten, die nach Titel übereinstimmen, anstatt einzelne Passagen zurückzugeben, verwenden Sie /api/search/documents:

curl -G "https://vulgate.ai/api/search/documents" \
  -H "Authorization: Bearer $VULGATE_API_KEY" \
  --data-urlencode "search=Eucharist" \
  --data-urlencode "per_page=20"

Paginierung

Verwenden Sie page (1-indexiert) und per_page (max. 100), um durch die Ergebnismenge zu navigieren:

?search=theology&per_page=20&page=2

Das count-Feld in der Antwort ist eine geschätzte Gesamtzahl — geeignet für Paginator-UIs.