REST Resource: documents

Ressource: Dokument

Ein Dokument stellt einen Inhalt aus dem Developer Knowledge-Korpus dar.

JSON-Darstellung 
{
  "name": string,
  "uri": string,
  "content": string,
  "description": string,
  "dataSource": string,
  "title": string,
  "updateTime": string,
  "view": enum (DocumentView)
}
Felder
name

string

ID. Enthält den Ressourcennamen des Dokuments. Format: documents/{uri_without_scheme} Beispiel: documents/docs.cloud.google.com/storage/docs/creating-buckets
uri

string

Nur Ausgabe. Enthält die URI des Inhalts, z. B. docs.cloud.google.com/storage/docs/creating-buckets.
content

string

Nur Ausgabe. Enthält den vollständigen Inhalt des Dokuments im Markdown-Format.
description

string

Nur Ausgabe. Enthält eine Beschreibung des Dokuments.
dataSource

string

Nur Ausgabe. Gibt die Datenquelle des Dokuments an. Beispieldatenquelle: firebase.google.com
title

string

Nur Ausgabe. Enthält den Titel des Dokuments.
updateTime

string (Timestamp format)

Nur Ausgabe. Stellt den Zeitstempel dar, an dem der Inhalt oder die Metadaten des Dokuments zuletzt aktualisiert wurden.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"
view

enum (DocumentView)

Nur Ausgabe. Gibt die DocumentView des Dokuments an.

DocumentView

Gibt an, welche Felder des Document enthalten sind.

Enums
DOCUMENT_VIEW_UNSPECIFIED Der Standardwert / nicht festgelegte Wert. Den Standardwert für die einzelnen API-Methoden finden Sie in der Dokumentation der jeweiligen Methode, wenn DocumentView nicht angegeben ist.
DOCUMENT_VIEW_BASIC

Enthält nur die grundlegenden Metadatenfelder: - name - uri - dataSource - title - description - updateTime - view

Dies ist die Standardansicht für DeveloperKnowledge.SearchDocumentChunks.
DOCUMENT_VIEW_FULL Enthält alle Document-Felder.
DOCUMENT_VIEW_CONTENT

Enthält die Felder DOCUMENT_VIEW_BASIC und das Feld content.

Dies ist die Standardansicht für DeveloperKnowledge.GetDocument und DeveloperKnowledge.BatchGetDocuments.

Methoden

batchGet

 Ruft mehrere Dokumente ab, jeweils mit dem vollständigen Markdown-Inhalt.

get

 Ruft ein einzelnes Dokument mit dem vollständigen Markdown-Inhalt ab.

searchDocumentChunks

 Durchsucht die Entwicklerdokumentation von Google nach Informationen für Entwickler.