Corpus Permissions

שיטה: corpora.permissions.create

יצירת הרשאה למשאב ספציפי.

נקודת קצה

פוסט 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

הצגת רשימת ההרשאות למשאב הספציפי.

נקודת קצה

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

פרמטרים של נתיב

parent string

חובה. משאב ההורה של ההרשאות. פורמטים: tunedModels/{tunedModel} corpora/{corpus} הפורמט הוא corpora/{corpora}.

פרמטרים של שאילתה

pageSize integer

אופציונלי. המספר המקסימלי של Permissions שיוחזר (לכל דף). יכול להיות שהשירות יחזיר פחות הרשאות.

אם לא יצוינו, יוחזרו עד 10 הרשאות. השיטה הזו מחזירה עד 1,000 הרשאות לכל דף, גם אם מעבירים ערך גדול יותר של 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)

חובה. רשימת השדות שרוצים לעדכן. אלה הערכים הקבילים: - role (השדה 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

הגדרת סוגי המקבלים של ההרשאה הזו.

טיפוסים בני מנייה (enum)
GRANTEE_TYPE_UNSPECIFIED ערך ברירת המחדל. הערך הזה לא בשימוש.
USER מייצג משתמש. כשמגדירים את השדה, צריך לציין את כתובת האימייל של המשתמש.
GROUP מייצג קבוצה. כשמגדירים את השדה, צריך לציין את כתובת האימייל של הקבוצה.
EVERYONE מייצג גישה לכולם. לא נדרש מידע נוסף.

תפקיד

הגדרת התפקיד שההרשאה הזו מעניקה.

טיפוסים בני מנייה (enum)
ROLE_UNSPECIFIED ערך ברירת המחדל. הערך הזה לא בשימוש.
OWNER הבעלים יכול להשתמש במשאב, לעדכן אותו, לשתף אותו ולמחוק אותו.
WRITER הכותבים יכולים להשתמש במשאב, לעדכן אותו ולשתף אותו.
READER הקוראים יכולים להשתמש במשאב.

ListPermissionsResponse

תגובה מ-ListPermissions שמכילה רשימה מחולקת לדפים של הרשאות.

שדות
permissions[] object (Permission)

ההרשאות שהוחזרו.

nextPageToken string

אסימון שאפשר לשלוח כ-pageToken כדי לאחזר את הדף הבא.

אם השדה הזה לא יצוין, לא יהיו עוד דפים.

ייצוג ב-JSON 
{
  "permissions": [
    {
      object (Permission)
    }
  ],
  "nextPageToken": string
}