Permissions

方法:tunedModels.permissions.create

建立特定資源的權限。

端點

post https://generativelanguage.googleapis.com/v1beta/{parent=tunedModels/*}/permissions

路徑參數

parent string

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

要求主體

要求主體包含 Permission 的例項。

欄位
granteeType enum (GranteeType)

選用設定。不可變動。授權對象的類型。

emailAddress string

選用設定。不可變動。這個權限參照的使用者或群組電子郵件地址。權限的授權對象類型為「Everyone」時,系統不會設定欄位。

role enum (Role)

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

要求範例

Python

# With Gemini-2 we're launching a new SDK, see this doc for details.
# https://ai.google.dev/gemini-api/docs/migrate

回應主體

如果成功,回應主體會包含新建立的 Permission 例項。

方法:tunedModels.permissions.get

取得特定權限的相關資訊。

端點

get https://generativelanguage.googleapis.com/v1beta/{name=tunedModels/*/permissions/*}

路徑參數

name string

必要欄位。權限的資源名稱。

格式:tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} 採用 tunedModels/{tunedmodel}/permissions/{permission} 格式。

要求主體

要求主體必須為空白。

要求範例

Python

# With Gemini-2 we're launching a new SDK, see this doc for details.
# https://ai.google.dev/gemini-api/docs/migrate

回應主體

如果成功,回應主體會包含 Permission 的執行例項。

方法:tunedModels.permissions.list

列出特定資源的權限。

端點

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

路徑參數

parent string

必要欄位。權限的父項資源。格式:tunedModels/{tunedModel} corpora/{corpus} 採用 tunedModels/{tunedmodel} 格式。

查詢參數

pageSize integer

選用設定。要傳回的 Permission 數量上限 (每頁)。服務可能會傳回較少權限。

如未指定,最多將傳回 10 個權限。即使您傳遞較大的 pageSize,這個方法仍會傳回最多 1000 個權限。

pageToken string

選用設定。從先前 permissions.list 呼叫收到的網頁權杖。

將一個要求傳回的 pageToken 做為下一個要求的引數,擷取下一頁。

進行分頁時,提供至 permissions.list 的所有其他參數須與提供網頁權杖的呼叫相符。

要求主體

要求主體必須為空白。

要求範例

Python

# With Gemini-2 we're launching a new SDK, see this doc for details.
# https://ai.google.dev/gemini-api/docs/migrate

回應主體

如果成功,回應主體會包含 ListPermissionsResponse 的執行例項。

方法:tunedModels.permissions.patch

更新權限。

端點

修補 https://generativelanguage.googleapis.com/v1beta/{permission.name=tunedModels/*/permissions/*}

PATCH https://generativelanguage.googleapis.com/v1beta/{permission.name=tunedModels/*/permissions/*}

路徑參數

permission.name string

僅供輸出。ID。權限名稱。系統會在建立時產生專屬名稱。範例:tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} 僅供輸出。其格式為 tunedModels/{tunedmodel}/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 this doc for details.
# https://ai.google.dev/gemini-api/docs/migrate

回應主體

如果成功,回應主體會包含 Permission 的執行例項。

方法:tunedModels.permissions.delete

刪除權限。

端點

刪除 https://generativelanguage.googleapis.com/v1beta/{name=tunedModels/*/permissions/*}

路徑參數

name string

必要欄位。權限的資源名稱。格式:tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} 採用 tunedModels/{tunedmodel}/permissions/{permission} 格式。

要求主體

要求主體必須為空白。

要求範例

Python

# With Gemini-2 we're launching a new SDK, see this doc for details.
# https://ai.google.dev/gemini-api/docs/migrate

回應主體

如果成功,回應主體會是空的 JSON 物件。

方法:tunedModels.transferOwnership

轉移已調整模型的擁有權。這是變更調校模型擁有權的唯一方法。現任擁有者將降級為「作者」角色。

端點

post https://generativelanguage.googleapis.com/v1beta/{name=tunedModels/*}:transferOwnership

路徑參數

name string

必要欄位。要轉移擁有權的調整模型資源名稱。

格式:tunedModels/my-model-id 格式為 tunedModels/{tunedmodel}

要求主體

要求主體的資料會採用以下結構:

欄位
emailAddress string

必要欄位。要轉移調整後模型的使用者電子郵件地址。

回應主體

如果成功,回應主體會留白。

REST 資源:tunedModels.permissions

資源:權限

權限資源可授予使用者、群組或其他使用者存取 PaLM API 資源 (例如經過調整的模型、字元集)。

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

有三個同心圓角色。每個角色都包含前一個角色允許的操作的超集:

  • 讀取器可使用資源 (例如經過調整的模型、語料庫) 進行推論
  • 作者具備讀者的權限,且可編輯及分享
  • 擁有者具備編輯者權限,且可刪除
欄位
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)
}

ListPermissionsResponse

來自 ListPermissions 的回應,其中包含分頁的權限清單。

欄位
permissions[] object (Permission)

傳回的權限。

nextPageToken string

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

如果省略這個欄位,就沒有後續頁面。

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