In dieser Anleitung finden Sie Beispiele für die Verwendung der Hauptfunktionen 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 aktivieren und einen Developer Knowledge API-Schlüssel generieren. Speichern Sie den Schlüssel in einer Umgebungsvariablen:
export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"
Mit SearchDocumentChunks nach Dokumenten suchen
Mit der Methode documents.searchDocumentChunks können Sie Dokumentteile finden, die einem Abfragestring entsprechen. Die Ergebnisse enthalten Inhaltsblöcke aus dem Dokument und eine parent-Referenz, mit der Sie den vollständigen Dokumentinhalt abrufen können.
Im folgenden Beispiel wird nach Dokumenten gesucht, die mit „BigQuery“ übereinstimmen:
curl "https://developerknowledge.googleapis.com/v1alpha/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, um nachfolgende Seiten abzurufen.
Dokument mit GetDocument abrufen
Verwenden Sie die Methode documents.get, um den vollständigen Inhalt eines einzelnen Dokuments abzurufen. Verwenden Sie dazu die DocumentChunk.parent, die von einem SearchDocumentChunks-Aufruf zurückgegeben wird.
Im folgenden Beispiel wird ein Dokument mit dem Namen documents/DOCUMENT_ID abgerufen:
curl "https://developerknowledge.googleapis.com/v1alpha/documents:get?name=documents/DOCUMENT_ID&key=$DEVELOPERKNOWLEDGE_API_KEY"
Die Antwort ist die vollständige Document-Ressource, einschließlich des Felds content.
Mehrere Dokumente mit BatchGetDocuments abrufen
Verwenden Sie die Methode documents.batchGet, um mit einem einzigen API-Aufruf bis zu 100 Dokumente nach Namen abzurufen. Das ist effizienter als mehrere GetDocument-Anfragen.
Im folgenden Beispiel werden zwei Dokumente anhand des Namens abgerufen:
curl "https://developerknowledge.googleapis.com/v1alpha/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.