Corpus Perissions

الطريقة: corpora.permissions.list

يسرد الأذونات للمورد المحدد.

نقطة نهاية

الحصول على https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/permissions

مَعلمات المسار

parent string

مطلوب. المورد الرئيسي للأذونات. التنسيقات: tunedModels/{tunedModel} corpora/{corpus} وتكون على شكل corpora/{corpora}.

معامِلات طلب البحث

pageSize integer

اختياريّ. الحد الأقصى لعدد Permission ثانية المطلوب عرضها (لكل صفحة). قد تعرض الخدمة أذونات أقل.

في حال عدم تحديد نوع الحساب، سيتم عرض 10 أذونات كحدّ أقصى. تعرض هذه الطريقة 1000 إذن كحدّ أقصى لكل صفحة، حتى إذا تجاوزت حجم الصفحة أكبر.

pageToken string

اختياريّ. رمز مميّز للصفحة، تم تلقّيه من استدعاء سابق لتطبيق "permissions.list".

يمكنك تقديم pageToken الذي يعرضه طلب واحد كوسيطة للطلب التالي لاسترداد الصفحة التالية.

عند التقسيم على صفحات، يجب أن تتطابق جميع المَعلمات الأخرى المقدَّمة إلى permissions.list مع الاستدعاء الذي قدّم الرمز المميّز للصفحة.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

مثال على الطلب

Python

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

# ...

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

نص الاستجابة

إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال ListPermissionsResponse.

الطريقة: corpora.permissions.delete

حذف الإذن

نقطة نهاية

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

مَعلمات المسار

name string

مطلوب. اسم مورد الإذن. التنسيقات: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} وتكون على شكل corpora/{corpora}/permissions/{permission}.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

مثال على الطلب

Python

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

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

public_permission.delete()

نص الاستجابة

إذا كانت الاستجابة ناجحة، يكون نص الاستجابة فارغًا.

الطريقة: corpora.permissions.create

إنشاء إذن لمورد معين.

نقطة نهاية

منشور https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/permissions

مَعلمات المسار

parent string

مطلوب. تمثّل هذه السمة المصدر الرئيسي لـ Permission. التنسيقات: tunedModels/{tunedModel} corpora/{corpus} وتكون على شكل corpora/{corpora}.

نص الطلب

يحتوي نص الطلب على مثال Permission.

مثال على الطلب

Python

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",
)

نص الاستجابة

في حال نجاح الإجراء، يحتوي نص الاستجابة على مثيل Permission تم إنشاؤه حديثًا.

الطريقة: corpora.permissions.patch

يتم تعديل الإذن.

نقطة نهاية

رمز تصحيح https://generativelanguage.googleapis.com/v1beta/{permission.name=corpora/*/permissions/*}

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

مَعلمات المسار

permission.name string

النتائج فقط. المُعرّف. اسم الإذن سيتم إنشاء اسم فريد عند الإنشاء. أمثلة: recognizedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} فقط إلى النتائج. ويكون على النحو corpora/{corpora}/permissions/{permission}.

معامِلات طلب البحث

updateMask string (FieldMask format)

مطلوب. قائمة الحقول المطلوب تعديلها. المعايير المقبولة: - الدور (حقل واحد (Permission.role))

هذه قائمة مفصولة بفواصل تضم أسماء الحقول المؤهلة بالكامل. مثال: "user.displayName,photo"

نص الطلب

يحتوي نص الطلب على مثال Permission.

مثال على الطلب

Python

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

نص الاستجابة

إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال Permission.

الطريقة: corpora.permissions.get

الحصول على معلومات حول إذن محدّد

نقطة نهاية

الحصول على https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/permissions/*}

مَعلمات المسار

name string

مطلوب. اسم مورد الإذن.

التنسيقات: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} وتكون على شكل corpora/{corpora}/permissions/{permission}.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

مثال على الطلب

Python

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)

نص الاستجابة

إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال Permission.

مورد REST: corpora.permissions

المورد: الإذن

يمنح مورد الأذونات المستخدم أو المجموعة أو باقي المستخدمين في العالم إمكانية الوصول إلى مورد واجهة برمجة التطبيقات PaLM (مثل نموذج تم ضبطه أو مجموعة البيانات).

الدور هو مجموعة من العمليات المسموح بها التي تسمح للمستخدمين بتنفيذ إجراءات محدّدة على موارد PaLM API. يمكنك إسناد أدوار لإتاحتها للمستخدمين أو المجموعات أو حسابات الخدمة. عند منح دور، تمنح الأذونات التي يتضمنها الدور.

هناك ثلاثة أدوار متحدة المركز. يعد كل دور جزءًا رئيسيًا من العمليات المسموح بها للدور السابق:

  • يمكن للقارئ استخدام المورد (مثل النموذج المضبوط أو المجموعة) للاستنتاج.
  • الكاتب لديه أذونات القارئ ويمكنه بالإضافة إلى ذلك التعديل والمشاركة
  • لدى المالك أذونات الكاتب ويمكنه أيضًا حذف
تمثيل JSON 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}
الحقول
name string

النتائج فقط. المُعرّف. اسم الإذن سيتم إنشاء اسم فريد عند الإنشاء. أمثلة: recognizedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} فقط إلى النتائج.

granteeType enum (GranteeType)

اختياريّ. غير قابل للتغيير. نوع المستفيد.

emailAddress string

اختياريّ. غير قابل للتغيير. عنوان البريد الإلكتروني لمستخدم المجموعة الذي يشير إليه هذا الإذن. لا يتم ضبط الحقل عندما يكون نوع الممنوح له الإذن هو "الجميع" (EVERYONE).

role enum (Role)

مطلوب. الدور الذي يمنحكه هذا الإذن.

GranteeType

تحدّد هذه السمة أنواع المستفيدين من هذا الإذن.

عمليات التعداد
GRANTEE_TYPE_UNSPECIFIED القيمة التلقائية. هذه القيمة غير مستخدمة.
USER يمثل مستخدمًا. وعند ضبط هذه السياسة، يجب تقديم عنوان البريد الإلكتروني للمستخدم.
GROUP يمثل مجموعة. عند ضبط هذه السياسة، يجب تقديم عنوان البريد الإلكتروني للمجموعة.
EVERYONE يمثل إمكانية الوصول للجميع. ولن يُطلب منك تقديم أي معلومات إضافية.

الدور

يحدد الدور الممنوح من خلال هذا الإذن.

عمليات التعداد
ROLE_UNSPECIFIED القيمة التلقائية. هذه القيمة غير مستخدمة.
OWNER يمكن للمالك استخدام المورد وتحديثه ومشاركته وحذفه.
WRITER يمكن للكاتب استخدام المورد وتعديله ومشاركته.
READER يمكن للقارئ استخدام المورد.

ListPermissionsResponse

ردّ من ListPermissions يحتوي على قائمة أذونات مُقسَّمة إلى صفحات.

تمثيل JSON 
{
  "permissions": [
    {
      object (Permission)
    }
  ],
  "nextPageToken": string
}
الحقول
permissions[] object (Permission)

تم إرجاع الأذونات.

nextPageToken string

رمز مميز يمكن إرساله على شكل pageToken لاسترداد الصفحة التالية.

إذا تم حذف هذا الحقل، يعني هذا أنّه لا يتوفّر المزيد من الصفحات.