Developer Knowledge API

Interfejs Developer Knowledge API zapewnia automatyczny dostęp do publicznej dokumentacji dla deweloperów Google, umożliwiając zintegrowanie tej bazy wiedzy z własnymi aplikacjami i przepływami pracy.

Przegląd

Interfejs Developer Knowledge API został zaprojektowany jako kanoniczne źródło dostępu do dokumentacji dla deweloperów Google w formacie czytelnym dla maszyn. Umożliwia wyszukiwanie i pobieranie dokumentów oraz odpowiadanie na zapytania:

• SearchDocumentChunks aby na podstawie zapytania znaleźć odpowiednie identyfikatory URI stron i fragmenty treści.
• GetDocument lub BatchGetDocuments aby pobrać pełną treść wyników wyszukiwania.
• AnswerQuery – aby uzyskać odpowiedzi na zapytania oparte na korpusie dokumentacji.

Aby szybko rozpocząć, skorzystaj z krótkiego przewodnika.

Korpus wyszukiwanych treści 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.

Wskazówka: jeśli nie masz projektu w chmurze Google Cloud, utwórz go, postępując zgodnie z instrukcjami dotyczącymi Google Cloud lub Firebase.

1. Otwórz stronę interfejsu Developer Knowledge API w bibliotece interfejsów API Google.
2. Sprawdź, czy masz wybrany odpowiedni 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

Aby korzystać z interfejsu Developer Knowledge API, musisz mieć klucz interfejsu Developer Knowledge API. Aby utworzyć taki plik:

1. W konsoli Google Cloud w projekcie, w którym został włączony interfejs API, otwórz stronę Dane logowania.
2. Kliknij Utwórz dane logowania, a potem w menu wybierz Klucz interfejsu API.
3. W polu Nazwa podaj nazwę klucza.
4. Kliknij menu Wybierz ograniczenia interfejsu API, a następnie wpisz Developer Knowledge API. Kliknij wynik, a następnie kliknij OK.
   • Uwaga: jeśli interfejs Developer Knowledge API został dopiero włączony, może minąć trochę czasu, zanim pojawi się na liście. Poczekaj kilka minut i spróbuj ponownie.
5. Kliknij Utwórz.

Dołącz ten klucz interfejsu Developer Knowledge API do swoich żądań. Na przykład wywołania REST powinny zawierać go w parametrze zapytania key. Przykład znajdziesz w krótkim przewodniku.

Dokumentacja

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

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 publiczne strony w korpusie referencyjnym. Nie uwzględniamy treści z innych źródeł, takich jak GitHub, witryny OSS, blogi czy YouTube.