Na tej stronie dowiesz się, jak zacząć korzystać z bibliotek klienta Cloud dla interfejsu Developer Knowledge API. Zamiast tworzyć surowe żądania HTTP, biblioteki klienta udostępniają typy idiomatyczne, wbudowane uwierzytelnianie, automatyczne stronicowanie i obsługę ponawiania, co zmniejsza ilość kodu, który musisz napisać.
Więcej informacji o bibliotekach klienta interfejsów API Google znajdziesz w artykule Informacje o bibliotekach klienta.
Instalowanie biblioteki klienta
Wybierz język programowania, aby zainstalować oficjalną bibliotekę klienta interfejsu Developer Knowledge API:
Go
Dodaj moduł do projektu Go:
go get cloud.google.com/go/developerknowledge/apiv1
Więcej informacji znajdziesz w artykule Konfigurowanie środowiska programistycznego Go.
Java
Jeśli używasz Maven, dodaj do pliku pom.xml tę zależność:
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-developer-knowledge</artifactId>
<version>0.6.0</version>
</dependency>
Jeśli używasz Gradle, dodaj do pliku build.gradle tę zależność:
implementation 'com.google.cloud:google-cloud-developer-knowledge:0.6.0'
Więcej informacji znajdziesz w artykule Konfigurowanie środowiska programistycznego Java.
Node.js i TypeScript
Zainstaluj pakiet za pomocą narzędzia npm:
npm install @google/developer-knowledge
Więcej informacji znajdziesz w artykule Konfigurowanie środowiska programistycznego Node.js.
PHP
Zainstaluj pakiet za pomocą narzędzia Composer:
composer require google/developer-knowledge
Więcej informacji znajdziesz w artykule Korzystanie z PHP w Google Cloud.
Python
Zainstaluj pakiet za pomocą narzędzia pip:
pip install --upgrade google-developer-knowledge
Więcej informacji znajdziesz w artykule Konfigurowanie środowiska programistycznego Pythona.
Ruby
Zainstaluj gem:
gem install google-developers-developer_knowledge
Więcej informacji znajdziesz w artykule Konfigurowanie środowiska programistycznego Ruby.
Konfigurowanie uwierzytelniania
Zanim zaczniesz wysyłać żądania do interfejsu API, upewnij się, że masz włączony interfejs Developer Knowledge API w projekcie Google Cloud.
Aby uwierzytelniać wywołania interfejsu Developer Knowledge API, biblioteki klienta obsługują domyślne uwierzytelnianie aplikacji (ADC). Biblioteki szukają danych logowania w określonych lokalizacjach i używają ich do uwierzytelniania żądań wysyłanych do interfejsu API. Dzięki ADC możesz udostępniać dane logowania aplikacji w różnych środowiskach, takich jak lokalne środowisko deweloperskie czy środowisko produkcyjne, bez konieczności modyfikowania kodu aplikacji.
W przypadku środowisk produkcyjnych sposób konfigurowania ADC zależy od usługi i kontekstu:
- Środowiska Google Cloud: gdy aplikacja działa w Cloud Run, Google Kubernetes Engine, Compute Engine lub funkcjach Cloud Run, ADC automatycznie używa konta usługi dołączonego do zasobu obliczeniowego.
- Środowiska zewnętrzne lub lokalne: użyj federacji tożsamości zadań lub ustaw zmienną środowiskową
GOOGLE_APPLICATION_CREDENTIALSna ścieżkę do pliku konfiguracji danych logowania.
Więcej informacji o opcjach uwierzytelniania w środowisku produkcyjnym znajdziesz w artykule Konfigurowanie domyślnego uwierzytelniania aplikacji.
W przypadku lokalnego środowiska programistycznego możesz skonfigurować ADC za pomocą danych logowania powiązanych z Twoim kontem Google:
- Zainstaluj i zainicjuj gcloud CLI.
Utwórz lokalne dane uwierzytelniające na koncie Google:
gcloud auth application-default loginPojawi się ekran logowania. Po zalogowaniu się Twoje dane logowania są przechowywane w lokalnym pliku danych logowania używanym przez ADC.
Dodatkowe materiały
Wybierz kartę języka, aby znaleźć linki do dokumentacji API, przykłady kodu, sprawdzone metody, narzędzia do śledzenia problemów i repozytoria kodu źródłowego dla każdej biblioteki klienta:
Go
Poniżej znajdziesz linki do dodatkowych materiałów związanych z biblioteką klienta Go:
Java
Poniżej znajdziesz linki do dodatkowych materiałów związanych z biblioteką klienta Java:
Node.js i TypeScript
Poniżej znajdziesz linki do dodatkowych materiałów związanych z biblioteką klienta Node.js i TypeScript:
PHP
Lista poniżej zawiera linki do dodatkowych materiałów związanych z biblioteką klienta PHP:
Python
Poniżej znajdziesz linki do dodatkowych materiałów związanych z biblioteką klienta Python:
Ruby
Poniżej znajdziesz linki do dodatkowych materiałów związanych z biblioteką klienta Ruby:
Co dalej?
- Zapoznaj się z szybkim wprowadzeniem do bibliotek klienta, aby wyświetlić i uruchomić przykłady kodu w językach
AnswerQuery,SearchDocumentChunks,GetDocumentiBatchGetDocuments. - Więcej informacji o filtrach zapytań, stronicowaniu i maskach pól znajdziesz w artykule Wyszukiwanie i pobieranie dokumentów.
- Użyj generowania opartego na faktach z funkcją Generuj odpowiedzi na podstawie dokumentacji.
- Zapoznaj się ze strategiami ponawiania i kodami stanu w sekcji Obsługa błędów, ograniczanie liczby żądań i zarządzanie limitami.
- Przejrzyj korpus referencyjny, aby wyświetlić wszystkie obsługiwane domeny dokumentacji.