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 this 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 を渡しても、ページごとに最大 1, 000 個の権限を返します。

pageToken string

省略可。前回の permissions.list 呼び出しから受け取ったページトークン。

1 つのリクエストで返された 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
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 this doc for details.
# https://ai.google.dev/gemini-api/docs/migrate
README.md

レスポンスの本文

成功した場合、レスポンスの本文には 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

出力専用。ID。権限名。作成時に一意の名前が生成されます。例: 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 this 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 this doc for details.
# https://ai.google.dev/gemini-api/docs/migrate
README.md

レスポンスの本文

成功すると、レスポンスの本文は空の JSON オブジェクトになります。

REST リソース: corpora.permissions

リソース: 権限

権限リソースは、ユーザー、グループ、または世界中のユーザーに PaLM API リソース（チューニング済みモデル、コーパスなど）へのアクセス権を付与します。

ロールとは、ユーザーが PaLM API リソースに対して特定のアクションを実行できるようにする、許可されたオペレーションの集合です。ユーザー、グループ、サービス アカウントで使用できるようにするには、ロールを割り当てます。ロールを割り当てると、そのロールに含まれる権限が付与されます。

3 つの同心円状のロールがあります。各ロールは、前のロールで許可されているオペレーションのスーパーセットです。

  • リーダーは、リソース（チューニング済みモデル、コーパスなど）を推論に使用できます。
  • ライターはリーダーの権限に加えて、編集と共有を行うことができます
  • オーナーは作成者の権限に加えて削除も行えます
フィールド
name string

出力専用。ID。権限名。作成時に一意の名前が生成されます。例: 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

この権限の付与対象のタイプを定義します。

列挙型
GRANTEE_TYPE_UNSPECIFIED デフォルト値。この値は使用されません。
USER ユーザーを表します。設定する場合は、ユーザーのメールアドレスを指定する必要があります。
GROUP グループを表します。設定する場合は、グループの emailAddress を指定する必要があります。
EVERYONE すべてのユーザーがアクセスできることを表します。その他に補足的な情報は必要ありません。

ロール

この権限によって付与されるロールを定義します。

列挙型
ROLE_UNSPECIFIED デフォルト値。この値は使用されません。
OWNER オーナーは、リソースの使用、更新、共有、削除を行うことができます。
WRITER 作成者はリソースの使用、更新、共有を行うことができます。
READER 読者がリソースを使用できる。

ListPermissionsResponse

権限のページネーション リストを含む ListPermissions からのレスポンス。

フィールド
permissions[] object (Permission)

返された権限。

nextPageToken string

次のページを取得するために pageToken として送信できるトークン。

このフィールドを省略すると、それ以上ページはありません。

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