Corpus Permissions

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

أنشئ إذنًا لمورد معيّن.

نقطة نهاية

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

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

parent string

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

نص الطلب

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

الحقول
granteeType enum (GranteeType)

اختيارية: غير قابل للتغيير نوع الممنوح

emailAddress string

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

role enum (Role)

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

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

Python
# With Gemini 2 we're launching a new SDK. See the following doc for details.
# https://ai.google.dev/gemini-api/docs/migrate
README.md

نص الاستجابة

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

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

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

نقطة نهاية

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

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

parent string

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

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

pageSize integer

اختيارية: الحد الأقصى لعدد Permission التي سيتم عرضها (لكل صفحة) قد تعرض الخدمة عددًا أقل من الأذونات.

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

pageToken string

اختيارية: رمز مميّز للصفحة، تم تلقّيه من مكالمة permissions.list سابقة

قدِّم pageToken الذي تم إرجاعه من خلال طلب واحد كوسيطة للطلب التالي لاسترداد الصفحة التالية.

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

نص الطلب

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

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

Python
# With Gemini 2 we're launching a new SDK. See the following doc for details.
# https://ai.google.dev/gemini-api/docs/migrate
README.md

نص الاستجابة

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

الطريقة: 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
# With Gemini 2 we're launching a new SDK. See the following doc for details.
# https://ai.google.dev/gemini-api/docs/migrate
README.md

نص الاستجابة

إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال 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

النتائج فقط. المعرّف اسم الإذن سيتم إنشاء اسم فريد عند الإنشاء. أمثلة: 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)

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

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

Python
# With Gemini 2 we're launching a new SDK. See the following doc for details.
# https://ai.google.dev/gemini-api/docs/migrate
README.md

نص الاستجابة

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

الطريقة: 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
# With Gemini 2 we're launching a new SDK. See the following doc for details.
# https://ai.google.dev/gemini-api/docs/migrate
README.md

نص الاستجابة

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

مورد REST: corpora.permissions

المرجع: الإذن

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

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

هناك ثلاثة أدوار متداخلة. كل دور هو مجموعة شاملة من العمليات المسموح بها للدور السابق:

  • يمكن للقارئ استخدام المورد (مثل النموذج المحسَّن أو مجموعة النصوص) للاستنتاج
  • يمتلك الكاتب أذونات القارئ، ويمكنه أيضًا التعديل والمشاركة.
  • يمتلك المالك أذونات الكاتب، ويمكنه أيضًا حذف المحتوى.
الحقول
name string

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

granteeType enum (GranteeType)

اختيارية: غير قابل للتغيير نوع الممنوح

emailAddress string

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

role enum (Role)

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

تمثيل JSON 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}

GranteeType

تحدِّد أنواع مُمنوح هذا الإذن.

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

الدور

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

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

ListPermissionsResponse

استجابة من ListPermissions تحتوي على قائمة مُقسّمة إلى صفحات بالأذونات

الحقول
permissions[] object (Permission)

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

nextPageToken string

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

في حال حذف هذا الحقل، لن تظهر أي صفحات أخرى.

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