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

แสดงรายการสิทธิ์สำหรับทรัพยากรที่เฉพาะเจาะจง

ปลายทาง

ซื้อ https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/permissions

พารามิเตอร์เส้นทาง

parent string

ต้องระบุ ทรัพยากรระดับบนสุดของสิทธิ์ รูปแบบ: tunedModels/{tunedModel} corpora/{corpus} อยู่ในรูปแบบ corpora/{corpora}

พารามิเตอร์การค้นหา

pageSize integer

ไม่บังคับ จำนวนสูงสุด Permission วินาทีที่จะแสดงผล (ต่อหน้า) บริการอาจส่งคืนสิทธิ์น้อยลง

หากไม่ระบุ ระบบจะแสดงผลสิทธิ์สูงสุด 10 สิทธิ์ วิธีนี้จะแสดงผลสิทธิ์ได้สูงสุด 1, 000 รายการต่อหน้า แม้ว่าคุณจะส่ง pageSize ที่ใหญ่กว่าก็ตาม

pageToken string

ไม่บังคับ โทเค็นของหน้าเว็บที่ได้รับจากการโทร permissions.list ก่อนหน้า

ระบุ pageToken ที่ส่งคืนโดยคำขอ 1 รายการเป็นอาร์กิวเมนต์ของคำขอถัดไปเพื่อเรียกหน้าถัดไป

เมื่อใส่เลขหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ให้กับ 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

รับข้อมูลเกี่ยวกับสิทธิ์ที่เฉพาะเจาะจง

ปลายทาง

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

ซึ่งเป็นรายการชื่อฟิลด์ที่สมบูรณ์ในตัวเองที่คั่นด้วยคอมมา ตัวอย่าง: "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

ลบสิทธิ์

ปลายทาง

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 ได้ คุณต้องมอบหมายบทบาทเพื่อให้ผู้ใช้ กลุ่ม หรือบัญชีบริการพร้อมใช้งาน การมอบหมายบทบาทเป็นการให้สิทธิ์เข้าถึงที่บทบาทนั้นมีอยู่

มีบทบาทที่คล้ายกัน 3 บทบาท แต่ละบทบาทเป็นเซตที่รวมการดำเนินการที่อนุญาตของบทบาทก่อนหน้า

  • ผู้อ่านสามารถใช้ทรัพยากร (เช่น โมเดลที่ปรับแต่ง คอร์ปัส) สำหรับการอนุมาน
  • ผู้เขียนมีสิทธิ์ของผู้อ่าน รวมทั้งแก้ไขและแชร์ได้
  • เจ้าของมีสิทธิ์ของผู้เขียนและสามารถลบได้
ช่อง
name string

เอาต์พุตเท่านั้น ตัวระบุ ชื่อสิทธิ์ ระบบจะสร้างชื่อที่ไม่ซ้ำกันขึ้นเมื่อสร้าง ตัวอย่าง: TunModels/{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 แสดงผู้ใช้ เมื่อตั้งค่าแล้ว คุณต้องระบุ emailAddress สำหรับผู้ใช้
GROUP แสดงกลุ่ม เมื่อตั้งค่าแล้ว คุณต้องระบุอีเมลของกลุ่ม
EVERYONE แสดงสิทธิ์เข้าถึงทุกคน โดยไม่จำเป็นต้องให้ข้อมูลเพิ่มเติม

บทบาท

กําหนดบทบาทที่ได้รับสิทธิ์นี้

Enum
ROLE_UNSPECIFIED ค่าเริ่มต้น ค่านี้ไม่ได้ใช้
OWNER เจ้าของสามารถใช้ อัปเดต แชร์ และลบทรัพยากรได้
WRITER ผู้เขียนสามารถใช้ อัปเดต และแชร์ทรัพยากรได้
READER ผู้อ่านใช้ทรัพยากรได้

ListPermissionsResponse

การตอบกลับจาก ListPermissions ที่มีรายการสิทธิ์ที่ใส่เลขหน้า

ฟิลด์
permissions[] object (Permission)

สิทธิ์ที่ส่งคืน

nextPageToken string

โทเค็นซึ่งสามารถส่งเป็น pageToken เพื่อเรียกข้อมูลหน้าถัดไป

หากเว้นช่องนี้ไว้ จะไม่มีหน้าเพิ่มเติม

การแสดง JSON 
{
  "permissions": [
    {
      object (Permission)
    }
  ],
  "nextPageToken": string
}