Developer Knowledge API

Interfejs Developer Knowledge API umożliwia automatyczny dostęp do publicznej dokumentacji Google dla deweloperów, dzięki czemu możesz zintegrować tę bazę wiedzy z własnymi aplikacjami i przepływami pracy.

Przegląd

Interfejs Developer Knowledge API ma być kanonicznym źródłem dostępu do dokumentacji Google dla deweloperów w formacie czytelnym dla maszyn. Oferuje funkcje wyszukiwania i pobierania dokumentów oraz odpowiadania na zapytania:

• SearchDocumentChunks, aby na podstawie zapytania znaleźć odpowiednie identyfikatory URI stron i fragmenty treści.
• GetDocument lub BatchGetDocuments aby pobrać pełną zawartość wyników wyszukiwania.
• AnswerQuery – generuje odpowiedzi na zapytania pochodzące z korpusu dokumentacji.

Interfejs Developer Knowledge API umożliwia wyszukiwanie i pobieranie stron dokumentacji w postaci nieustrukturyzowanych treści w formacie Markdown. Korpus treści dostępnych do przeszukiwania jest wymieniony w informacjach o korpusie.

Sposoby korzystania z wiedzy dla programistów

Wiedza dla deweloperów jest dostępna w tych miejscach w zależności od Twojego sposobu pracy:

• REST API i RPC API: wywołuj bezpośrednio punkty końcowe HTTP lub gRPC. Specyfikacje metod znajdziesz w dokumentacji REST i dokumentacji RPC.
• Biblioteki klienta: zintegruj interfejs Developer Knowledge API z aplikacjami, korzystając z oficjalnych bibliotek klienta dla języków Python, Node.js i TypeScript, Go, Java, PHP i Ruby.
• Google Cloud CLI (gcloud): uruchamiaj polecenia gcloud developer-knowledge w terminalu, aby wyszukiwać fragmenty dokumentów, pobierać treści w języku Markdown i generować odpowiedzi.
• Serwer MCP Developer Knowledge: połącz asystenta lub agenta AI do kodowania z dokumentacją Google za pomocą narzędzi protokołu Model Context Protocol (MCP) (search_documents, get_documents i answer_query). Więcej informacji znajdziesz w dokumentacji MCP.

Wskazówka: jeśli używasz asystenta kodowania AI, zainstaluj retrieving-developer-knowledge umiejętność agenta, uruchamiając npx skills add google/skills --skill retrieving-developer-knowledge. Ta umiejętność zawiera wbudowane instrukcje dotyczące tego, które narzędzie serwera MCP Developer Knowledge wybrać, jak obsługiwać błędy i jak wywoływać interfejs API REST za pomocą curl, jeśli serwer MCP jest niedostępny. Więcej informacji znajdziesz w artykule Korzystanie z umiejętności agenta Developer Knowledge.

Wybieranie między interfejsem API a serwerem MCP

Interfejs Developer Knowledge API i serwer Developer Knowledge MCP zostały zaprojektowane z myślą o różnych potrzebach integracji:

• Korzystaj z interfejsu Developer Knowledge API, bibliotek klienta lub interfejsu wiersza poleceń gcloud, gdy:
  • Twój projekt nie korzysta z agenta AI.
  • Chcesz zdefiniować niestandardowe narzędzia lub zestawy narzędzi dla swojego agenta.
  • Chcesz przetworzyć lub połączyć wyniki przed przekazaniem ich do modelu (np. sprawdzić długość dokumentu w bajtach przed pobraniem pełnej treści).
  • Musisz filtrować wyniki wyszukiwania (np. według data_source lub update_time) lub zastosować maski pól.
• Używaj serwera MCP Developer Knowledge i umiejętności agenta, gdy:
  • Chcesz połączyć asystenta lub agenta kodowania AI bez pisania niestandardowych definicji i opisów narzędzi.
  • Chcesz, aby aktualizacje były automatyczne, ponieważ serwer MCP Developer Knowledge dodaje nowe funkcje.
  • Nie potrzebujesz niestandardowego filtrowania metadanych w wynikach wyszukiwania.

Włącz API

Aby korzystać z interfejsu Developer Knowledge API, musisz najpierw włączyć go w projekcie Google Cloud.

Wskazówka: jeśli nie masz projektu w chmurze Google Cloud, utwórz go, korzystając z instrukcji dotyczących Google Cloud lub Firebase.

1. Otwórz stronę interfejsu Developer Knowledge API w bibliotece interfejsów API Google.
2. Sprawdź, czy masz wybrany prawidłowy projekt, w którym zamierzasz używać interfejsu API.
3. Kliknij Włącz. Do włączenia i korzystania z interfejsu API nie są wymagane żadne konkretne role uprawnień.

Uwierzytelnianie

Żądania do interfejsu Developer Knowledge API możesz uwierzytelniać za pomocą jednej z tych metod:

• Klucz interfejsu API: uwierzytelnij bezpośrednie żądania REST lub serwer MCP Developer Knowledge za pomocą parametru zapytania key lub nagłówka X-Goog-Api-Key.
• Domyślne uwierzytelnianie aplikacji (ADC), OAuth 2.0 lub konta usługi: uwierzytelniaj żądania podczas korzystania z oficjalnych bibliotek klienta lub przepływów pracy w środowisku produkcyjnym. Więcej informacji o konfigurowaniu danych logowania znajdziesz w dokumentacji domyślnego uwierzytelniania aplikacji.
• Dane logowania użytkownika (gcloud CLI): uwierzytelnianie żądań interfejsu wiersza poleceń przez zalogowanie się na konto Google Cloud za pomocą gcloud auth login. Instrukcje konfiguracji znajdziesz w krótkim przewodniku po gcloud CLI.

Dołączona dokumentacja

Więcej informacji o tym, które dokumenty są przeszukiwane przez interfejs API, znajdziesz w materiałach referencyjnych dotyczących korpusu.

Interfejs Developer Knowledge API ma na celu zapewnienie dostępu do najnowszej dokumentacji dla deweloperów Google. Naszym celem jest ponowne indeksowanie treści w ciągu 48 godzin od publikacji, aby nowe lub zaktualizowane dokumenty były dostępne w ciągu 2 dni roboczych.

Znane ograniczenia

• Jakość formatu Markdown: format Markdown jest generowany na podstawie źródłowego kodu HTML. Mogą wystąpić pewne rozbieżności lub problemy z formatowaniem.
• Zakres treści: obejmuje tylko strony publiczne w zbiorze referencyjnym. Nie obejmuje on treści z innych źródeł, takich jak GitHub, witryny OSS, blogi czy YouTube.