Krótkie wprowadzenie: korzystanie z interfejsu Developer Knowledge API

Z tego przewodnika dowiesz się, jak zacząć korzystać z interfejsu Developer Knowledge API. Dowiesz się, jak włączyć interfejs Developer Knowledge API, uzyskać klucz API i wykonać pierwsze wywołania interfejsu API, aby wyszukiwać i pobierać dokumentację dla programistów.

Zanim zaczniesz

Zanim zaczniesz korzystać z interfejsu Developer Knowledge API, wykonaj te czynności.

Włącz API

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

Tworzenie i zabezpieczanie klucza interfejsu API

  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.

Odpowiadanie na zapytanie za pomocą generowania opartego na faktach

Gdy uzyskasz klucz interfejsu Developer Knowledge API, możesz zacząć korzystać z tego interfejsu. Poniższy przykład pokazuje, jak zadać zapytanie i uzyskać odpowiedź opartą na dokumentacji:

  1. Zapisz klucz interfejsu Developer Knowledge API w zmiennej środowiskowej:

    export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

    Zastąp YOUR_API_KEY wygenerowanym kluczem interfejsu API.

  2. Użyj curl, aby wywołać punkt końcowy AnswerQuery:

    curl -X POST "https://developerknowledge.googleapis.com/v1alpha:answerQuery?key=$DEVELOPERKNOWLEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "How do I create a BigQuery dataset?"}'

To polecenie zwraca odpowiedź na Twoje zapytanie na podstawie dokumentacji.

Wyszukiwanie fragmentów dokumentów

Jeśli chcesz znaleźć konkretne fragmenty dokumentacji, a nie wygenerowaną odpowiedź, możesz bezpośrednio wyszukać fragmenty dokumentów.

Użyj curl, aby wywołać punkt końcowy SearchDocumentChunks:

curl "https://developerknowledge.googleapis.com/v1/documents:searchDocumentChunks?query=BigQuery&key=$DEVELOPERKNOWLEDGE_API_KEY"

Odpowiedź zawiera pasujące fragmenty treści z dokumentacji i odwołania do dokumentów nadrzędnych.

Pobieranie dokumentu

Odpowiedź z searchDocumentChunks zawiera listę fragmentów dokumentu. Każdy fragment dokumentu ma pole parent zawierające nazwę zasobu dokumentu, której możesz użyć z GetDocument, aby pobrać pełną treść dokumentu.

Aby pobrać dokument, skopiuj pole parent z jednego z fragmentów zwróconych przez searchDocumentChunks i zapisz je w zmiennej środowiskowej, a następnie użyj curl, aby wywołać punkt końcowy GetDocument:

export DOC_NAME="PARENT_FIELD_FROM_SEARCH"

curl "https://developerknowledge.googleapis.com/v1/$DOC_NAME?key=$DEVELOPERKNOWLEDGE_API_KEY"

Zwraca pełną zawartość Markdown wskazanego dokumentu.

Co dalej?