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

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

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

נקודת קצה

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

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/*}

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

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)
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/*}

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

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

        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/*}

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

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()
tuned_models.py

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יהיה ריק.

משאב 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
}