Chunks

Risorsa REST: corpora.documents.chunks

Risorsa: unità

Un Chunk è una sottoparte di Document che viene trattata come un'unità indipendente ai fini della rappresentazione vettoriale e dell'archiviazione. Un Corpus può avere al massimo 1 milione di Chunk.

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

Immutabile. Identificatore. Il nome della risorsa Chunk. L'ID (nome senza il prefisso "corpora/*/documents/*/chunks/") può contenere fino a 40 caratteri alfanumerici minuscoli o trattini (-). L'ID non può iniziare o terminare con un trattino. Se il nome è vuoto al momento della creazione, verrà generato un ID univoco casuale di 12 caratteri. Esempio: corpora/{corpus_id}/documents/{document_id}/chunks/123a456b789c

data object (ChunkData)

Obbligatorio. I contenuti per Chunk, ad esempio la stringa di testo. Il numero massimo di token per blocco è 2043.

customMetadata[] object (CustomMetadata)

(Facoltativo) Metadati personalizzati forniti dall'utente e archiviati come coppie chiave/valore. Il numero massimo di CustomMetadata per blocco è 20.

createTime string (Timestamp format)

Solo output. Timestamp della creazione di Chunk.

Un timestamp nel formato RFC3339 UTC "Zulu" con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

updateTime string (Timestamp format)

Solo output. Timestamp dell'ultimo aggiornamento di Chunk.

Un timestamp nel formato RFC3339 UTC "Zulu" con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

state enum (State)

Solo output. Stato attuale di Chunk.

ChunkData

Dati estratti che rappresentano i contenuti di Chunk.

Rappresentazione JSON 
{

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

Campo unione data.

data può essere solo uno dei seguenti:

stringValue string

I contenuti di Chunk come stringa. Il numero massimo di token per blocco è 2043.

Stato

Stati per il ciclo di vita di un Chunk.

Enum
STATE_UNSPECIFIED Il valore predefinito. Questo valore viene utilizzato se lo stato viene omesso.
STATE_PENDING_PROCESSING Chunk è in fase di elaborazione (incorporamento e archiviazione vettoriale).
STATE_ACTIVE Chunk viene elaborato ed è disponibile per l'esecuzione di query.
STATE_FAILED Elaborazione di Chunk non riuscita.

Metodo: corpora.documents.chunks.create

Crea un Chunk.

Endpoint

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

Parametri del percorso

parent string

Obbligatorio. Il nome del Document in cui verrà creato questo Chunk. Esempio: corpora/my-corpus-123/documents/the-doc-abc Il formato è corpora/{corpora}/documents/{document}.

Corpo della richiesta

Il corpo della richiesta contiene un'istanza di Chunk.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di Chunk appena creata.

Metodo: corpora.documents.chunks.list

Elenca tutti i valori Chunk in un Document.

Endpoint

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

Parametri del percorso

parent string

Obbligatorio. Il nome dell'evento "Document" che contiene Chunk. Esempio: corpora/my-corpus-123/documents/the-doc-abc Il formato è corpora/{corpora}/documents/{document}.

Parametri di query

pageSize integer

(Facoltativo) Il numero massimo di Chunk da restituire (per pagina). Il servizio potrebbe restituire meno Chunk secondi.

Se non specificato, verranno restituiti al massimo 10 Chunk. Le dimensioni massime consentite sono di 100 Chunk per pagina.

pageToken string

(Facoltativo) Un token di pagina, ricevuto da una precedente chiamata a chunks.list.

Fornisci il valore nextPageToken restituito nella risposta come argomento per la richiesta successiva di recupero della pagina successiva.

Durante l'impaginazione, tutti gli altri parametri forniti a chunks.list devono corrispondere alla chiamata che ha fornito il token della pagina.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Risposta da chunks.list contenente un elenco impaginato di Chunk. I Chunk sono ordinati in ordine crescente per chunk.create_time.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Campi
chunks[] object (Chunk)

I valori Chunk restituiti.

nextPageToken string

Un token, che può essere inviato come pageToken per recuperare la pagina successiva. Se questo campo viene omesso, non ci sono altre pagine.

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

Metodo: corpora.documents.chunks.get

Riceve informazioni su uno specifico Chunk.

Endpoint

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

Parametri del percorso

name string

Obbligatorio. Il nome di Chunk da recuperare. Esempio: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk Il formato è corpora/{corpora}/documents/{document}/chunks/{chunk}.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di Chunk.

Metodo: corpora.documents.chunks.patch

Aggiorna un Chunk.

Endpoint

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

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

Parametri del percorso

chunk.name string

Immutabile. Identificatore. Il nome della risorsa Chunk. L'ID (nome senza il prefisso "corpora/*/documents/*/chunks/") può contenere fino a 40 caratteri alfanumerici minuscoli o trattini (-). L'ID non può iniziare o terminare con un trattino. Se il nome è vuoto al momento della creazione, verrà generato un ID univoco casuale di 12 caratteri. Esempio: corpora/{corpus_id}/documents/{document_id}/chunks/123a456b789c Il formato è corpora/{corpora}/documents/{document}/chunks/{chunk}.

Parametri di query

updateMask string (FieldMask format)

Obbligatorio. L'elenco dei campi da aggiornare. Al momento è supportato solo l'aggiornamento di customMetadata e data.

Si tratta di un elenco di nomi completi dei campi separati da virgole. Esempio: "user.displayName,photo".

Corpo della richiesta

Il corpo della richiesta contiene un'istanza di Chunk.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di Chunk.

Metodo: corpora.documents.chunks.delete

Elimina un Chunk.

Endpoint

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

Parametri del percorso

name string

Obbligatorio. Il nome della risorsa di Chunk da eliminare. Esempio: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk Il formato è corpora/{corpora}/documents/{document}/chunks/{chunk}.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

In caso di esito positivo, il corpo della risposta è vuoto.

Metodo: corpora.documents.chunks.batchCreate

Creazione in gruppo di Chunk.

Endpoint

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

Parametri del percorso

parent string

(Facoltativo) Il nome di Document in cui verrà creato questo batch di Chunk. Il campo principale in ogni CreateChunkRequest deve corrispondere a questo valore. Esempio: corpora/my-corpus-123/documents/the-doc-abc Il formato è corpora/{corpora}/documents/{document}.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Campi
requests[] object (CreateChunkRequest)

Obbligatorio. I messaggi di richiesta che specificano i Chunk da creare. È possibile creare un massimo di 100 Chunk alla volta.

Corpo della risposta

Risposta da chunks.batchCreate contenente un elenco di Chunk creati.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Campi
chunks[] object (Chunk)

Chunk creati.

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

CreateChunkRequest

Richiedi la creazione di un Chunk.

Rappresentazione JSON 
{
  "parent": string,
  "chunk": {
    object (Chunk)
  }
}
Campi
parent string

Obbligatorio. Il nome del Document in cui verrà creato questo Chunk. Esempio: corpora/my-corpus-123/documents/the-doc-abc

chunk object (Chunk)

Obbligatorio. Chunk da creare.

Metodo: corpora.documents.chunks.batchUpdate

Aggiornamenti batch di Chunk sec.

Endpoint

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

Parametri del percorso

parent string

(Facoltativo) Il nome dell'evento "Document" che contiene i Chunk da aggiornare. Il campo principale in ogni UpdateChunkRequest deve corrispondere a questo valore. Esempio: corpora/my-corpus-123/documents/the-doc-abc Il formato è corpora/{corpora}/documents/{document}.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Campi
requests[] object (UpdateChunkRequest)

Obbligatorio. I messaggi di richiesta che specificano i Chunk da aggiornare. È possibile aggiornare un massimo di 100 Chunk alla volta.

Corpo della risposta

Risposta da chunks.batchUpdate contenente un elenco di Chunk aggiornati.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Campi
chunks[] object (Chunk)

Chunk aggiornati.

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

UpdateChunkRequest

Richiedi l'aggiornamento di un Chunk.

Rappresentazione JSON 
{
  "chunk": {
    object (Chunk)
  },
  "updateMask": string
}
Campi
chunk object (Chunk)

Obbligatorio. Chunk da aggiornare.

updateMask string (FieldMask format)

Obbligatorio. L'elenco dei campi da aggiornare. Al momento è supportato solo l'aggiornamento di customMetadata e data.

Si tratta di un elenco di nomi completi dei campi separati da virgole. Esempio: "user.displayName,photo".

Metodo: corpora.documents.chunks.batchDelete

Elimina Chunk in blocco.

Endpoint

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

Parametri del percorso

parent string

(Facoltativo) Il nome dell'evento "Document" che contiene i Chunk da eliminare. Il campo principale in ogni DeleteChunkRequest deve corrispondere a questo valore. Esempio: corpora/my-corpus-123/documents/the-doc-abc Il formato è corpora/{corpora}/documents/{document}.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Campi
requests[] object (DeleteChunkRequest)

Obbligatorio. I messaggi di richiesta che specificano i Chunk da eliminare.

Corpo della risposta

In caso di esito positivo, il corpo della risposta è vuoto.

DeleteChunkRequest

Richiedi l'eliminazione di un Chunk.

Rappresentazione JSON 
{
  "name": string
}
Campi
name string

Obbligatorio. Il nome della risorsa di Chunk da eliminare. Esempio: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk