Corpus Permissions

方法：corpora.permissions.create

為特定資源建立權限。

端點

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

路徑參數

parent string

必要欄位。Permission 的父項資源。格式：tunedModels/{tunedModel} corpora/{corpus} 採用 corpora/{corpora} 格式。

要求主體

要求主體包含 Permission 的例項。

Fields
granteeType enum (GranteeType)

(選用步驟) 不可變更。受讓人類型。

emailAddress string

(選用步驟) 不可變更。這個權限參照的使用者或群組的電子郵件地址。如果權限的受讓人類型為 EVERYONE，則不會設定這個欄位。

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 項權限。即使您傳遞較大的 pageSize，這個方法每頁最多只會傳回 1000 個權限。

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

僅供輸出。ID。權限名稱。建立時系統會產生專屬名稱。範例：tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} 僅供輸出。格式為 corpora/{corpora}/permissions/{permission}。

查詢參數

updateMask string (FieldMask format)

必要欄位。要更新的欄位清單。可接受的值：- 角色 (Permission.role 欄位)

這是以半形逗號分隔的完整欄位名稱清單。範例："user.displayName,photo"。

要求主體

要求主體包含 Permission 的例項。

Fields
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

刪除權限。

端點

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

資源：Permission

權限資源可授予使用者、群組或全球其他使用者存取 PaLM API 資源 (例如微調模型、語料庫)。

角色是允許執行的作業集合，可讓使用者對 PaLM API 資源執行特定動作。如要讓使用者、群組或服務帳戶使用這些角色，請指派角色。指派角色時，您會授予該角色包含的權限。

這三種角色是同心圓關係。每個角色都是前一個角色允許作業的超集：

  • 讀者可將資源 (例如微調模型、語料庫) 用於推論
  • 寫手具有讀者權限，此外還能編輯及共用
  • 擁有者具備編輯者權限，且可以刪除
Fields
name string

僅供輸出。ID。權限名稱。建立時系統會產生專屬名稱。範例：tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} 僅供輸出。

granteeType enum (GranteeType)

(選用步驟) 不可變更。受讓人類型。

emailAddress string

(選用步驟) 不可變更。這個權限參照的使用者或群組的電子郵件地址。如果權限的受讓人類型為 EVERYONE，則不會設定這個欄位。

role enum (Role)

必要欄位。這個權限授予的角色。

JSON 表示法 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}

GranteeType

定義這項權限的受讓人類型。

列舉
GRANTEE_TYPE_UNSPECIFIED 預設值。這個值不會使用。
USER 代表使用者。設定後，您必須提供使用者的 emailAddress。
GROUP 代表群組。設定後，您必須提供群組的 emailAddress。
EVERYONE 代表所有人都能存取。無須提供額外資訊。

角色

定義這個權限授予的角色。

列舉
ROLE_UNSPECIFIED 預設值。這個值不會使用。
OWNER 擁有者可以運用、更新、共用及刪除資源。
WRITER 撰稿人可以運用、更新及分享資源。
READER 讀者可以使用該資源。

ListPermissionsResponse

ListPermissions 的回應，其中包含分頁權限清單。

欄位
permissions[] object (Permission)

傳回的權限。

nextPageToken string

可做為 pageToken 傳送的權杖，用於擷取後續網頁。

如果省略這個欄位，就不會有後續頁面。

JSON 表示法 
{
  "permissions": [
    {
      object (Permission)
    }
  ],
  "nextPageToken": string
}