Chunks

Methode: corpora.documents.chunks.create

Erstellt einen Chunk.

Endpunkt

post https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks >
>

Pfadparameter

parent string

Erforderlich. Der Name des 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.

Felder
name string

Nicht veränderbar. ID. Der Name der Chunk-Ressource. Die ID (Name ohne das Präfix „corpora/*/documents/*/chunks/“) darf bis zu 40 Zeichen enthalten, die alphanumerisch in Kleinschreibung oder Bindestriche (-) sein dürfen. 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 die 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 werden. Die maximale Anzahl von CustomMetadata pro Chunk beträgt 20.

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

get https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks >
>

Pfadparameter

parent string

Erforderlich. Der Name der Document, die Chunk 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 der zurückzugebenden Chunks (pro Seite). Der Dienst gibt möglicherweise weniger Chunk zurück.

Wenn nicht angegeben, werden maximal 10 Chunk zurückgegeben. Die maximale Größe beträgt 100 Chunk 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 werden in aufsteigender Reihenfolge nach 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, gibt es keine weiteren Seiten.

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

Methode: corpora.documents.chunks.get

Ruft Informationen zu einem bestimmten Chunk ab.

Endpunkt

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

Pfadparameter

name string

Erforderlich. Der Name des abzurufenden 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 abgeschlossen wurde, enthält der Antworttext eine Instanz von Chunk.

Methode: corpora.documents.chunks.patch

Aktualisiert ein Chunk.

Endpunkt

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. ID. Der Name der Chunk-Ressource. Die ID (Name ohne das Präfix „corpora/*/documents/*/chunks/“) darf bis zu 40 Zeichen enthalten, die alphanumerisch in Kleinschreibung oder Bindestriche (-) sein dürfen. 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 Aktualisierungen von customMetadata und data unterstützt.

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

Anfragetext

Der Anfragetext enthält eine Instanz von Chunk.

Felder
data object (ChunkData)

Erforderlich. Der Inhalt für die 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 werden. Die maximale Anzahl von CustomMetadata pro Chunk beträgt 20.

Antworttext

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

Methode: corpora.documents.chunks.delete

Löscht einen Chunk.

Endpunkt

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

Pfadparameter

name string

Erforderlich. Der Ressourcenname der 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 abgeschlossen wurde, ist der Antworttext ein leeres JSON-Objekt.

Methode: corpora.documents.chunks.batchCreate

Chunks im Batch erstellen.

Endpunkt

post https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchCreate >
>

Pfadparameter

parent string

Optional. Der Name des Document, in dem diese Gruppe 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:

Felder
requests[] object (CreateChunkRequest)

Erforderlich. Die Anfragenachrichten, in denen die zu erstellenden Chunk angegeben sind. 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)

Chunks erstellt.

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

CreateChunkRequest

Anfrage zum Erstellen eines Chunk

Felder
parent string

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

chunk object (Chunk)

Erforderlich. Die zu erstellende Chunk.

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

Methode: corpora.documents.chunks.batchUpdate

Batch-Update von Chunk.

Endpunkt

post https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchUpdate >
>

Pfadparameter

parent string

Optional. Der Name des Document, der die zu aktualisierenden Chunks enthält. 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:

Felder
requests[] object (UpdateChunkRequest)

Erforderlich. Die Anfragenachrichten, in denen die zu aktualisierenden Chunk angegeben sind. Es können maximal 100 Chunks in einem Batch 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 wurde aktualisiert.

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

UpdateChunkRequest

Anfrage zur Aktualisierung einer Chunk

Felder
chunk object (Chunk)

Erforderlich. Die zu aktualisierende Chunk.

updateMask string (FieldMask format)

Erforderlich. Die Liste der zu aktualisierenden Felder. Derzeit werden nur Aktualisierungen von customMetadata und data unterstützt.

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

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

Methode: corpora.documents.chunks.batchDelete

Chunks im Batch löschen

Endpunkt

post https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchDelete >
>

Pfadparameter

parent string

Optional. Der Name der Document, die die zu löschenden Chunks enthält. 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:

Felder
requests[] object (DeleteChunkRequest)

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

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, ist der Antworttext ein leeres JSON-Objekt.

DeleteChunkRequest

Anfrage zum Löschen einer Dienstleistung (Chunk)

Felder
name string

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

JSON-Darstellung 
{
  "name": string
}

REST-Ressource: corpora.documents.chunks

Ressource: Chunk

Ein Chunk ist ein Unterabschnitt eines Document, der für die Vektordarstellung und ‑speicherung als unabhängige Einheit behandelt wird. Ein Corpus kann maximal 1 Million Chunk enthalten.

Felder
name string

Nicht veränderbar. ID. Der Name der Chunk-Ressource. Die ID (Name ohne das Präfix „corpora/*/documents/*/chunks/“) darf bis zu 40 Zeichen enthalten, die alphanumerisch in Kleinschreibung oder Bindestriche (-) sein dürfen. 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 die 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 werden. Die maximale Anzahl von CustomMetadata pro Chunk beträgt 20.

createTime string (Timestamp format)

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

Verwendet RFC 3339. Die generierte Ausgabe wird immer Z-normalisiert und verwendet 0, 3, 6 oder 9 Nachkommastellen. 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. Der Zeitstempel der letzten Aktualisierung von Chunk.

Verwendet RFC 3339. Die generierte Ausgabe wird immer Z-normalisiert und verwendet 0, 3, 6 oder 9 Nachkommastellen. 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".

state enum (State)

Nur Ausgabe. Aktueller Status von Chunk.

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

ChunkData

Extrahierte Daten, die den Inhalt von Chunk darstellen.

Felder
data Union type
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 Chunk beträgt 2.043.

JSON-Darstellung 
{

  // data
  "stringValue": string
  // Union type
}

Status

Status für den Lebenszyklus einer Chunk.

Enums
STATE_UNSPECIFIED Der Standardwert. Dieser Wert wird verwendet, wenn der Bundesstaat weggelassen wird.
STATE_PENDING_PROCESSING Chunk wird verarbeitet (Einbettung und Vektorspeicherung).
STATE_ACTIVE Chunk wird verarbeitet und kann abgefragt werden.
STATE_FAILED Bei der Verarbeitung von Chunk ist ein Fehler aufgetreten.