Chunks

Metode: corpora.documents.chunks.create

Membuat Chunk.

Endpoint

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

Parameter jalur

parent string

Wajib. Nama Document tempat Chunk ini akan dibuat. Contoh: corpora/my-corpus-123/documents/the-doc-abc Bentuknya adalah corpora/{corpora}/documents/{document}.

Isi permintaan

Isi permintaan memuat instance Chunk.

Kolom
name string

Tidak dapat diubah. ID. Nama resource Chunk. ID (nama tanpa awalan "corpora/*/documents/*/chunks/") dapat berisi hingga 40 karakter yang berupa alfanumerik huruf kecil atau tanda pisah (-). ID tidak boleh diawali atau diakhiri dengan tanda pisah. Jika nama kosong saat dibuat, ID unik 12 karakter acak akan dibuat. Contoh: corpora/{corpus_id}/documents/{document_id}/chunks/123a456b789c

data object (ChunkData)

Wajib. Konten untuk Chunk, seperti string teks. Jumlah maksimum token per bagian adalah 2043.

customMetadata[] object (CustomMetadata)

Opsional. Metadata kustom yang disediakan pengguna disimpan sebagai key-value pair. Jumlah maksimum CustomMetadata per bagian adalah 20.

Isi respons

Jika berhasil, isi respons memuat instance Chunk yang baru dibuat.

Metode: corpora.documents.chunks.list

Mencantumkan semua Chunk dalam Document.

Endpoint

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

Parameter jalur

parent string

Wajib. Nama Document yang berisi Chunk. Contoh: corpora/my-corpus-123/documents/the-doc-abc Bentuknya adalah corpora/{corpora}/documents/{document}.

Parameter kueri

pageSize integer

Opsional. Jumlah maksimum Chunk yang akan ditampilkan (per halaman). Layanan mungkin menampilkan lebih sedikit Chunk.

Jika tidak ditentukan, paling banyak 10 Chunk akan ditampilkan. Batas ukuran maksimum adalah 100 Chunk per halaman.

pageToken string

Opsional. Token halaman, diterima dari panggilan chunks.list sebelumnya.

Berikan nextPageToken yang ditampilkan dalam respons sebagai argumen ke permintaan berikutnya untuk mengambil halaman berikutnya.

Saat melakukan penomoran halaman, semua parameter lain yang diberikan untuk chunks.list harus sesuai dengan panggilan yang menyediakan token halaman.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Respons dari chunks.list yang berisi daftar Chunk bernomor halaman. Chunk diurutkan berdasarkan chunk.create_time menaik.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Kolom
chunks[] object (Chunk)

Chunk yang ditampilkan.

nextPageToken string

Token yang dapat dikirim sebagai pageToken untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, tidak ada lagi halaman.

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

Metode: corpora.documents.chunks.get

Mendapatkan informasi tentang Chunk tertentu.

Endpoint

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

Parameter jalur

name string

Wajib. Nama Chunk yang akan diambil. Contoh: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk Bentuknya adalah corpora/{corpora}/documents/{document}/chunks/{chunk}.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons memuat instance Chunk.

Metode: corpora.documents.chunks.patch

Memperbarui Chunk.

Endpoint

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

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

Parameter jalur

chunk.name string

Tidak dapat diubah. ID. Nama resource Chunk. ID (nama tanpa awalan "corpora/*/documents/*/chunks/") dapat berisi hingga 40 karakter yang berupa alfanumerik huruf kecil atau tanda pisah (-). ID tidak boleh diawali atau diakhiri dengan tanda pisah. Jika nama kosong saat dibuat, ID unik 12 karakter acak akan dibuat. Contoh: corpora/{corpus_id}/documents/{document_id}/chunks/123a456b789c Bentuknya adalah corpora/{corpora}/documents/{document}/chunks/{chunk}.

Parameter kueri

updateMask string (FieldMask format)

Wajib. Daftar kolom yang akan diperbarui. Saat ini, fitur ini hanya mendukung pembaruan customMetadata dan data.

Ini adalah comma-separated list berisi nama kolom yang sepenuhnya memenuhi syarat. Contoh: "user.displayName,photo".

Isi permintaan

Isi permintaan memuat instance Chunk.

Kolom
data object (ChunkData)

Wajib. Konten untuk Chunk, seperti string teks. Jumlah maksimum token per bagian adalah 2043.

customMetadata[] object (CustomMetadata)

Opsional. Metadata kustom yang disediakan pengguna disimpan sebagai key-value pair. Jumlah maksimum CustomMetadata per bagian adalah 20.

Isi respons

Jika berhasil, isi respons memuat instance Chunk.

Metode: corpora.documents.chunks.delete

Menghapus Chunk.

Endpoint

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

Parameter jalur

name string

Wajib. Nama resource Chunk yang akan dihapus. Contoh: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk Bentuknya adalah corpora/{corpora}/documents/{document}/chunks/{chunk}.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons adalah objek JSON kosong.

Metode: corpora.documents.chunks.batchCreate

Membuat Chunk secara batch.

Endpoint

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

Parameter jalur

parent string

Opsional. Nama Document tempat batch Chunk ini akan dibuat. Kolom induk di setiap CreateChunkRequest harus cocok dengan nilai ini. Contoh: corpora/my-corpus-123/documents/the-doc-abc Bentuknya adalah corpora/{corpora}/documents/{document}.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Kolom
requests[] object (CreateChunkRequest)

Wajib. Pesan permintaan yang menentukan Chunk yang akan dibuat. Maksimum 100 Chunk dapat dibuat dalam batch.

Isi respons

Respons dari chunks.batchCreate yang berisi daftar Chunk yang dibuat.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Kolom
chunks[] object (Chunk)

Chunk dibuat.

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

CreateChunkRequest

Permintaan untuk membuat Chunk.

Kolom
parent string

Wajib. Nama Document tempat Chunk ini akan dibuat. Contoh: corpora/my-corpus-123/documents/the-doc-abc

chunk object (Chunk)

Wajib. Chunk yang akan dibuat.

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

Metode: corpora.documents.chunks.batchUpdate

Memperbarui Chunk secara berkelompok.

Endpoint

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

Parameter jalur

parent string

Opsional. Nama Document yang berisi Chunk yang akan diupdate. Kolom induk di setiap UpdateChunkRequest harus cocok dengan nilai ini. Contoh: corpora/my-corpus-123/documents/the-doc-abc Bentuknya adalah corpora/{corpora}/documents/{document}.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Kolom
requests[] object (UpdateChunkRequest)

Wajib. Pesan permintaan yang menentukan Chunk yang akan diperbarui. Maksimum 100 Chunk dapat diperbarui dalam batch.

Isi respons

Respons dari chunks.batchUpdate yang berisi daftar Chunk yang diperbarui.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Kolom
chunks[] object (Chunk)

Chunk diperbarui.

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

UpdateChunkRequest

Permintaan untuk memperbarui Chunk.

Kolom
chunk object (Chunk)

Wajib. Chunk yang akan diupdate.

updateMask string (FieldMask format)

Wajib. Daftar kolom yang akan diperbarui. Saat ini, fitur ini hanya mendukung pembaruan customMetadata dan data.

Ini adalah comma-separated list berisi nama kolom yang sepenuhnya memenuhi syarat. Contoh: "user.displayName,photo".

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

Metode: corpora.documents.chunks.batchDelete

Menghapus Chunk secara batch.

Endpoint

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

Parameter jalur

parent string

Opsional. Nama Document yang berisi Chunk yang akan dihapus. Kolom induk di setiap DeleteChunkRequest harus cocok dengan nilai ini. Contoh: corpora/my-corpus-123/documents/the-doc-abc Bentuknya adalah corpora/{corpora}/documents/{document}.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Kolom
requests[] object (DeleteChunkRequest)

Wajib. Pesan permintaan yang menentukan Chunk yang akan dihapus.

Isi respons

Jika berhasil, isi respons adalah objek JSON kosong.

DeleteChunkRequest

Permintaan untuk menghapus Chunk.

Kolom
name string

Wajib. Nama resource Chunk yang akan dihapus. Contoh: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk

Representasi JSON 
{
  "name": string
}

REST Resource: corpora.documents.chunks

Resource: Chunk

Chunk adalah subbagian dari Document yang diperlakukan sebagai unit independen untuk tujuan representasi dan penyimpanan vektor. Corpus dapat memiliki maksimum 1 juta Chunk.

Kolom
name string

Tidak dapat diubah. ID. Nama resource Chunk. ID (nama tanpa awalan "corpora/*/documents/*/chunks/") dapat berisi hingga 40 karakter yang berupa alfanumerik huruf kecil atau tanda pisah (-). ID tidak boleh diawali atau diakhiri dengan tanda pisah. Jika nama kosong saat dibuat, ID unik 12 karakter acak akan dibuat. Contoh: corpora/{corpus_id}/documents/{document_id}/chunks/123a456b789c

data object (ChunkData)

Wajib. Konten untuk Chunk, seperti string teks. Jumlah maksimum token per bagian adalah 2043.

customMetadata[] object (CustomMetadata)

Opsional. Metadata kustom yang disediakan pengguna disimpan sebagai key-value pair. Jumlah maksimum CustomMetadata per bagian adalah 20.

createTime string (Timestamp format)

Hanya output. Stempel waktu saat Chunk dibuat.

Menggunakan RFC 3339, dengan output yang dihasilkan akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".

updateTime string (Timestamp format)

Hanya output. Stempel Waktu saat Chunk terakhir diperbarui.

Menggunakan RFC 3339, dengan output yang dihasilkan akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".

state enum (State)

Hanya output. Status Chunk saat ini.

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

ChunkData

Data yang diekstrak yang merepresentasikan konten Chunk.

Kolom
data Union type
data hanya dapat berupa salah satu dari hal berikut:
stringValue string

Konten Chunk sebagai string. Jumlah maksimum token per bagian adalah 2043.

Representasi JSON 
{

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

Negara Bagian

Status untuk siklus proses Chunk.

Enum
STATE_UNSPECIFIED Nilai default. Nilai ini digunakan jika status tidak ada.
STATE_PENDING_PROCESSING Chunk sedang diproses (penyimpanan vektor dan embedding).
STATE_ACTIVE Chunk diproses dan tersedia untuk kueri.
STATE_FAILED Chunk gagal diproses.