W tym przewodniku znajdziesz przykłady użycia funkcji interfejsu Developer Knowledge API: wyszukiwania dokumentów, pobierania pojedynczego dokumentu i pobierania wielu dokumentów w ramach jednej operacji.
Zanim zaczniesz, upewnij się, że masz włączony interfejs API i wygenerowany klucz Developer Knowledge API key. Zapisz klucz w zmiennej środowiskowej variable:
export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"
Wyszukiwanie dokumentów za pomocą funkcji SearchDocumentChunks
Użyj metody, aby znaleźć fragmenty dokumentów pasujące do ciągu zapytania.documents.searchDocumentChunks Wyniki zawierają fragmenty treści dokumentu i odniesienie parent, którego możesz użyć do pobrania pełnej treści dokumentu.
Poniższy przykład wyszukuje dokumenty pasujące do hasła „BigQuery”:
curl "https://developerknowledge.googleapis.com/v1/documents:searchDocumentChunks?query=BigQuery&key=$DEVELOPERKNOWLEDGE_API_KEY"
Wyniki wyszukiwania możesz zawęzić za pomocą parametrów takich jak pageSize, aby ograniczyć liczbę wyników na stronie, oraz pageToken, aby pobrać kolejne strony.
Filtrowanie wyników wyszukiwania
Użyj parametru filter, aby zastosować ścisły filtr do wyników wyszukiwania. Filtr jest stosowany do metadanych dokumentów powiązanych z fragmentami wyników wyszukiwania.
Obsługiwane pola do filtrowania:
data_source(STRING): źródło dokumentu, np.docs.cloud.google.com.update_time(TIMESTAMP): sygnatura czasowa ostatniej aktualizacji dokumentu.uri(STRING): identyfikator URI dokumentu, np.https://docs.cloud.google.com/bigquery/docs/tables.
Obsługiwane operatory:
- Pola typu STRING obsługują operatory
=(równa się) i!=(nie równa się) w przypadku dokładnych dopasowań całego ciągu. - Pola typu TIMESTAMP obsługują operatory
=,<,<=,>, i>=. Sygnatury czasowe muszą być w formacie RFC-3339 (np."2025-01-01T00:00:00Z").
Wyrażenia możesz łączyć za pomocą operatorów logicznych AND, OR i NOT (lub -). Pamiętaj, że operator OR ma wyższy priorytet niż AND.
Poniższy przykład wyszukuje dokumenty pasujące do hasła „BigQuery” i ogranicza wyniki do tych z domeny docs.cloud.google.com:
curl "https://developerknowledge.googleapis.com/v1/documents:searchDocumentChunks?query=BigQuery&filter=data_source%3D%22docs.cloud.google.com%22&key=$DEVELOPERKNOWLEDGE_API_KEY"
Pobieranie dokumentu za pomocą funkcji GetDocument
Użyj documents.get
metody, aby pobrać pełną treść pojedynczego dokumentu.
Poniższy przykład pobiera dokument o nazwie documents/DOCUMENT_ID:
curl "https://developerknowledge.googleapis.com/v1/documents:get?name=documents/DOCUMENT_ID&key=$DEVELOPERKNOWLEDGE_API_KEY"
Odpowiedź to pełny
Document
zasób, w tym pole content.
Pobieranie wielu dokumentów za pomocą funkcji BatchGetDocuments
Użyj metody documents.batchGet
, aby pobrać maksymalnie 100 dokumentów według nazwy w ramach jednego wywołania interfejsu API. Jest to bardziej wydajne niż wysyłanie wielu żądań GetDocument.
Poniższy przykład pobiera 2 dokumenty według nazwy:
curl "https://developerknowledge.googleapis.com/v1/documents:batchGet?names=documents/DOCUMENT_ID_1&names=documents/DOCUMENT_ID_2&key=$DEVELOPERKNOWLEDGE_API_KEY"
Odpowiedź zawiera listę żądanych
Document
zasobów.