Chunks

Resource REST: corpora.documents.chunks

Referensi: Bagian

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

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

Tidak dapat diubah. ID. Nama resource Chunk. ID (nama yang tidak mencakup awalan "corpora/*/documents/*/chunks/") dapat berisi hingga 40 karakter yang merupakan alfanumerik dalam huruf kecil atau tanda hubung (-). ID tidak boleh diawali atau diakhiri dengan tanda hubung. Jika nama tersebut 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 potongan adalah 2043.

customMetadata[] object (CustomMetadata)

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

createTime string (Timestamp format)

Hanya output. Stempel waktu saat Chunk dibuat.

Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

updateTime string (Timestamp format)

Hanya output. Stempel waktu saat Chunk terakhir diperbarui.

Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

state enum (State)

Hanya output. Status Chunk saat ini.

ChunkData

Data yang diekstrak yang mewakili konten Chunk.

Representasi JSON 
{

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

Kolom union data.

data hanya dapat berupa salah satu dari yang berikut:

stringValue string

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

Negara Bagian

Status untuk siklus proses Chunk.

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

Metode: corpora.documents.chunks.create

Membuat Chunk.

Endpoint

posting 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 Formatnya adalah corpora/{corpora}/documents/{document}.

Isi permintaan

Isi permintaan memuat instance Chunk.

Isi respons

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

Metode: corpora.documents.chunks.list

Mencantumkan semua Chunk dalam Document.

Endpoint

dapatkan 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 Formatnya adalah corpora/{corpora}/documents/{document}.

Parameter kueri

pageSize integer

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

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

pageToken string

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

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

Saat memberi nomor halaman, semua parameter lain yang diberikan ke chunks.list harus cocok dengan panggilan yang menyediakan token halaman.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

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

Jika berhasil, isi respons memuat data dengan struktur berikut:

Bidang
chunks[] object (Chunk)

Chunk yang ditampilkan.

nextPageToken string

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

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

Metode: corpora.documents.chunks.get

Mendapatkan informasi tentang Chunk tertentu.

Endpoint

dapatkan 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 Formatnya 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

tambalan 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 yang tidak mencakup awalan "corpora/*/documents/*/chunks/") dapat berisi hingga 40 karakter yang merupakan alfanumerik dalam huruf kecil atau tanda hubung (-). ID tidak boleh diawali atau diakhiri dengan tanda hubung. Jika nama tersebut kosong saat dibuat, ID unik 12 karakter acak akan dibuat. Contoh: corpora/{corpus_id}/documents/{document_id}/chunks/123a456b789c Formatnya adalah corpora/{corpora}/documents/{document}/chunks/{chunk}.

Parameter kueri

updateMask string (FieldMask format)

Wajib. Daftar kolom yang akan diperbarui. Saat ini, metode ini hanya mendukung update customMetadata dan data.

Ini adalah daftar yang dipisahkan koma yang berisi nama kolom yang sepenuhnya memenuhi syarat. Contoh: "user.displayName,photo".

Isi permintaan

Isi permintaan memuat instance Chunk.

Isi respons

Jika berhasil, isi respons memuat instance Chunk.

Metode: corpora.documents.chunks.delete

Menghapus Chunk.

Endpoint

hapus 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 Formatnya adalah corpora/{corpora}/documents/{document}/chunks/{chunk}.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons akan kosong.

Metode: corpora.documents.chunks.batchCreate

Membuat batch Chunk.

Endpoint

posting 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 Formatnya adalah corpora/{corpora}/documents/{document}.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Bidang
requests[] object (CreateChunkRequest)

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

Isi respons

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

Jika berhasil, isi respons memuat data dengan struktur berikut:

Bidang
chunks[] object (Chunk)

Chunk dibuat.

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

CreateChunkRequest

Permintaan untuk membuat Chunk.

Representasi JSON 
{
  "parent": string,
  "chunk": {
    object (Chunk)
  }
}
Bidang
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.

Metode: corpora.documents.chunks.menggantikan

Update batch Chunk.

Endpoint

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

Parameter jalur

parent string

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

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Bidang
requests[] object (UpdateChunkRequest)

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

Isi respons

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

Jika berhasil, isi respons memuat data dengan struktur berikut:

Bidang
chunks[] object (Chunk)

Chunk diperbarui.

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

UpdateChunkRequest

Permintaan untuk mengupdate Chunk.

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

Wajib. Chunk yang akan diupdate.

updateMask string (FieldMask format)

Wajib. Daftar kolom yang akan diperbarui. Saat ini, metode ini hanya mendukung update customMetadata dan data.

Ini adalah daftar yang dipisahkan koma yang berisi nama kolom yang sepenuhnya memenuhi syarat. Contoh: "user.displayName,photo".

Metode: corpora.documents.chunks.batchDelete

Menghapus batch Chunk.

Endpoint

posting 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 Formatnya adalah corpora/{corpora}/documents/{document}.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Bidang
requests[] object (DeleteChunkRequest)

Wajib. Pesan permintaan yang menentukan Chunk yang akan dihapus.

Isi respons

Jika berhasil, isi respons akan kosong.

DeleteChunkRequest

Permintaan untuk menghapus Chunk.

Representasi JSON 
{
  "name": string
}
Bidang
name string

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