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),
  "contentLengthBytes": integer
}
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. Gibt den URI des Inhalts an, 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. Bietet eine Beschreibung des Dokuments.
dataSource

string

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

string

Nur Ausgabe. Gibt den Titel des Dokuments an.
updateTime

string (Timestamp format)

Nur Ausgabe. Der Zeitstempel, der angibt, wann 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.
contentLengthBytes

integer

Nur Ausgabe. Die Länge des Felds content in Byte.

DocumentView

Gibt an, welche Felder des Document enthalten sind.

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

Enthält nur die grundlegenden Metadatenfelder:

  • name
  • uri
  • dataSource
  • title
  • description
  • updateTime
  • view
  • contentLengthBytes

Dies ist die Standardansicht für DeveloperKnowledge.SearchDocumentChunks.
DOCUMENT_VIEW_FULL Umfasst 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, die jeweils den vollständigen Markdown-Inhalt enthalten.

get

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

searchDocumentChunks

 Sucht in der Entwicklerdokumentation von Google nach Informationen für Entwickler.