Method: documents.searchDocumentChunks

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

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
query

string

Wymagane. Zawiera surowy ciąg zapytania podany przez użytkownika, np. „Jak utworzyć zasobnik Cloud Storage?”.
pageSize

integer

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

Jeśli nie podano tego argumentu, zostanie zwróconych co najwyżej 5 wyników.

Maksymalna wartość to 20. Wartości powyżej 20 spowodują błąd INVALID_ARGUMENT.
pageToken

string

Opcjonalnie. Zawiera token strony otrzymany z poprzedniego wywołania documents.searchDocumentChunks. Podaj ten token, aby pobrać następną 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.

Chociaż documents.searchDocumentChunks zwraca DocumentChunks, filtr jest stosowany do DocumentChunk.document pól.

Pola obsługiwane do filtrowania:

  • dataSource (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.
  • updateTime (TIMESTAMP): sygnatura czasowa ostatniej znaczącej aktualizacji dokumentu. Znacząca aktualizacja to taka, która zmienia zawartość markdown lub metadane dokumentu.
  • uri (STRING): identyfikator URI dokumentu, np. https://docs.cloud.google.com/bigquery/docs/tables.

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

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

Możesz łączyć wyrażenia za pomocą operatorów logicznych AND, OR i NOT (lub -). OR ma wyższy priorytet niż AND. Używaj nawiasów, aby określić priorytet grupowania.

Przykłady:

  • dataSource = "docs.cloud.google.com" OR dataSource = "firebase.google.com"
  • dataSource != "firebase.google.com"
  • updateTime < "2024-01-01T00:00:00Z"
  • updateTime >= "2025-01-22T00:00:00Z" AND (dataSource = "developer.chrome.com" OR dataSource = "web.dev")
  • uri = "https://docs.cloud.google.com/release-notes"

Ciąg 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ść 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 obiekt DocumentChunk na tej liście zawiera fragment treści związany z zapytaniem. Aby pobrać pełną treść dokumentu, użyj pola DocumentChunk.parent każdego wyniku z DeveloperKnowledge.GetDocument lub DeveloperKnowledge.BatchGetDocuments.
nextPageToken

string

Opcjonalnie. 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/cloud-platform

Więcej informacji znajdziesz w OAuth 2.0 Overview.