REST Resource: corpora.documents.chunks

Ressource: Chunk

Ein Chunk ist ein Teil einer Document, die zur Vektordarstellung und -speicherung als unabhängige Einheit behandelt wird. Ein Corpus kann maximal 1 Million Chunks haben.

JSON-Darstellung
{
  "name": string,
  "data": {
    object (ChunkData)
  },
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "state": enum (State)
}
Felder
name

string

Nicht veränderbar. Kennung. Der Name der Chunk-Ressource. Die ID (ohne das Präfix „corpora/*/documents/*/chunks/“) kann bis zu 40 Zeichen (in Kleinbuchstaben) oder Bindestriche (-) enthalten. Die ID darf nicht mit einem Bindestrich beginnen oder enden. Wenn der Name beim Erstellen leer ist, wird eine zufällige 12-stellige eindeutige ID generiert. Beispiel: corpora/{corpus_id}/documents/{document_id}/chunks/123a456b789c

data

object (ChunkData)

Erforderlich. Der Inhalt für Chunk, z. B. der Textstring. Die maximale Anzahl von Tokens pro Chunk beträgt 2.043.

customMetadata[]

object (CustomMetadata)

Optional. Vom Nutzer bereitgestellte benutzerdefinierte Metadaten, die als Schlüssel/Wert-Paare gespeichert sind. Die maximale Anzahl von CustomMetadata pro Chunk ist 20.

createTime

string (Timestamp format)

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

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

updateTime

string (Timestamp format)

Nur Ausgabe Der Zeitstempel der letzten Aktualisierung von Chunk.

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

state

enum (State)

Nur Ausgabe Aktueller Status von Chunk.

ChunkData

Extrahierte Daten, die den Chunk-Inhalt darstellen.

JSON-Darstellung
{

  // Union field data can be only one of the following:
  "stringValue": string
  // End of list of possible types for union field data.
}
Felder

Union-Feld data.

Für data ist nur einer der folgenden Werte zulässig:

stringValue

string

Der Chunk-Inhalt als String. Die maximale Anzahl von Tokens pro Chunk beträgt 2.043.

Status

Status für den Lebenszyklus eines Chunk-Objekts.

Enums
STATE_UNSPECIFIED Der Standardwert. Dieser Wert wird verwendet, wenn der Bundesstaat ausgelassen wird.
STATE_PENDING_PROCESSING Chunk wird verarbeitet (Einbettung und Vektorspeicherung).
STATE_ACTIVE Chunk wird verarbeitet und kann abgefragt werden.
STATE_FAILED Chunk konnte nicht verarbeitet werden.

Methoden

batchCreate

Erstellen Sie Chunks im Batch.

batchDelete

Chunks im Batch löschen.

batchUpdate

Chunks im Batch aktualisieren.

create

Erstellt einen Chunk.

delete

Löscht Chunk.

get

Ruft Informationen zu einem bestimmten Chunk ab.

list

Listet alle Chunks in einer Document auf.

patch

Aktualisiert eine Chunk.