Dokumente suchen und abrufen

In diesem Leitfaden finden Sie Beispiele für die Verwendung der Funktionen der Developer Knowledge API: Suchen nach Dokumenten, Abrufen eines einzelnen Dokuments und Abrufen mehrerer Dokumente in einem Batch.

Bevor Sie beginnen, müssen Sie die API aktiviert und einen Developer Knowledge API Schlüssel generiert haben. Speichern Sie den Schlüssel in einer Umgebungsvariablen:

export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

Mit SearchDocumentChunks nach Dokumenten suchen

Verwenden Sie die documents.searchDocumentChunks Methode, um Dokumentchunks zu finden, die mit einer Abfragestring übereinstimmen. Die Ergebnisse enthalten Chunks von Inhalten aus dem Dokument und einen parent-Verweis, mit dem Sie den vollständigen Dokumentinhalt abrufen können.

Im folgenden Beispiel wird nach Dokumenten gesucht, die mit „BigQuery“ übereinstimmen:

curl "https://developerknowledge.googleapis.com/v1/documents:searchDocumentChunks?query=BigQuery&key=$DEVELOPERKNOWLEDGE_API_KEY"

Sie können die Suchergebnisse mit Parametern wie pageSize eingrenzen, um die Anzahl der Ergebnisse pro Seite zu begrenzen, und mit pageToken nachfolgende Seiten abrufen.

Suchergebnisse filtern

Mit dem Parameter filter können Sie einen strengen Filter auf die Suchergebnisse anwenden. Der Filter wird auf die Metadaten der Dokumente angewendet, die mit den Suchergebnis-Chunks verknüpft sind.

Unterstützte Felder für die Filterung:

  • data_source (STRING): Die Quelle des Dokuments, z. B. docs.cloud.google.com.
  • update_time (TIMESTAMP): Der Zeitstempel der letzten Aktualisierung des Dokuments.
  • uri (STRING): Der Dokument-URI, z.B. https://docs.cloud.google.com/bigquery/docs/tables.

Unterstützte Operatoren:

  • STRING-Felder unterstützen = (gleich) und != (ungleich) für genaue Übereinstimmungen mit dem gesamten String.
  • TIMESTAMP-Felder unterstützen =, <, <=, >, und >=. Zeitstempel müssen im RFC-3339-Format vorliegen (z.B. "2025-01-01T00:00:00Z").

Sie können Ausdrücke mit den logischen Operatoren AND, OR und NOT (oder -) kombinieren. OR hat eine höhere Priorität als AND.

Im folgenden Beispiel wird nach Dokumenten gesucht, die mit „BigQuery“ übereinstimmen, und die Ergebnisse werden auf Dokumente von docs.cloud.google.com beschränkt:

curl "https://developerknowledge.googleapis.com/v1/documents:searchDocumentChunks?query=BigQuery&filter=data_source%3D%22docs.cloud.google.com%22&key=$DEVELOPERKNOWLEDGE_API_KEY"

Dokument mit GetDocument abrufen

Verwenden Sie die documents.get Methode, um den vollständigen Inhalt eines einzelnen Dokuments abzurufen.

Im folgenden Beispiel wird ein Dokument mit dem Namen documents/DOCUMENT_ID abgerufen:

curl "https://developerknowledge.googleapis.com/v1/documents:get?name=documents/DOCUMENT_ID&key=$DEVELOPERKNOWLEDGE_API_KEY"

Die Antwort ist die vollständige Document Ressource, einschließlich des content Felds.

Mehrere Dokumente mit BatchGetDocuments abrufen

Verwenden Sie die documents.batchGet Methode, um bis zu 100 Dokumente anhand des Namens in einem einzigen API-Aufruf abzurufen. Das ist effizienter als mehrere GetDocument-Anfragen.

Im folgenden Beispiel werden zwei Dokumente anhand des Namens abgerufen:

curl "https://developerknowledge.googleapis.com/v1/documents:batchGet?names=documents/DOCUMENT_ID_1&names=documents/DOCUMENT_ID_2&key=$DEVELOPERKNOWLEDGE_API_KEY"

Die Antwort enthält eine Liste der angeforderten Document Ressourcen.