Corpora

Resource REST: corpora

Sumber daya: Korpus

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

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

Tidak dapat diubah. ID. Nama resource Corpus. ID (nama yang 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 tersebut kosong saat dibuat, nama unik akan diambil dari displayName bersama dengan akhiran acak 12 karakter. Contoh: corpora/my-awesome-corpora-123a456b789c

displayName string

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

createTime string (Timestamp format)

Hanya output. Stempel waktu saat Corpus 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 Corpus 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".

Metode: corpora.create

Membuat Corpus kosong.

Endpoint

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

Isi permintaan

Isi permintaan memuat instance Corpus.

Isi respons

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

Metode: corpora.list

Menampilkan daftar semua Corpora yang dimiliki oleh pengguna.

Endpoint

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

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Respons dari corpora.list yang berisi daftar Corpora yang diberi nomor halaman. Hasilnya diurutkan dengan corpus.create_time menaik.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Bidang
corpora[] object (Corpus)

Korpora yang dikembalikan.

nextPageToken string

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

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

Metode: corpora.query

Melakukan penelusuran semantik melalui 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 Formatnya adalah corpora/{corpora}.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Bidang
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 pada tingkat dokumen: (tahun >= 2020 ATAU tahun < 2010) AND (genre = drama ATAU genre = aksi)

Daftar objek MetadataFilter: metadataFilters = [ {key = "document.custom_metadata.year" kondisi = [{int_value = 2020, Operations = GREATER_EQUAL}, {int_value = 2010, operations = LESS}]}, {key = "document.custom_metadata.year" kondisi = [{int_value = 2020, Operations = GREATER_EQUAL}, {int_value = 2010, Operations = LESS}]}, {key = "document.custom_metadata.genre" kondisi = [{stringValue = "drama", operasi = EQUAL}, {stringValue = "tindakan", operasi = EQUAL}]}]

Contoh kueri pada tingkat potongan 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 = &quot;chunk.custom_metadata.year&quot; kondisi = [{int_value = 2020, operasi = 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 untuk 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 potongan yang relevan.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Bidang
relevantChunks[] object (RelevantChunk)

Potongan-potongan yang relevan.

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

Metode: corpora.get

Mendapatkan informasi tentang Corpus tertentu.

Endpoint

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

Parameter jalur

name string

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

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons memuat instance Corpus.

Metode: corpora.patch

Memperbarui Corpus.

Endpoint

tambalan 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 yang 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 tersebut kosong saat dibuat, nama unik akan diambil dari displayName bersama dengan akhiran acak 12 karakter. Contoh: corpora/my-awesome-corpora-123a456b789c Formatnya adalah corpora/{corpora}.

Parameter kueri

updateMask string (FieldMask format)

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

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

Isi permintaan

Isi permintaan memuat instance Corpus.

Isi respons

Jika berhasil, isi respons memuat instance Corpus.

Metode: corpora.delete

Menghapus Corpus.

Endpoint

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

Parameter jalur

name string

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

Parameter kueri

force boolean

Opsional. Jika disetel ke benar (true), 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 akan kosong.

Resource REST: corpora.permissions

Resource: Izin

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

Peran adalah kumpulan operasi yang diizinkan yang memungkinkan pengguna melakukan tindakan spesifik pada resource PaLM API. Tetapkan peran agar tersedia bagi pengguna, grup, atau akun layanan. Saat menetapkan peran, Anda memberikan izin yang terdapat pada peran tersebut.

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

  • pembaca dapat menggunakan sumber daya (misalnya model yang disesuaikan, korpus) untuk inferensi
  • penulis memiliki izin pembaca dan juga dapat mengedit dan membagikan
  • memiliki izin penulis dan juga dapat menghapus
Representasi JSON 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}
Bidang
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 hibah.

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.

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 Mewakili grup. Jika ditetapkan, Anda harus memberikan alamat email untuk grup.
EVERYONE Mewakili akses ke 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 fasilitas.
WRITER Penulis dapat menggunakan, mengupdate, dan membagikan resource.
READER Pembaca dapat menggunakan resource.

MetadataFilter

Filter yang disediakan pengguna untuk membatasi pengambilan berdasarkan nilai metadata level Chunk atau Document. Contoh (genre = drama ATAU genre = tindakan): kunci = "document.custom_metadata.genre" kondisi = [{stringValue = "drama", operasi = EQUAL}, {stringValue = "tindakan", operasi = EQUAL}]

Representasi JSON 
{
  "key": string,
  "conditions": [
    {
      object (Condition)
    }
  ]
}
Bidang
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.

Kondisi

Kondisi filter yang berlaku untuk kunci tunggal.

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

  // Union field value can be only one of the following:
  "stringValue": string,
  "numericValue": number
  // End of list of possible types for union field value.
}
Bidang
operation enum (Operator)

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

Kolom union value. Jenis nilai harus konsisten dengan jenis nilai yang ditentukan dalam kolom untuk kunci yang sesuai. Jika jenis nilai tidak konsisten, hasilnya akan berupa kumpulan kosong. Jika CustomMetadata memiliki jenis nilai StringList, kondisi pemfilteran harus menggunakan string_value yang dipasangkan dengan operasi INCLUDES/INCLUDES, jika tidak, hasilnya juga akan berupa kumpulan kosong. value hanya dapat berupa salah satu dari yang berikut:
stringValue string

Nilai string untuk memfilter metadata.

numericValue number

Nilai numerik untuk memfilter metadata.

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 angka & {i>string<i}.
GREATER_EQUAL Didukung oleh numerik.
GREATER Didukung oleh numerik.
NOT_EQUAL Didukung oleh angka & {i>string<i}.
INCLUDES Hanya didukung oleh string jika jenis nilai CustomMetadata untuk kunci yang diberikan memiliki stringListValue.
EXCLUDES Hanya didukung oleh string jika jenis nilai CustomMetadata untuk kunci yang diberikan memiliki stringListValue.

RelevantChunk

Informasi untuk potongan yang relevan dengan kueri.

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

Chunk relevansi dengan kueri.

chunk object (Chunk)

Chunk yang terkait dengan kueri.