Chunks

REST-Ressource: corpora.documents.chunks

Ressource: Chunk

Eine Chunk ist ein Unterteil einer Document, die zum Zweck der 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 Ressourcenname Chunk. Die ID (Name ohne das Präfix „corpora/*/documents/*/chunks/“) kann bis zu 40 Zeichen (kleingeschriebene alphanumerische Zeichen oder Bindestriche (-) enthalten) 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 Block ist 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 Block ist 20.

createTime string (Timestamp format)

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

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich 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 einer Auflösung im Nanosekundenbereich 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 Inhalt von Chunk 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 Inhalt von Chunk als String. Die maximale Anzahl von Tokens pro Block ist 2.043.

Status

Status für den Lebenszyklus einer Chunk.

Enums
STATE_UNSPECIFIED Der Standardwert. Dieser Wert wird verwendet, wenn der Status weggelassen wird.
STATE_PENDING_PROCESSING Chunk wird verarbeitet (Einbettung und Vektorspeicherung).
STATE_ACTIVE Chunk wird verarbeitet und ist zum Abfragen verfügbar.
STATE_FAILED Chunk konnte nicht verarbeitet werden.

Methode: corpora.documents.chunks.create

Erstellt einen Chunk.

Endpunkt

<ph type="x-smartling-placeholder"></ph> Beitrag https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks
.

Pfadparameter

parent string

Erforderlich. Der Name von Document, in dem dieses Chunk erstellt wird. Beispiel: corpora/my-corpus-123/documents/the-doc-abc. Sie hat das Format corpora/{corpora}/documents/{document}.

Anfragetext

Der Anfragetext enthält eine Instanz von Chunk.

Antworttext

Bei Erfolg enthält der Antworttext eine neu erstellte Instanz von Chunk.

Methode: corpora.documents.chunks.list

Listet alle Chunks in einem Document auf.

Endpunkt

<ph type="x-smartling-placeholder"></ph> erhalten https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks
.

Pfadparameter

parent string

Erforderlich. Der Name des Document, der Chunks enthält. Beispiel: corpora/my-corpus-123/documents/the-doc-abc. Sie hat das Format corpora/{corpora}/documents/{document}.

Abfrageparameter

pageSize integer

Optional. Die maximale Anzahl von Chunks, die zurückgegeben werden sollen (pro Seite). Der Dienst gibt möglicherweise weniger Chunks zurück.

Wenn nicht angegeben, werden höchstens 10 Chunks zurückgegeben. Die maximale Größe beträgt 100 Chunks pro Seite.

pageToken string

Optional. Ein Seitentoken, das von einem vorherigen chunks.list-Aufruf empfangen wurde.

Geben Sie das in der Antwort zurückgegebene nextPageToken als Argument für die nächste Anfrage an, um die nächste Seite abzurufen.

Beim Paginieren müssen alle anderen für chunks.list bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwort von chunks.list mit einer paginierten Liste von Chunks. Die Chunk-Werte sind nach aufsteigender chunk.create_time sortiert.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

Felder
chunks[] object (Chunk)

Die zurückgegebenen Chunks.

nextPageToken string

Ein Token, das als pageToken gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, sind keine Seiten mehr vorhanden.

JSON-Darstellung 
{
  "chunks": [
    {
      object (Chunk)
    }
  ],
  "nextPageToken": string
}

Methode: corpora.documents.chunks.get

Ruft Informationen zu einer bestimmten Chunk ab.

Endpunkt

<ph type="x-smartling-placeholder"></ph> erhalten https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*/chunks/*}
.

Pfadparameter

name string

Erforderlich. Der Name des abzurufenden Chunk-Objekts. Beispiel: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk. Sie hat das Format corpora/{corpora}/documents/{document}/chunks/{chunk}.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Chunk.

Methode: corpora.documents.chunks.patch

Aktualisiert eine Chunk.

Endpunkt

<ph type="x-smartling-placeholder"></ph> Patch https://generativelanguage.googleapis.com/v1beta/{chunk.name=corpora/*/documents/*/chunks/*}
.

PATCH https://generativelanguage.googleapis.com/v1beta/{chunk.name=corpora/*/documents/*/chunks/*}

Pfadparameter

chunk.name string

Nicht veränderbar. Kennung. Der Ressourcenname Chunk. Die ID (Name ohne das Präfix „corpora/*/documents/*/chunks/“) kann bis zu 40 Zeichen (kleingeschriebene alphanumerische Zeichen oder Bindestriche (-) enthalten) 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. Sie hat das Format corpora/{corpora}/documents/{document}/chunks/{chunk}.

Abfrageparameter

updateMask string (FieldMask format)

Erforderlich. Die Liste der zu aktualisierenden Felder. Derzeit werden nur customMetadata und data aktualisiert.

Dies ist eine durch Kommas getrennte Liste vollständig qualifizierter Feldnamen. Beispiel: "user.displayName,photo".

Anfragetext

Der Anfragetext enthält eine Instanz von Chunk.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Chunk.

Methode: corpora.documents.chunks.delete

Löscht ein Chunk.

Endpunkt

<ph type="x-smartling-placeholder"></ph> Löschen https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*/chunks/*}
.

Pfadparameter

name string

Erforderlich. Der Ressourcenname des zu löschenden Chunk. Beispiel: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk. Sie hat das Format corpora/{corpora}/documents/{document}/chunks/{chunk}.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Wenn der Vorgang erfolgreich ist, ist der Antworttext leer.

Methode: corpora.documents.chunks.batchCreate

Erstellen Sie im Batch Chunks.

Endpunkt

<ph type="x-smartling-placeholder"></ph> Beitrag https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchCreate
.

Pfadparameter

parent string

Optional. Der Name der Document, in der dieser Batch von Chunks erstellt wird. Das übergeordnete Feld in jedem CreateChunkRequest muss mit diesem Wert übereinstimmen. Beispiel: corpora/my-corpus-123/documents/the-doc-abc. Sie hat das Format corpora/{corpora}/documents/{document}.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

<ph type="x-smartling-placeholder">
</ph> Felder
requests[] object (CreateChunkRequest)

Erforderlich. Die Anfragenachrichten, die die zu erstellenden Chunks angeben. In einem Batch können maximal 100 Chunks erstellt werden.

Antworttext

Antwort von chunks.batchCreate mit einer Liste der erstellten Chunks.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

Felder
chunks[] object (Chunk)

Chunk erstellt.

JSON-Darstellung 
{
  "chunks": [
    {
      object (Chunk)
    }
  ]
}

CreateChunkRequest

Anfrage zum Erstellen eines Chunk.

JSON-Darstellung 
{
  "parent": string,
  "chunk": {
    object (Chunk)
  }
}
Felder
parent string

Erforderlich. Der Name von Document, in dem dieses Chunk erstellt wird. Beispiel: corpora/my-corpus-123/documents/the-doc-abc

chunk object (Chunk)

Erforderlich. Die zu erstellende Chunk.

Methode: corpora.documents.chunks.batchUpdate

Batch-Update: Chunk Sek.

Endpunkt

<ph type="x-smartling-placeholder"></ph> Beitrag https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchUpdate
.

Pfadparameter

parent string

Optional. Der Name der Document mit den Chunks, die aktualisiert werden sollen. Das übergeordnete Feld in jedem UpdateChunkRequest muss mit diesem Wert übereinstimmen. Beispiel: corpora/my-corpus-123/documents/the-doc-abc. Sie hat das Format corpora/{corpora}/documents/{document}.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

<ph type="x-smartling-placeholder">
</ph> Felder
requests[] object (UpdateChunkRequest)

Erforderlich. Die Anfragenachrichten, die die zu aktualisierenden Chunks angeben. In einem Batch können maximal 100 Chunks aktualisiert werden.

Antworttext

Antwort von chunks.batchUpdate mit einer Liste aktualisierter Chunks.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

Felder
chunks[] object (Chunk)

Chunk s aktualisiert.

JSON-Darstellung 
{
  "chunks": [
    {
      object (Chunk)
    }
  ]
}

UpdateChunkRequest

Anfrage zum Aktualisieren eines Chunk.

JSON-Darstellung 
{
  "chunk": {
    object (Chunk)
  },
  "updateMask": string
}
Felder
chunk object (Chunk)

Erforderlich. Die zu aktualisierende Chunk.

updateMask string (FieldMask format)

Erforderlich. Die Liste der zu aktualisierenden Felder. Derzeit werden nur customMetadata und data aktualisiert.

Dies ist eine durch Kommas getrennte Liste vollständig qualifizierter Feldnamen. Beispiel: "user.displayName,photo".

Methode: corpora.documents.chunks.batchDelete

Chunk s im Batch löschen.

Endpunkt

<ph type="x-smartling-placeholder"></ph> Beitrag https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchDelete
.

Pfadparameter

parent string

Optional. Der Name der Document mit den zu löschenden Chunks. Das übergeordnete Feld in jedem DeleteChunkRequest muss mit diesem Wert übereinstimmen. Beispiel: corpora/my-corpus-123/documents/the-doc-abc. Sie hat das Format corpora/{corpora}/documents/{document}.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

<ph type="x-smartling-placeholder">
</ph> Felder
requests[] object (DeleteChunkRequest)

Erforderlich. Die Anfragenachrichten, in denen die zu löschenden Chunk angegeben sind.

Antworttext

Wenn der Vorgang erfolgreich ist, ist der Antworttext leer.

DeleteChunkRequest

Anfrage zum Löschen eines Chunk.

JSON-Darstellung 
{
  "name": string
}
Felder
name string

Erforderlich. Der Ressourcenname des zu löschenden Chunk. Beispiel: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk