Interfejs Developer Knowledge API umożliwia automatyczny dostęp do publicznej dokumentacji dla deweloperów Google, 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ć oficjalnym źródłem dostępu do dokumentacji dla deweloperów Google w formacie czytelnym dla maszyn. Oferuje funkcje wyszukiwania i pobierania dokumentów oraz odpowiadania na zapytania:
SearchDocumentChunks– umożliwia znajdowanie odpowiednich adresów URI stron i fragmentów treści na podstawie zapytania.GetDocumentlubBatchGetDocuments– umożliwia pobieranie pełnej treści wyników wyszukiwania.AnswerQuery– umożliwia uzyskiwanie odpowiedzi na zapytania na podstawie korpusu dokumentacji.
Aby szybko rozpocząć, postępuj zgodnie z instrukcjami w krótkim wprowadzeniu.
Korpus treści, w których można wyszukiwać, jest wymieniony w sekcji Odniesienie do korpusu.
Interfejs Developer Knowledge API umożliwia wyszukiwanie i pobieranie stron dokumentacji jako nieustrukturyzowanych treści w formacie Markdown.
Włączanie interfejsu API
Aby korzystać z interfejsu Developer Knowledge API, musisz najpierw włączyć go w swoim projekcie w chmurze Google Cloud.
- Otwórz stronę Developer Knowledge API w bibliotece interfejsów API Google.
- Sprawdź, czy masz wybrany właściwy projekt, w którym chcesz używać interfejsu API.
- Kliknij Włącz. Do włączenia lub korzystania z interfejsu API nie są wymagane żadne konkretne role IAM.
Uwierzytelnianie
Aby korzystać z interfejsu Developer Knowledge API, potrzebujesz klucza Developer Knowledge API. Aby go utworzyć:
- W konsoli Google Cloud otwórz stronę Dane logowania w projekcie, w którym został włączony interfejs API.
- Kliknij Utwórz dane logowania, a potem w menu wybierz Klucz interfejsu API.
- W polu Nazwa wpisz nazwę klucza.
-
Kliknij menu Wybierz ograniczenia interfejsu API, a potem wpisz Developer Knowledge API. Kliknij wynik, a potem kliknij OK.
Uwagi:
- Jeśli interfejs Developer Knowledge API został włączony niedawno, może minąć trochę czasu zanim pojawi się na liście. Poczekaj kilka minut i spróbuj ponownie.
-
Jeśli planujesz używać tego samego klucza do ogólnych wywołań modelu klienta AI (np.
GEMINI_API_KEY), musisz też wybrać Generative Language API. W przeciwnym razie te wywołania zostaną zablokowane.
- Kliknij Utwórz.
Dołącz ten klucz Developer Knowledge API do swoich żądań. Na przykład wywołania REST powinny go zawierać jako parametr zapytania key. Przykład znajdziesz w
krótkim wprowadzeniu.
Dołączona dokumentacja
Informacje o tym, które dokumenty są przeszukiwane przez interfejs API, znajdziesz w sekcji Odniesienie do korpusu for.
Znane ograniczenia
- Jakość Markdown: Markdown jest generowany ze źródłowego kodu HTML. Mogą występować pewne rozbieżności lub problemy z formatowaniem.
- Zakres treści: obejmuje tylko strony publiczne w sekcji Odniesienie do korpusu. Nie obejmuje treści z innych źródeł, takich jak GitHub, witryny OSS, blogi czy YouTube.