Generowanie odpowiedzi na podstawie dokumentacji

Interfejs Developer Knowledge API umożliwia zadawanie pytań dotyczących produktów Google dla programistów i otrzymywanie bezpośrednich odpowiedzi w języku naturalnym. W przypadku każdego zapytania interfejs API tworzy odpowiedź na podstawie korpusu Developer Knowledge (w dokumentacji API nazywanego generowaniem na podstawie danych) i zawiera odwołania do odpowiednich stron dokumentacji.

Zanim zaczniesz

Skonfiguruj środowisko dla preferowanego narzędzia:

gcloud

Zainstaluj i skonfiguruj gcloud CLI oraz włącz interfejs Developer Knowledge API.

REST

Włącz interfejs API i wygeneruj klucz Developer Knowledge API. Następnie zapisz klucz w zmiennej środowiskowej:

export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

Zastąp YOUR_API_KEY kluczem Developer Knowledge API.

Odpowiadanie na zapytanie

Aby zadać pytanie, użyj pole gcloud developer-knowledge answer-querycenia lub metody REST answerQuery.

Poniższy przykład wysyła zapytanie o to, jak utworzyć zbiór danych BigQuery:

gcloud

gcloud developer-knowledge answer-query \
  --query="How do I create a BigQuery dataset?"

REST

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

Odpowiedź zawiera tekstową odpowiedź w polu answer.answerText, oraz citations i references w answer obiekcie:

{
  "answer": {
    "answerText": "To create a BigQuery dataset, you can use the Google Cloud Console, the bq command-line tool, or the BigQuery client libraries.",
    "citations": [
      {
        "startIndex": 0,
        "endIndex": 123,
        "sources": [
          {
            "referenceIndex": 0
          }
        ]
      }
    ],
    "references": [
      {
        "documentReference": {
          "documentChunk": {
            "parent": "documents/docs.cloud.google.com/bigquery/docs/datasets",
            "content": "This page explains how to create BigQuery datasets...",
            "document": {
              "name": "documents/docs.cloud.google.com/bigquery/docs/datasets",
              "title": "Introduction to datasets",
              "uri": "https://docs.cloud.google.com/bigquery/docs/datasets"
            }
          }
        }
      }
    ]
  }
}

Filtrowanie źródeł dokumentacji

Aby ograniczyć źródła dokumentacji używane do generowania odpowiedzi, przekaż wyrażenie filtrujące za pomocą flagi --query-filter w gcloud CLI lub pola filter w treści żądania REST. Więcej informacji o obsługiwanych polach filtrów i operatorach znajdziesz w artykule Filtrowanie wyników wyszukiwania.

Poniższy przykład ogranicza źródła dokumentacji do docs.cloud.google.com:

gcloud

gcloud developer-knowledge answer-query \
  --query="How do I create a BigQuery dataset?" \
  --query-filter='data_source = "docs.cloud.google.com"'

REST

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

Wybieranie między AnswerQuery a SearchDocumentChunks

Gdy używasz interfejsu API lub serwera Developer Knowledge MCP, wybierz metodę, która najlepiej pasuje do tego, czego szukasz:

  • AnswerQuery (lub narzędzie MCP answer_query): najlepsza w przypadku ogólnych pytań typu „Instrukcje”, porównywania produktów i szczegółowych przewodników, w których chcesz uzyskać pełne podsumowanie z linkami do dokumentów źródłowych.
  • SearchDocumentChunks (lub narzędzie MCP search_documents): najlepsza do wyszukiwania dokładnych flag CLI, składni kodu, nazw parametrów lub uprawnień IAM (np. service.resource.verb). Zamiast pełnego pytania użyj od 2 do 5 konkretnych słów kluczowych.

Co dalej?