Method: documents.searchDocumentChunks

Sucht in der Entwicklerdokumentation von Google nach Informationen für Entwickler. Gibt DocumentChunks basierend auf der Anfrage des Nutzers zurück. Es kann viele Chunks aus derselben Document geben. Wenn Sie vollständige Dokumente abrufen möchten, verwenden Sie DeveloperKnowledge.GetDocument oder DeveloperKnowledge.BatchGetDocuments mit dem in SearchDocumentChunksResponse.results zurückgegebenen DocumentChunk.parent.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Abfrageparameter

Parameter
query

string

Erforderlich. Enthält den vom Nutzer angegebenen Roh-Suchstring, z. B. „Wie erstelle ich einen Cloud Storage-Bucket?“.
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 Höchstwert beträgt 20. Höhere Werte führen zu einem INVALID_ARGUMENT-Fehler.
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 DocumentChunk zurückgibt, wird der Filter auf DocumentChunk.document-Felder angewendet.

Unterstützte Felder zum Filtern:

  • dataSource (STRING): Die Quelle des Dokuments, z.B. docs.cloud.google.com. Eine vollständige Liste der Datenquellen im Korpus finden Sie unter https://developers.google.com/knowledge/reference/corpus-reference.
  • updateTime (TIMESTAMP): Der Zeitstempel, der angibt, wann das Dokument zuletzt inhaltlich aktualisiert wurde. Ein sinnvolles Update ändert den Markdown-Inhalt oder die Metadaten des Dokuments.
  • uri (STRING): Der Dokument-URI, z.B. https://docs.cloud.google.com/bigquery/docs/tables.

STRING-Felder unterstützen die Operatoren = (gleich) und != (ungleich) für genaue Übereinstimmungen für den gesamten String. Teilübereinstimmungen, Präfixübereinstimmungen und Übereinstimmungen mit regulären Ausdrücken werden nicht unterstützt.

TIMESTAMP-Felder 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 für die explizite Gruppierung nach Priorität.

Beispiele:

  • 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 String filter darf maximal 500 Zeichen lang sein. Bei längeren Werten wird der Fehler INVALID_ARGUMENT ausgegeben.

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 Anfrage. Jedes DocumentChunk in dieser Liste enthält einen Ausschnitt 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

Optional. Stellt ein Token bereit, 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/cloud-platform

Weitere Informationen finden Sie unter OAuth 2.0 Overview.

DocumentChunk

Ein DocumentChunk stellt einen Inhalt aus einem Document im DeveloperKnowledge-Korpus dar. Wenn Sie den gesamten Dokumentinhalt abrufen möchten, übergeben Sie parent an DeveloperKnowledge.GetDocument oder DeveloperKnowledge.BatchGetDocuments.

JSON-Darstellung 
{
  "parent": string,
  "id": string,
  "content": string,
  "document": {
    object (Document)
  }
}
Felder
parent

string

Nur Ausgabe. Enthält den Ressourcennamen des Dokuments, aus dem dieser Chunk stammt. Format: documents/{uri_without_scheme} Beispiel: documents/docs.cloud.google.com/storage/docs/creating-buckets
id

string

Nur Ausgabe. Gibt die ID dieses Chunks innerhalb des Dokuments an. Die Chunk-ID ist innerhalb eines Dokuments eindeutig, aber nicht global über alle Dokumente hinweg. Die Chunk-ID ist nicht stabil und kann sich im Laufe der Zeit ändern.
content

string

Nur Ausgabe. Enthält den Inhalt des Dokumentblocks.
document

object (Document)

Nur Ausgabe. Stellt Metadaten zum Document dar, aus dem dieser Chunk stammt. Die DocumentView dieser Document-Nachricht wird auf DOCUMENT_VIEW_BASIC festgelegt. Es ist hier der Einfachheit halber enthalten, damit Clients DeveloperKnowledge.GetDocument oder DeveloperKnowledge.BatchGetDocuments nicht aufrufen müssen, wenn sie nur die Metadatenfelder benötigen. Andernfalls sollten Clients DeveloperKnowledge.GetDocument oder DeveloperKnowledge.BatchGetDocuments verwenden, um den vollständigen Dokumentinhalt abzurufen.