Method: documents.searchDocumentChunks

Sucht in der Entwicklerdokumentation von Google nach Informationen für Entwickler. Diese Methode gibt Dokumentabschnitte basierend auf der Anfrage des Nutzers zurück. Es kann viele Chunks desselben Dokuments 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/v1alpha/documents:searchDocumentChunks

Die URL verwendet die Syntax der gRPC-Transcodierung.

Abfrageparameter

Parameter
query

string

Erforderlich. Der vom Nutzer bereitgestellte Rohabfragestring, z. B. „Wie erstelle ich einen Cloud Storage-Bucket?“.
pageSize

integer

Optional. Die maximale Anzahl von zurückzugebenden Ergebnissen. Der Dienst gibt möglicherweise weniger als diesen Wert zurück.

Wenn 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. Ein Seitentoken, das von einem vorherigen documents.searchDocumentChunks-Aufruf empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen.

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)

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. 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 den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/devprofiles.full_control

Weitere Informationen finden Sie unter OAuth 2.0 Overview.

DocumentChunk

Ein DocumentChunk stellt einen Inhalt aus einem Dokument 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
}
Felder
parent

string

Nur Ausgabe. Der Ressourcenname 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. Die ID dieses Chunks im Dokument. 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. Der Inhalt des Dokumentabschnitts.