Method: documents.searchDocumentChunks

Wyszukuje informacje dla deweloperów w dokumentacji Google dla deweloperów. Zwraca DocumentChunk na podstawie zapytania użytkownika. Z tego samego Document może pochodzić wiele fragmentów. Aby pobrać pełne dokumenty, użyj DeveloperKnowledge.GetDocument lub DeveloperKnowledge.BatchGetDocuments z wartością DocumentChunk.parent zwróconą 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?”.
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 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ć 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:

  • 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 istotnej aktualizacji dokumentu. Istotna aktualizacja to taka, która zmienia zawartość w formacie Markdown lub metadane dokumentu.
  • uri (STRING): identyfikator URI dokumentu, np. https://docs.cloud.google.com/bigquery/docs/tables.

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

Pola 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 -). OR ma wyższy priorytet niż AND. Używaj nawiasów do jawnego grupowania priorytetów.

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ść 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

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 sekcji OAuth 2.0 Overview.

DocumentChunk

DocumentChunk reprezentuje fragment treści z Document w korpusie DeveloperKnowledge. Aby pobrać całą zawartość dokumentu, przekaż wartość parent do parametru DeveloperKnowledge.GetDocument lub DeveloperKnowledge.BatchGetDocuments.

Zapis JSON 
{
  "parent": string,
  "id": string,
  "content": string,
  "document": {
    object (Document)
  }
}
Pola
parent

string

Tylko dane wyjściowe. Zawiera nazwę zasobu dokumentu, z którego pochodzi ten fragment. Format: documents/{uri_without_scheme} Przykład: documents/docs.cloud.google.com/storage/docs/creating-buckets
id

string

Tylko dane wyjściowe. Określa identyfikator tego fragmentu w dokumencie. Identyfikator fragmentu jest unikalny w ramach dokumentu, ale nie jest unikalny globalnie w różnych dokumentach. Identyfikator fragmentu nie jest stały i może się z czasem zmienić.
content

string

Tylko dane wyjściowe. Zawiera treść fragmentu dokumentu.
document

object (Document)

Tylko dane wyjściowe. Zawiera metadane dotyczące Document, z którego pochodzi ten fragment. DocumentView tej wiadomości Document zostanie ustawiony na DOCUMENT_VIEW_BASIC. Jest on tu uwzględniony dla wygody, aby klienci nie musieli wywoływać funkcji DeveloperKnowledge.GetDocument ani DeveloperKnowledge.BatchGetDocuments, jeśli potrzebują tylko pól metadanych. W przeciwnym razie klienci powinni używać DeveloperKnowledge.GetDocument lub DeveloperKnowledge.BatchGetDocuments, aby pobrać pełną treść dokumentu.