Auf dieser Seite werden die ersten Schritte mit den Cloud-Clientbibliotheken für die Developer Knowledge API beschrieben. Anstatt Roh-HTTP-Anfragen zu erstellen, bieten Clientbibliotheken idiomatische Typen, integrierte Authentifizierung, automatische Paginierung und Wiederholungsbehandlung, die die Menge des zu schreibenden Codes reduzieren.
Weitere Informationen zu Clientbibliotheken für Google-APIs finden Sie unter Erläuterung zu Clientbibliotheken.
Clientbibliothek installieren
Wählen Sie Ihre Programmiersprache aus, um die offizielle Developer Knowledge API-Clientbibliothek zu installieren:
Ok
Fügen Sie das Modul Ihrem Go-Projekt hinzu:
go get cloud.google.com/go/developerknowledge/apiv1
Weitere Informationen finden Sie unter Go-Entwicklungsumgebung einrichten.
Java
Wenn Sie Maven verwenden, fügen Sie Ihrer Datei pom.xml die folgende Abhängigkeit hinzu:
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-developer-knowledge</artifactId>
<version>0.6.0</version>
</dependency>
Wenn Sie Gradle verwenden, fügen Sie Ihrer build.gradle-Datei die folgende Abhängigkeit hinzu:
implementation 'com.google.cloud:google-cloud-developer-knowledge:0.6.0'
Weitere Informationen finden Sie unter Java-Entwicklungsumgebung einrichten.
Node.js und TypeScript
Installieren Sie das Paket mit npm:
npm install @google/developer-knowledge
Weitere Informationen finden Sie unter Einrichten einer Node.js-Entwicklungsumgebung.
PHP
Installieren Sie das Paket mit Composer:
composer require google/developer-knowledge
Weitere Informationen finden Sie unter PHP in Google Cloud verwenden.
Python
Installieren Sie das Paket mit pip:
pip install --upgrade google-developer-knowledge
Weitere Informationen finden Sie unter Python-Entwicklungsumgebung einrichten.
Ruby
Installieren Sie das Gem:
gem install google-developers-developer_knowledge
Weitere Informationen finden Sie unter Einrichten einer Ruby-Entwicklungsumgebung.
Authentifizierung einrichten
Bevor Sie API-Anfragen stellen, müssen Sie die Developer Knowledge API in Ihrem Google Cloud-Projekt aktivieren.
Zur Authentifizierung von Aufrufen an die Developer Knowledge API unterstützen Clientbibliotheken Standardanmeldedaten für Anwendungen (Application Default Credentials, ADC). Die Bibliotheken suchen an einer Reihe von definierten Standorten nach Anmeldedaten und verwenden diese Anmeldedaten, um Anfragen bei der API zu authentifizieren. Mit ADC können Sie Anmeldedaten für Ihre Anwendung in verschiedenen Umgebungen bereitstellen, z. B. in der lokalen Entwicklung oder Produktion, ohne den Anwendungscode ändern zu müssen.
In Produktionsumgebungen hängt die Art der Einrichtung von ADC vom Dienst und Kontext ab:
- Google Cloud-Umgebungen: Wenn Ihre Anwendung in Cloud Run, Google Kubernetes Engine, Compute Engine oder Cloud Run Functions ausgeführt wird, verwendet ADC automatisch das Dienstkonto, das an die Compute-Ressource angehängt ist.
- Externe oder lokale Umgebungen: Verwenden Sie die Workload Identity-Föderation oder legen Sie die Umgebungsvariable
GOOGLE_APPLICATION_CREDENTIALSauf den Pfad einer Konfigurationsdatei für Anmeldedaten fest.
Weitere Informationen zu den Optionen für Produktionsanmeldedaten finden Sie unter Standardanmeldedaten für Anwendungen einrichten.
Für eine lokale Entwicklungsumgebung können Sie ADC mit den Anmeldedaten einrichten, die Ihrem Google-Konto zugeordnet sind:
- Installieren und initialisieren Sie die gcloud CLI.
Erstellen Sie lokale Anmeldedaten zur Authentifizierung für Ihr Google-Konto:
gcloud auth application-default loginEin Anmeldebildschirm wird angezeigt. Nach der Anmeldung werden Ihre Anmeldedaten in der lokalen Anmeldedatendatei für ADC gespeichert.
Zusätzliche Ressourcen
Wählen Sie einen Sprach-Tab aus, um Links zur API-Referenzdokumentation, zu Codebeispielen, Best Practices, Issue-Trackern und Quellcode-Repositories für die einzelnen Clientbibliotheken zu finden:
Ok
Die folgende Liste enthält Links zu weiteren Ressourcen im Zusammenhang mit der Clientbibliothek für Go:
Java
Die folgende Liste enthält Links zu weiteren Ressourcen im Zusammenhang mit der Clientbibliothek für Java:
Node.js und TypeScript
Die folgende Liste enthält Links zu weiteren Ressourcen im Zusammenhang mit der Clientbibliothek für Node.js und TypeScript:
PHP
Die folgende Liste enthält Links zu weiteren Ressourcen im Zusammenhang mit der Clientbibliothek für PHP:
Python
Die folgende Liste enthält Links zu weiteren Ressourcen im Zusammenhang mit der Clientbibliothek für Python:
Ruby
Die folgende Liste enthält Links zu weiteren Ressourcen im Zusammenhang mit der Clientbibliothek für Ruby:
Nächste Schritte
- Folgen Sie der Kurzanleitung zu Clientbibliotheken, um Codebeispiele für
AnswerQuery,SearchDocumentChunks,GetDocumentundBatchGetDocumentsanzusehen und auszuführen. - Weitere Informationen zu Abfragefiltern, Paginierung und Feldmasken finden Sie unter Dokumente suchen und abrufen.
- Fundierte Generierung mit Antworten aus Dokumentation generieren verwenden
- Informationen zu Wiederholungsstrategien und Statuscodes finden Sie unter Fehlerbehandlung, Ratenbegrenzung und Kontingentverwaltung.
- In der Korpusreferenz finden Sie alle unterstützten Dokumentationsbereiche.