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:
SearchDocumentChunksaby na podstawie zapytania znaleźć odpowiednie identyfikatory URI stron i fragmenty treści.GetDocumentlubBatchGetDocumentsaby pobrać pełną zawartość wyników wyszukiwania.AnswerQuery– generuje odpowiedzi na zapytania pochodzące z korpusu dokumentacji.
Aby szybko zacząć, skorzystaj z krótkiego przewodnika.
Korpus treści, w którym można wyszukiwać, jest wymieniony w sekcji Odwołanie do korpusu.
Interfejs Developer Knowledge API umożliwia wyszukiwanie i pobieranie stron dokumentacji w postaci nieustrukturyzowanych treści w formacie Markdown.
Włącz API
Aby korzystać z interfejsu Developer Knowledge API, musisz najpierw włączyć go w projekcie Google Cloud.
- Otwórz stronę interfejsu Developer Knowledge API w bibliotece interfejsów API Google.
- Sprawdź, czy masz wybrany odpowiedni projekt, w którym zamierzasz używać interfejsu API.
- 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: uwierzytelniaj bezpośrednie żądania REST za pomocą parametru zapytania
keylub nagłówkaX-Goog-Api-Key. Przykład znajdziesz w krótkim wprowadzeniu do interfejsu REST. - 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.
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.