Method: documents.searchDocumentChunks

Sucht in der Entwicklerdokumentation von Google nach Informationen für Entwickler. Gibt DocumentChunks basierend auf der Abfrage des Nutzers zurück. Es kann viele Chunks aus demselben Document geben. Verwenden Sie DeveloperKnowledge.GetDocument oder DeveloperKnowledge.BatchGetDocuments mit dem in SearchDocumentChunksResponse.results zurückgegebenen DocumentChunk.parent, um vollständige Dokumente abzurufen.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Abfrageparameter

Parameter
query

string

Erforderlich. Enthält den vom Nutzer angegebenen Rohabfragestring, z. B. „Wie erstelle ich einen Cloud Storage-Bucket?“. Die Abfrage darf maximal 500 Zeichen lang sein. Bei längeren Werten wird ein INVALID_ARGUMENT-Fehler zurückgegeben.
pageSize

integer

Optional. Gibt die maximale Anzahl der zurückzugebenden Ergebnisse an. Der Dienst gibt möglicherweise weniger als diesen Wert zurück.

Falls nicht angegeben, werden maximal 5 Ergebnisse zurückgegeben.

Der Maximalwert ist 100. Werte über 100 werden auf 100 festgelegt.
pageToken

string

Optional. Enthält ein Seitentoken, das von einem vorherigen documents.searchDocumentChunks-Aufruf empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen.
filter

string

Optional. Wendet einen strengen Filter auf die Suchergebnisse an. Der Ausdruck unterstützt eine Teilmenge der unter https://google.aip.dev/160 beschriebenen Syntax.

Während documents.searchDocumentChunks DocumentChunks zurückgibt, wird der Filter auf die Felder DocumentChunk.document angewendet.

Unterstützte Felder für die Filterung:

  • contentLengthBytes (Ganzzahl): Die Länge des Felds Document.content in Byte.
  • dataSource (String): Die Quelle des Dokuments, z.B. docs.cloud.google.com. Die vollständige Liste der Datenquellen im Korpus finden Sie unter https://developers.google.com/knowledge/reference/corpus-reference.
  • updateTime (Zeitstempel): Der Zeitstempel, der angibt, wann das Dokument zuletzt sinnvoll aktualisiert wurde. Eine sinnvolle Aktualisierung ist eine Aktualisierung, bei der der Markdown-Inhalt oder die Metadaten des Dokuments geändert werden.
  • uri (String): Die URI des Dokuments, z.B. https://docs.cloud.google.com/bigquery/docs/tables.

Ganzzahlfelder unterstützen die Operatoren =, <, <=, >, und >=.

Stringfelder unterstützen die Operatoren = (gleich) und != (ungleich) für genaue Übereinstimmungen im gesamten String. Teilweise Übereinstimmungen, Präfixübereinstimmungen und reguläre Ausdrücke werden nicht unterstützt.

Zeitstempelfelder unterstützen die Operatoren =, <, <=, >, und >=. Zeitstempel müssen im RFC 3339-Format vorliegen, z.B. "2025-01-01T00:00:00Z".

Sie können Ausdrücke mit den logischen Operatoren AND, OR und NOT (oder -) kombinieren. OR hat eine höhere Priorität als AND. Verwenden Sie Klammern, um die Priorität explizit festzulegen.

Beispiele:

  • Nach Document.content_length_bytes filtern: contentLengthBytes < 50000
  • 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"

Der filter-String darf maximal 500 Zeichen lang sein. Bei längeren Werten wird ein INVALID_ARGUMENT-Fehler zurückgegeben.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwortnachricht für DeveloperKnowledge.SearchDocumentChunks.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "results": [
    {
      object (DocumentChunk)
    }
  ],
  "nextPageToken": string
}
Felder
results[]

object (DocumentChunk)

Enthält die Suchergebnisse für die angegebene Abfrage. Jeder DocumentChunk in dieser Liste enthält einen Snippet von Inhalten, die für die Suchanfrage relevant sind. Verwenden Sie das Feld DocumentChunk.parent jedes Ergebnisses mit DeveloperKnowledge.GetDocument oder DeveloperKnowledge.BatchGetDocuments, um den vollständigen Dokumentinhalt abzurufen.
nextPageToken

string

Enthält ein Token, das als pageToken gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter OAuth 2.0 Overview.