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

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

หากไม่ระบุ ระบบจะแสดงผลสิทธิ์สูงสุด 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

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

ปลายทาง

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

อัปเดตสิทธิ์

ปลายทาง

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 (เช่น โมเดลที่ปรับแต่ง ข้อมูล Corpus)

บทบาทคือชุดการดำเนินการที่ได้รับอนุญาตซึ่งช่วยให้ผู้ใช้ดำเนินการบางอย่างกับทรัพยากร PaLM API ได้ คุณต้องมอบหมายบทบาทเพื่อให้ผู้ใช้ กลุ่ม หรือบัญชีบริการเข้าถึงได้ การกำหนดบทบาทเป็นการมอบสิทธิ์ที่มีอยู่ในบทบาทนั้น

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

  • ผู้อ่านสามารถใช้ทรัพยากร (เช่น โมเดลที่ปรับแต่งแล้ว คลังข้อมูล) เพื่อการอนุมาน
  • ผู้เขียนมีสิทธิ์ของผู้อ่านและสามารถแก้ไขและแชร์ได้
  • เจ้าของมีสิทธิ์ของผู้เขียนและสามารถลบได้
ฟิลด์
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
}