REST Resource: corpora.documents

Ressource: Document

Eine Document ist eine Sammlung von Chunks. Ein Corpus kann maximal 10.000 Documents haben.

JSON-Darstellung
{
  "name": string,
  "displayName": string,
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "updateTime": string,
  "createTime": string
}
Felder
name

string

Nicht veränderbar. Kennung. Der Name der Document-Ressource. Die ID (Name ohne das Präfix „corpora/*/documents/“) kann bis zu 40 Zeichen (in Kleinbuchstaben) oder Bindestriche (-) enthalten. Sie darf nicht mit einem Bindestrich beginnen oder enden. Wenn der Name beim Erstellen leer ist, wird aus displayName ein eindeutiger Name mit einem zufälligen 12-stelligen Suffix abgeleitet. Beispiel: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c

displayName

string

Optional. Der für Menschen lesbare Anzeigename für Document. Der Anzeigename darf maximal 512 Zeichen, einschließlich Leerzeichen, lang sein. Beispiel: „Dokumentation zu Semantic Retriever“

customMetadata[]

object (CustomMetadata)

Optional. Vom Nutzer bereitgestellte benutzerdefinierte Metadaten, die als Schlüssel/Wert-Paare für Abfragen gespeichert werden. Ein Document kann maximal 20 CustomMetadata haben.

updateTime

string (Timestamp format)

Nur Ausgabe Der Zeitstempel der letzten Aktualisierung von Document.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

createTime

string (Timestamp format)

Nur Ausgabe Der Zeitstempel für die Erstellung des Document.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

Methoden

create

Erstellt ein leeres Document.

delete

Löscht Document.

get

Ruft Informationen zu einem bestimmten Document ab.

list

Listet alle Documents in einer Corpus auf.

patch

Aktualisiert eine Document.

query

Führt eine semantische Suche in einem Document durch.