REST Resource: projects.locations.dataStores.documents

Ressource: Dokument

Ein Dokument ist eine einzelne Inhaltseinheit, die in einen Datenspeicher aufgenommen wird. Es ist eine Unterressource eines DataStore. Während der Aufnahme wird ein Dokument geparst und in ein oder mehrere Segmente aufgeteilt.

JSON-Darstellung 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "content": {
    object (Content)
  },
  "etag": string,
  "metadata": {
    object (DocumentMetadata)
  }
}
Felder
name

string

ID. Der vollständig qualifizierte Ressourcenname des Dokuments.

Format: projects/{project}/locations/{location}/dataStores/{dataStoreId}/documents/{documentId} Die documentId muss 1–63 Zeichen lang sein und RFC1035 entsprechen.

Wenn „ImportDocuments“ Dateien direkt importiert (das Standardquellformat), leitet der Dienst die „documentId“ aus dem Cloud Storage-URI der Datei ab. Wenn derselbe URI noch einmal importiert wird, wird dasselbe Dokument aktualisiert. Eine umbenannte oder verschobene Datei wird zu einem neuen Dokument. Bei SOURCE_FORMAT_DOCUMENT_JSON wird die documentId aus der name in der Eingabedatei übernommen.
createTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel für die Erstellung des Dokuments.

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"
updateTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel der letzten Aktualisierung des Dokuments.

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".
content

object (Content)

Optional. Die mit diesem Dokument verknüpften unstrukturierten Daten: die Cloud Storage-Datei, aus der es importiert wurde. In jeder Zeile einer SOURCE_FORMAT_DOCUMENT_JSON-Eingabedatei erforderlich.
etag

string

Optional. Das ETag des Dokuments.
metadata

object (DocumentMetadata)

Optional. Benutzerdefinierte Metadaten für dieses Dokument. Die Metadatenwerte müssen dem im übergeordneten DataStore definierten documentMetadataSchema entsprechen.

Inhalt

Mit diesem Dokument verknüpfte unstrukturierte Daten

JSON-Darstellung 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "gcsUri": string
  // End of mutually exclusive fields.
}
Felder
Der Inhalt des unstrukturierten Dokuments. Im Folgenden finden Sie eine Liste der Felder, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
gcsUri

string

Der Cloud Storage-URI des Inhalts. Es werden nur Cloud Storage-URIs unterstützt, z. B. gs://bucket-name/path/to/file.
Ende der sich gegenseitig ausschließenden Felder.

DocumentMetadata

Benutzerdefinierte Metadaten, die mit einem Dokument verknüpft sind.

JSON-Darstellung 
{
  "value": {
    object
  }
}
Felder
value

object (Struct format)

Optional. Der Metadatenwert als JSON-Objekt. Der Wert muss dem im übergeordneten DataStore definierten documentMetadataSchema entsprechen.

Methoden

get

 Ruft ein Dokument ab.

list

 Listet Dokumente in einem Datenspeicher auf.
Durchsucht die Dokumente eines einzelnen Datenspeichers.