Corpora

Metode: corpora.create

Membuat Corpus kosong.

Endpoint

posting https://generativelanguage.googleapis.com/v1beta/corpora

Isi permintaan

Isi permintaan memuat instance Corpus.

Kolom
name string

Tidak dapat diubah. ID. Nama resource Corpus. ID (nama tidak termasuk awalan "corpora/") dapat berisi maksimal 40 karakter yang berupa alfanumerik huruf kecil atau tanda hubung (-). ID tidak boleh diawali atau diakhiri dengan tanda hubung. Jika nama kosong saat pembuatan, nama unik akan berasal dari displayName beserta akhiran acak 12 karakter. Contoh: corpora/my-awesome-corpora-123a456b789c

displayName string

Opsional. Nama tampilan yang dapat dibaca manusia untuk Corpus. Panjang nama tampilan tidak boleh lebih dari 512 karakter, termasuk spasi. Contoh: "Dokumen tentang Semantic Retriever"

Isi respons

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

Metode: corpora.query

Melakukan penelusuran semantik di Corpus.

Endpoint

posting https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}:query

Parameter jalur

name string

Wajib. Nama Corpus yang akan dikueri. Contoh: corpora/my-corpus-123 Berbentuk corpora/{corpora}.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Kolom
query string

Wajib. String kueri untuk melakukan penelusuran semantik.

metadataFilters[] object (MetadataFilter)

Opsional. Filter untuk metadata Chunk dan Document. Setiap objek MetadataFilter harus sesuai dengan kunci unik. Beberapa objek MetadataFilter digabungkan dengan "AND" logis.

Contoh kueri di tingkat dokumen: (year >= 2020 OR year < 2010) AND (genre = drama OR genre = action)

Daftar objek MetadataFilter: metadataFilters = [ {key = "document.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}]}, {key = "document.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}]}, {key = "document.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}]}]

Contoh kueri di tingkat bagian untuk rentang nilai numerik: (year > 2015 AND year <= 2020)

Daftar objek MetadataFilter: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = LESS_EQUAL}]}]

Catatan: "AND" untuk kunci yang sama hanya didukung untuk nilai numerik. Nilai string hanya mendukung "OR" untuk kunci yang sama.

resultsCount integer

Opsional. Jumlah maksimum Chunk yang akan ditampilkan. Layanan mungkin menampilkan lebih sedikit Chunk.

Jika tidak ditentukan, maksimal 10 Chunk akan ditampilkan. Jumlah hasil maksimum yang ditentukan adalah 100.

Isi respons

Respons dari corpora.query yang berisi daftar bagian yang relevan.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Kolom
relevantChunks[] object (RelevantChunk)

Bagian yang relevan.

Representasi JSON 
{
  "relevantChunks": [
    {
      object (RelevantChunk)
    }
  ]
}

Metode: corpora.list

Mencantumkan semua Corpora yang dimiliki oleh pengguna.

Endpoint

get https://generativelanguage.googleapis.com/v1beta/corpora

Parameter kueri

pageSize integer

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

Jika tidak ditentukan, maksimal 10 Corpora akan ditampilkan. Batas ukuran maksimum adalah 20 Corpora per halaman.

pageToken string

Opsional. Token halaman, diterima dari panggilan corpora.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 corpora.list harus sesuai dengan panggilan yang menyediakan token halaman.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Respons dari corpora.list yang berisi daftar Corpora yang di-pagination. Hasil diurutkan berdasarkan corpus.create_time menaik.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Kolom
corpora[] object (Corpus)

Korpus yang ditampilkan.

nextPageToken string

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

Representasi JSON 
{
  "corpora": [
    {
      object (Corpus)
    }
  ],
  "nextPageToken": string
}

Metode: corpora.get

Mendapatkan informasi tentang Corpus tertentu.

Endpoint

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

Parameter jalur

name string

Wajib. Nama Corpus. Contoh: corpora/my-corpus-123 Berbentuk corpora/{corpora}.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons memuat instance Corpus.

Metode: corpora.patch

Mengupdate Corpus.

Endpoint

patch https://generativelanguage.googleapis.com/v1beta/{corpus.name=corpora/*}

PATCH https://generativelanguage.googleapis.com/v1beta/{corpus.name=corpora/*}

Parameter jalur

corpus.name string

Tidak dapat diubah. ID. Nama resource Corpus. ID (nama tidak termasuk awalan "korpus/") dapat berisi maksimal 40 karakter yang berupa alfanumerik huruf kecil atau tanda hubung (-). ID tidak boleh diawali atau diakhiri dengan tanda hubung. Jika nama kosong saat pembuatan, nama unik akan berasal dari displayName beserta akhiran acak 12 karakter. Contoh: corpora/my-awesome-corpora-123a456b789c Berbentuk corpora/{corpora}.

Parameter kueri

updateMask string (FieldMask format)

Wajib. Daftar kolom yang akan diperbarui. Saat ini, fitur ini hanya mendukung pembaruan displayName.

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

Isi permintaan

Isi permintaan memuat instance Corpus.

Kolom
displayName string

Opsional. Nama tampilan yang dapat dibaca manusia untuk Corpus. Panjang nama tampilan tidak boleh lebih dari 512 karakter, termasuk spasi. Contoh: "Dokumen tentang Semantic Retriever"

Isi respons

Jika berhasil, isi respons memuat instance Corpus.

Metode: corpora.delete

Menghapus Corpus.

Endpoint

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

Parameter jalur

name string

Wajib. Nama resource Corpus. Contoh: corpora/my-corpus-123 Berbentuk corpora/{corpora}.

Parameter kueri

force boolean

Opsional. Jika disetel ke benar, semua Document dan objek yang terkait dengan Corpus ini juga akan dihapus.

Jika salah (default), error FAILED_PRECONDITION akan ditampilkan jika Corpus berisi Document.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons adalah objek JSON kosong.

Resource REST: corpora.permissions

Resource: Izin

Resource izin memberikan akses kepada pengguna, grup, atau orang lain ke resource PaLM API (misalnya, model yang disesuaikan, korpus).

Peran adalah kumpulan operasi yang diizinkan yang memungkinkan pengguna melakukan tindakan tertentu pada resource PaLM API. Agar tersedia bagi pengguna, grup, atau akun layanan, Anda harus menetapkan peran. Saat menetapkan peran, Anda memberikan izin yang dimiliki oleh peran tersebut.

Ada tiga peran konsentris. Setiap peran adalah superset dari operasi yang diizinkan peran sebelumnya:

  • pembaca dapat menggunakan resource (misalnya, model yang disesuaikan, korpus) untuk inferensi
  • penulis memiliki izin pembaca dan juga dapat mengedit dan membagikan
  • pemilik memiliki izin penulis dan juga dapat menghapus
Kolom
name string

Hanya output. ID. Nama izin. Nama unik akan dibuat saat pembuatan. Contoh: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Hanya output.

granteeType enum (GranteeType)

Opsional. Tidak dapat diubah. Jenis penerima.

emailAddress string

Opsional. Tidak dapat diubah. Alamat email pengguna grup yang dirujuk oleh izin ini. Kolom tidak ditetapkan jika jenis penerima izin adalah SEMUA ORANG.

role enum (Role)

Wajib. Peran yang diberikan oleh izin ini.

Representasi JSON 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}

GranteeType

Menentukan jenis penerima izin ini.

Enum
GRANTEE_TYPE_UNSPECIFIED Nilai default. Nilai ini tidak digunakan.
USER Mewakili pengguna. Jika ditetapkan, Anda harus memberikan emailAddress untuk pengguna.
GROUP Merepresentasikan grup. Jika ditetapkan, Anda harus memberikan emailAddress untuk grup.
EVERYONE Mewakili akses untuk semua orang. Tidak diperlukan informasi tambahan.

Peran

Menentukan peran yang diberikan oleh izin ini.

Enum
ROLE_UNSPECIFIED Nilai default. Nilai ini tidak digunakan.
OWNER Pemilik dapat menggunakan, memperbarui, membagikan, dan menghapus resource.
WRITER Penulis dapat menggunakan, memperbarui, dan membagikan referensi.
READER Pembaca dapat menggunakan resource.

MetadataFilter

Filter yang disediakan pengguna untuk membatasi pengambilan berdasarkan nilai metadata tingkat Chunk atau Document. Contoh (genre = drama ATAU genre = action): key = "document.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}]

Kolom
key string

Wajib. Kunci metadata yang akan difilter.

conditions[] object (Condition)

Wajib. Condition untuk kunci tertentu yang akan memicu filter ini. Beberapa Condition digabungkan dengan OR logis.

Representasi JSON 
{
  "key": string,
  "conditions": [
    {
      object (Condition)
    }
  ]
}

Kondisi

Kondisi filter yang berlaku untuk satu kunci.

Kolom
operation enum (Operator)

Wajib. Operator yang diterapkan ke pasangan nilai kunci tertentu untuk memicu kondisi.

value Union type
Jenis nilai harus konsisten dengan jenis nilai yang ditentukan di kolom untuk kunci yang sesuai. Jika jenis nilai tidak konsisten, hasilnya akan berupa set kosong. Jika CustomMetadata memiliki jenis nilai StringList, kondisi pemfilteran harus menggunakan string_value yang disambungkan dengan operasi INCLUDES/EXCLUDES. Jika tidak, hasilnya juga akan berupa set kosong. value hanya dapat berupa salah satu dari hal berikut:
stringValue string

Nilai string untuk memfilter metadata.

numericValue number

Nilai numerik untuk memfilter metadata.

Representasi JSON 
{
  "operation": enum (Operator),

  // value
  "stringValue": string,
  "numericValue": number
  // Union type
}

Operator

Menentukan operator valid yang dapat diterapkan ke pasangan nilai kunci.

Enum
OPERATOR_UNSPECIFIED Nilai default. Nilai ini tidak digunakan.
LESS Didukung oleh numerik.
LESS_EQUAL Didukung oleh numerik.
EQUAL Didukung oleh numerik & string.
GREATER_EQUAL Didukung oleh numerik.
GREATER Didukung oleh numerik.
NOT_EQUAL Didukung oleh numerik & string.
INCLUDES Hanya didukung oleh string jika jenis nilai CustomMetadata untuk kunci tertentu memiliki stringListValue.
EXCLUDES Hanya didukung oleh string jika jenis nilai CustomMetadata untuk kunci tertentu memiliki stringListValue.

RelevantChunk

Informasi untuk bagian yang relevan dengan kueri.

Kolom
chunkRelevanceScore number

Chunk relevansi dengan kueri.

chunk object (Chunk)

Chunk yang terkait dengan kueri.

Representasi JSON 
{
  "chunkRelevanceScore": number,
  "chunk": {
    object (Chunk)
  }
}

Resource REST: corpora

Resource: Korpus

Corpus adalah kumpulan Document. Sebuah project dapat membuat hingga 5 korpus.

Kolom
name string

Tidak dapat diubah. ID. Nama resource Corpus. ID (nama tidak termasuk awalan "corpora/") dapat berisi maksimal 40 karakter yang berupa alfanumerik huruf kecil atau tanda hubung (-). ID tidak boleh diawali atau diakhiri dengan tanda hubung. Jika nama kosong saat pembuatan, nama unik akan berasal dari displayName beserta akhiran acak 12 karakter. Contoh: corpora/my-awesome-corpora-123a456b789c

displayName string

Opsional. Nama tampilan yang dapat dibaca manusia untuk Corpus. Panjang nama tampilan tidak boleh lebih dari 512 karakter, termasuk spasi. Contoh: "Dokumen tentang Semantic Retriever"

createTime string (Timestamp format)

Hanya output. Stempel Waktu saat Corpus dibuat.

Menggunakan RFC 3339, dengan output yang dihasilkan akan selalu dinormalisasi Z dan menggunakan digit pecahan 0, 3, 6, atau 9. 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 Corpus terakhir diperbarui.

Menggunakan RFC 3339, dengan output yang dihasilkan akan selalu dinormalisasi Z dan menggunakan digit pecahan 0, 3, 6, atau 9. 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".

Representasi JSON 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string
}