Corpus Permissions

Metode: corpora.permissions.create

Membuat izin ke resource tertentu.

Endpoint

posting https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/permissions

Parameter jalur

parent string

Wajib. Resource induk Permission. Format: tunedModels/{tunedModel} corpora/{corpus} Formatnya adalah corpora/{corpora}.

Isi permintaan

Isi permintaan memuat instance Permission.

Kolom
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.

Contoh permintaan

Python

import google.generativeai as genai

model_info = genai.get_model("tunedModels/my-increment-model")
# ...

public_permission = model_info.permissions.create(
    role="READER",
    grantee_type="EVERYONE",
)

group_permission = model_info.permissions.create(
    role="READER",
    # Use "user" for an individual email address.
    grantee_type="group",
    email_address="genai-samples-test-group@googlegroups.com",
)
tuned_models.py

Isi respons

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

Metode: corpora.permissions.list

Mencantumkan izin untuk resource tertentu.

Endpoint

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

Parameter jalur

parent string

Wajib. Resource induk izin. Format: tunedModels/{tunedModel} corpora/{corpus} Formatnya adalah corpora/{corpora}.

Parameter kueri

pageSize integer

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

Jika tidak ditentukan, maksimal 10 izin akan ditampilkan. Metode ini menampilkan maksimal 1.000 izin per halaman, meskipun Anda melewati pageSize yang lebih besar.

pageToken string

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

Berikan pageToken yang ditampilkan oleh satu permintaan sebagai argumen bagi permintaan berikutnya untuk mengambil halaman berikutnya.

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

Isi permintaan

Isi permintaan harus kosong.

Contoh permintaan

Python

import google.generativeai as genai

model_info = genai.get_model("tunedModels/my-increment-model")

# ...

for p in model_info.permissions.list():
    print(p)
tuned_models.py

Isi respons

Jika berhasil, isi respons memuat instance ListPermissionsResponse.

Metode: corpora.permissions.get

Mendapatkan informasi tentang Izin tertentu.

Endpoint

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

Parameter jalur

name string

Wajib. Nama resource izin.

Format: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Formatnya adalah corpora/{corpora}/permissions/{permission}.

Isi permintaan

Isi permintaan harus kosong.

Contoh permintaan

Python

import google.generativeai as genai

model_info = genai.get_model("tunedModels/my-increment-model")

# ...

public = model_info.permissions.create(
    role="READER",
    grantee_type="EVERYONE",
)
print(public)
name = public.name
print(name)  # tunedModels/{tunedModel}/permissions/{permission}

from_name = genai.types.Permissions.get(name)
print(from_name)
tuned_models.py

Isi respons

Jika berhasil, isi respons memuat instance Permission.

Metode: corpora.permissions.patch

Memperbarui izin.

Endpoint

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

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

Parameter jalur

permission.name string

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

Parameter kueri

updateMask string (FieldMask format)

Wajib. Daftar kolom yang akan diperbarui. Yang diterima: - peran (kolom Permission.role)

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

Isi permintaan

Isi permintaan memuat instance Permission.

Kolom
role enum (Role)

Wajib. Peran yang diberikan oleh izin ini.

Contoh permintaan

Python

        import google.generativeai as genai

        model_info = genai.get_model("tunedModels/my-increment-model")

        # ...

        test_group = model_info.permissions.create(
            role="writer",
            grantee_type="group",
            email_address="genai-samples-test-group@googlegroups.com",
        )

        test_group.update({"role": "READER"})

    def test_tuned_models_permission_delete(self):
        import google.generativeai as genai

        model_info = genai.get_model("tunedModels/my-increment-model")
        # ...

        public_permission = model_info.permissions.create(
            role="READER",
            grantee_type="EVERYONE",
        )

        public_permission.delete()


if __name__ == "__main__":
    absltest.main()

tuned_models.py

Isi respons

Jika berhasil, isi respons memuat instance Permission.

Metode: corpora.permissions.delete

Menghapus izin.

Endpoint

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

Parameter jalur

name string

Wajib. Nama resource izin. Format: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Formatnya adalah corpora/{corpora}/permissions/{permission}.

Isi permintaan

Isi permintaan harus kosong.

Contoh permintaan

Python

import google.generativeai as genai

model_info = genai.get_model("tunedModels/my-increment-model")
# ...

public_permission = model_info.permissions.create(
    role="READER",
    grantee_type="EVERYONE",
)

public_permission.delete()
tuned_models.py

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 tertentu 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 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
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.

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 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, memperbarui, dan membagikan referensi.
READER Pembaca dapat menggunakan resource.

ListPermissionsResponse

Respons dari ListPermissions yang berisi daftar izin yang di-pagination.

Bidang
permissions[] object (Permission)

Izin 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 
{
  "permissions": [
    {
      object (Permission)
    }
  ],
  "nextPageToken": string
}