Corpus Permissions

روش: corpora.permissions.create

یک مجوز برای یک منبع خاص ایجاد کنید.

نقطه پایانی

پست https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/permissions

پارامترهای مسیر

string parent

مورد نیاز. منبع والد Permission . قالب‌ها: tunedModels/{tunedModel} corpora/{corpus} به شکل corpora/{corpora} است.

درخواست بدن

بدنه درخواست حاوی نمونه‌ای از Permission است.

فیلدها
enum granteeType enum ( GranteeType )

اختیاری. تغییرناپذیر. نوع اعطا کننده.

string emailAddress

اختیاری. تغییرناپذیر. آدرس ایمیل کاربر گروهی که این مجوز به آن اشاره دارد. وقتی نوع دریافت‌کننده مجوز EVERYONE باشد، فیلد تنظیم نمی‌شود.

role enum ( Role )

مورد نیاز. نقش اعطا شده توسط این مجوز.

درخواست نمونه

پایتون 

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

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه جدیدی از Permission است.

روش: corpora.permissions.list

مجوزها را برای منبع خاص فهرست می کند.

نقطه پایانی

https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/permissions را دریافت کنید

پارامترهای مسیر

string parent

مورد نیاز. منبع والد مجوزها. قالب‌ها: tunedModels/{tunedModel} corpora/{corpus} به شکل corpora/{corpora} است.

پارامترهای پرس و جو

pageSize integer

اختیاری. حداکثر تعداد Permission بازگشت (در هر صفحه). این سرویس ممکن است مجوزهای کمتری را برگرداند.

اگر نامشخص باشد، حداکثر 10 مجوز برگردانده می شود. این روش حداکثر 1000 مجوز در هر صفحه را برمی‌گرداند، حتی اگر از pageSize بزرگتر عبور کنید.

string pageToken

اختیاری. یک نشانه صفحه، دریافت شده از تماس قبلی permissions.list .

pageToken را که توسط یک درخواست بازگردانده شده است به عنوان آرگومان برای درخواست بعدی برای بازیابی صفحه بعدی ارائه دهید.

هنگام صفحه بندی، تمام پارامترهای دیگر ارائه شده به permissions.list باید با فراخوانی که توکن صفحه را ارائه می کند مطابقت داشته باشد.

درخواست بدن

بدنه درخواست باید خالی باشد.

درخواست نمونه

پایتون 

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

# ...

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

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از ListPermissionsResponse است.

روش: corpora.permissions.get

اطلاعات مربوط به یک مجوز خاص را دریافت می کند.

نقطه پایانی

https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/permissions/*} را دریافت کنید

پارامترهای مسیر

string name

مورد نیاز. نام منبع مجوز.

قالب‌ها: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} به شکل corpora/{corpora}/permissions/{permission} است.

درخواست بدن

بدنه درخواست باید خالی باشد.

درخواست نمونه

پایتون 

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

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از Permission است.

روش: corpora.permissions.patch

مجوز را به روز می کند.

نقطه پایانی

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

پارامترهای مسیر

string permission.name

فقط خروجی شناسه. نام مجوز یک نام منحصر به فرد در ایجاد ایجاد می شود. مثال‌ها: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} فقط خروجی. شکل corpora/{corpora}/permissions/{permission} را می گیرد.

پارامترهای پرس و جو

رشته updateMask string ( FieldMask format)

مورد نیاز. لیست فیلدهایی که باید به روز شوند. موارد پذیرفته شده: - نقش (فیلد Permission.role )

این فهرستی از نام‌های فیلدهای کاملاً واجد شرایط با کاما است. مثال: "user.displayName,photo" .

درخواست بدن

بدنه درخواست حاوی نمونه‌ای از Permission است.

فیلدها
role enum ( Role )

مورد نیاز. نقش اعطا شده توسط این مجوز.

درخواست نمونه

پایتون 

        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):
        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

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از Permission است.

روش: corpora.permissions.delete

مجوز را حذف می کند.

نقطه پایانی

حذف https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/permissions/*}

پارامترهای مسیر

string name

مورد نیاز. نام منبع مجوز. قالب‌ها: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} به شکل corpora/{corpora}/permissions/{permission} است.

درخواست بدن

بدنه درخواست باید خالی باشد.

درخواست نمونه

پایتون 

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

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ خالی است.

منبع REST: corpora.permissions

منبع: مجوز

منبع مجوز به کاربر، گروه یا سایر نقاط جهان دسترسی به منبع API PalM (به عنوان مثال یک مدل تنظیم شده، مجموعه) اعطا می کند.

نقش مجموعه ای از عملیات مجاز است که به کاربران اجازه می دهد تا اقدامات خاصی را بر روی منابع Palm API انجام دهند. برای در دسترس قرار دادن آنها برای کاربران، گروه‌ها یا حساب‌های سرویس، نقش‌هایی را اختصاص می‌دهید. وقتی نقشی را اختصاص می دهید، مجوزهایی را که آن نقش در بر دارد اعطا می کنید.

سه نقش متحدالمرکز وجود دارد. هر نقش ابرمجموعه ای از عملیات مجاز نقش قبلی است:

  • خواننده می تواند از منبع (مثلاً مدل تنظیم شده، پیکره) برای استنتاج استفاده کند
  • نویسنده دارای مجوزهای خواننده است و علاوه بر این می تواند ویرایش و به اشتراک بگذارد
  • مالک دارای مجوزهای نویسنده است و علاوه بر این می تواند حذف کند
فیلدها
string name

فقط خروجی شناسه. نام مجوز یک نام منحصر به فرد در ایجاد ایجاد می شود. مثال‌ها: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} فقط خروجی.

enum granteeType enum ( GranteeType )

اختیاری. تغییرناپذیر. نوع اعطا کننده.

string emailAddress

اختیاری. تغییرناپذیر. آدرس ایمیل کاربر گروهی که این مجوز به آن اشاره دارد. وقتی نوع دریافت‌کننده مجوز EVERYONE باشد، فیلد تنظیم نمی‌شود.

role enum ( Role )

مورد نیاز. نقش اعطا شده توسط این مجوز.

نمایندگی JSON 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}

GranteeType

انواع دارنده این مجوز را تعریف می کند.

Enums
GRANTEE_TYPE_UNSPECIFIED مقدار پیش فرض این مقدار استفاده نشده است.
USER یک کاربر را نشان می دهد. وقتی تنظیم شد، باید آدرس ایمیل را برای کاربر ارائه دهید.
GROUP نماینده یک گروه است. وقتی تنظیم شد، باید آدرس ایمیل را برای گروه ارائه دهید.
EVERYONE نشان دهنده دسترسی به همه است. هیچ اطلاعات اضافی مورد نیاز نیست.

نقش

نقش اعطا شده توسط این مجوز را تعریف می کند.

Enums
ROLE_UNSPECIFIED مقدار پیش فرض این مقدار استفاده نشده است.
OWNER مالک می تواند از منبع استفاده، به روز رسانی، اشتراک گذاری و حذف کند.
WRITER Writer می تواند از منبع استفاده کند، به روز کند و به اشتراک بگذارد.
READER خواننده می تواند از منبع استفاده کند.

ListPermissionsResponse

پاسخ از ListPermissions حاوی لیست صفحه بندی شده مجوزها.

فیلدها
permissions[] object ( Permission )

مجوزهای برگشت داده شده

string nextPageToken

یک نشانه، که می تواند به عنوان pageToken برای بازیابی صفحه بعدی ارسال شود.

اگر این قسمت حذف شود، صفحه دیگری وجود ندارد.

نمایندگی JSON 
{
  "permissions": [
    {
      object (Permission)
    }
  ],
  "nextPageToken": string
}