Method: documents.searchDocumentChunks

Wyszukuje informacje dla deweloperów w dokumentacji Google dla deweloperów. Zwraca DocumentChunk na podstawie zapytania użytkownika. Może być wiele fragmentów z tego samego Document. Aby pobrać pełne dokumenty, użyj znaków DeveloperKnowledge.GetDocument lub DeveloperKnowledge.BatchGetDocuments ze znakiem DocumentChunk.parent zwróconym w SearchDocumentChunksResponse.results.

Żądanie HTTP

GET https://developerknowledge.googleapis.com/v1/documents:searchDocumentChunks

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
query

string

Wymagane. Zawiera nieprzetworzony ciąg zapytania podany przez użytkownika, np. „Jak utworzyć zasobnik Cloud Storage?”. Zapytanie nie może przekraczać 500 znaków. Wartości dłuższe niż 500 znaków spowodują błąd INVALID_ARGUMENT.
pageSize

integer

Opcjonalnie: Określa maksymalną liczbę wyników do zwrócenia. Usługa może zwrócić mniej niż ta wartość.

Jeśli nie podano tego argumentu, zwracanych jest maksymalnie 5 wyników.

Maksymalna wartość to 100. Wartości powyżej 100 zostaną ograniczone do 100.
pageToken

string

Opcjonalnie: Zawiera token strony otrzymany z poprzedniego wywołania documents.searchDocumentChunks. Podaj ten token, aby pobrać kolejną stronę.
filter

string

Opcjonalnie: Stosuje ścisły filtr do wyników wyszukiwania. Wyrażenie obsługuje podzbiór składni opisanej na stronie https://google.aip.dev/160.

Funkcja documents.searchDocumentChunks zwraca DocumentChunk, ale filtr jest stosowany do pól DocumentChunk.document.

Pola obsługiwane w przypadku filtrowania:

  • content_length_bytes (INTEGER): długość pola Document.content w bajtach.
  • data_source (STRING): źródło dokumentu, np. docs.cloud.google.com. Pełną listę źródeł danych w korpusie znajdziesz na stronie https://developers.google.com/knowledge/reference/corpus-reference.
  • update_time (TIMESTAMP): sygnatura czasowa ostatniej istotnej aktualizacji dokumentu. Istotna aktualizacja to taka, która zmienia zawartość dokumentu w formacie Markdown lub jego metadane.
  • uri (STRING): identyfikator URI dokumentu, np. https://docs.cloud.google.com/bigquery/docs/tables.

Pola INTEGER obsługują operatory =, <, <=, > i >=.

Pola STRING obsługują operatory = (równa się) i != (nie równa się) w przypadku ścisłego dopasowania całego ciągu znaków. Nie są obsługiwane częściowe dopasowanie, dopasowanie prefiksu ani dopasowanie wyrażenia regularnego.

Pola TIMESTAMP obsługują operatory =, <, <=, > i >=. Sygnatury czasowe muszą być w formacie RFC-3339, np. "2025-01-01T00:00:00Z".

Uwaga: nazwy pól muszą być w snake_case (np. data_source). Wartości po prawej stronie wyrażeń filtrujących muszą być literałami tekstowymi ujętymi w podwójne cudzysłowy (np. "docs.cloud.google.com").

Wyrażenia możesz łączyć za pomocą operatorów logicznych AND, OR i NOT (lub -). OR ma wyższy priorytet niż AND. Używaj nawiasów do jawnego grupowania kolejności wykonywania działań.

Przykłady:

  • Filtruj według: Document.content_length_bytes – content_length_bytes < 50000
  • data_source = "docs.cloud.google.com" OR data_source = "firebase.google.com"
  • data_source != "firebase.google.com"
  • update_time < "2024-01-01T00:00:00Z"
  • update_time >= "2025-01-22T00:00:00Z" AND (data_source = "developer.chrome.com" OR data_source = "web.dev")
  • uri = "https://docs.cloud.google.com/release-notes"

Ciąg znaków filter nie może przekraczać 500 znaków. Wartości dłuższe niż 500 znaków spowodują błąd INVALID_ARGUMENT.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Wiadomość z odpowiedzią dla DeveloperKnowledge.SearchDocumentChunks.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "results": [
    {
      object (DocumentChunk)
    }
  ],
  "nextPageToken": string
}
Pola
results[]

object (DocumentChunk)

Zawiera wyniki wyszukiwania dla danego zapytania. Każdy DocumentChunk na tej liście zawiera fragment treści związany z zapytaniem. Użyj pola DocumentChunk.parent w każdym wyniku z DeveloperKnowledge.GetDocument lub DeveloperKnowledge.BatchGetDocuments, aby pobrać pełną treść dokumentu.
nextPageToken

string

Zawiera token, który można wysłać jako pageToken, aby pobrać następną stronę. Jeśli pominiesz to pole, nie będzie kolejnych stron.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/developerprofiles.readonly
  • https://www.googleapis.com/auth/cloud-platform

Więcej informacji znajdziesz w sekcji OAuth 2.0 Overview.