Chunks

Metodo: corpora.documents.chunks.create

Crea un Chunk.

Endpoint

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

Parametri del percorso

parent string

Obbligatorio. Il nome di Document in cui verrà creato questo Chunk. Esempio: corpora/my-corpus-123/documents/the-doc-abc assume la forma corpora/{corpora}/documents/{document}.

Corpo della richiesta

Il corpo della richiesta contiene un'istanza di Chunk.

Campi
name string

Immutabile. Identificatore. Il nome della risorsa Chunk. L'ID (nome escluso 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 archiviati come coppie chiave-valore. Il numero massimo di CustomMetadata per blocco è 20.

Corpo della risposta

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

Metodo: corpora.documents.chunks.list

Elenca tutti i Chunk in un Document.

Endpoint

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

Parametri del percorso

parent string

Obbligatorio. Il nome di Document contenente Chunk. Esempio: corpora/my-corpus-123/documents/the-doc-abc assume la forma 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.

Se non specificato, verranno restituiti al massimo 10 Chunk. Il limite massimo di dimensioni è di 100 Chunk per pagina.

pageToken string

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

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

Durante la paginazione, tutti gli altri parametri forniti a chunks.list devono corrispondere alla chiamata che ha fornito il token di pagina.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Risposta da chunks.list contenente un elenco paginato di Chunk. I Chunk sono ordinati in base al chunk.create_time in ordine crescente.

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

Campi
chunks[] object (Chunk)

Chunk restituito.

nextPageToken string

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

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

Metodo: corpora.documents.chunks.get

Recupera informazioni su un Chunk specifico.

Endpoint

get 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 assume la forma 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 escluso 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 assume la forma corpora/{corpora}/documents/{document}/chunks/{chunk}.

Parametri di query

updateMask string (FieldMask format)

Obbligatorio. L'elenco dei campi da aggiornare. Al momento, questa funzionalità supporta solo l'aggiornamento di customMetadata e data.

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

Corpo della richiesta

Il corpo della richiesta contiene un'istanza di Chunk.

Campi
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 archiviati come coppie chiave-valore. Il numero massimo di CustomMetadata per blocco è 20.

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

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

Parametri del percorso

name string

Obbligatorio. Il nome della risorsa Chunk da eliminare. Esempio: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk assume la forma 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 è un oggetto JSON vuoto.

Metodo: corpora.documents.chunks.batchCreate

Creazione batch di Chunk.

Endpoint

post 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 di ogni CreateChunkRequest deve corrispondere a questo valore. Esempio: corpora/my-corpus-123/documents/the-doc-abc assume la forma 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 in un batch.

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

Richiesta di creazione di un Chunk.

Campi
parent string

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

chunk object (Chunk)

Obbligatorio. Chunk da creare.

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

Metodo: corpora.documents.chunks.batchUpdate

Aggiornamento batch di Chunk.

Endpoint

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

Parametri del percorso

parent string

(Facoltativo) Il nome di Document contenente gli Chunk da aggiornare. Il campo principale di ogni UpdateChunkRequest deve corrispondere a questo valore. Esempio: corpora/my-corpus-123/documents/the-doc-abc assume la forma 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 gli Chunk da aggiornare. È possibile aggiornare un massimo di 100 Chunk in un batch.

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

Richiesta di aggiornamento di un Chunk.

Campi
chunk object (Chunk)

Obbligatorio. Chunk da aggiornare.

updateMask string (FieldMask format)

Obbligatorio. L'elenco dei campi da aggiornare. Al momento, questa funzionalità supporta solo l'aggiornamento di customMetadata e data.

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

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

Metodo: corpora.documents.chunks.batchDelete

Elimina in batch Chunk.

Endpoint

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

Parametri del percorso

parent string

(Facoltativo) Il nome di Document contenente i Chunk da eliminare. Il campo principale di ogni DeleteChunkRequest deve corrispondere a questo valore. Esempio: corpora/my-corpus-123/documents/the-doc-abc assume la forma 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 è un oggetto JSON vuoto.

DeleteChunkRequest

Richiedi l'eliminazione di un Chunk.

Campi
name string

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

Rappresentazione JSON 
{
  "name": string
}

Risorsa REST: corpora.documents.chunks

Risorsa: Chunk

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

Campi
name string

Immutabile. Identificatore. Il nome della risorsa Chunk. L'ID (nome escluso 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 archiviati come coppie chiave-valore. Il numero massimo di CustomMetadata per blocco è 20.

createTime string (Timestamp format)

Solo output. Il timestamp della creazione di Chunk.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

updateTime string (Timestamp format)

Solo output. Il timestamp dell'ultimo aggiornamento di Chunk.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

state enum (State)

Solo output. Stato attuale di Chunk.

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

ChunkData

Dati estratti che rappresentano i contenuti Chunk.

Campi
data Union type
data può essere solo uno dei seguenti:
stringValue string

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

Rappresentazione JSON 
{

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

Stato

Stati del 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 (embedding e archiviazione dei vettori).
STATE_ACTIVE Chunk viene elaborato ed è disponibile per le query.
STATE_FAILED Elaborazione di Chunk non riuscita.