Developer Knowledge API

Podgląd

Ten produkt podlega „Warunkom oferty przed GA” z sekcji Ogólne warunki korzystania z usługi w Szczegółowych warunkach korzystania z usługi. Usługi w wersji przed GA są dostępne w stanie „takim, jaki jest” i mogą mieć ograniczone wsparcie. Więcej informacji znajdziesz w opisach etapu uruchamiania.

Interfejs Developer Knowledge API zapewnia zautomatyzowany 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. Oferuje 2 główne funkcje:

• 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.

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

Korpus wyszukiwanych treści jest wymieniony w sekcji Odwołanie do korpusu.

Uwaga dotycząca wersji podglądowej: ta wersja podglądowa umożliwia wyszukiwanie i pobieranie stron dokumentacji jako 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. W oknie Utworzono klucz API wyświetli się ciąg znaków nowo utworzonego klucza.
3. Kliknij Edytuj klucz API.
4. W polu Nazwa podaj nazwę klucza.
5. W sekcji Ograniczenia interfejsów API kliknij Ogranicz klucz.
6. Na liście Wybierz interfejsy API włącz Developer Knowledge API i kliknij OK.
   • Uwaga: jeśli interfejs Developer Knowledge API został dopiero włączony, może minąć trochę czasu, zanim pojawi się na liście Wybierz interfejsy API.
7. Kliknij Zapisz.

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.

Dołączona 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.