Corpus Permissions

メソッド: corpora.permissions.create

特定のリソースに対する権限を作成する。

エンドポイント

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

パスパラメータ

parent string

必須。Permission の親リソース。形式: tunedModels/{tunedModel} corpora/{corpus} corpora/{corpora} の形式になります。

リクエスト本文

リクエストの本文には Permission のインスタンスが含まれます。

<ph type="x-smartling-placeholder">
</ph> フィールド
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

特定のリソースの権限を一覧表示します。

エンドポイント

<ph type="x-smartling-placeholder"></ph> 入手 <ph type="x-smartling-placeholder"></ph> https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/permissions

パスパラメータ

parent string

必須。権限の親リソース。形式: tunedModels/{tunedModel} corpora/{corpus} corpora/{corpora} の形式になります。

クエリ パラメータ

pageSize integer

省略可。返される Permission の最大数（1 ページあたり）。サービスから返される権限が少なくなる場合があります。

指定されていない場合は、最大で 10 個の権限が返されます。このメソッドでは、より大きい pageSize を渡しても、1 ページあたり最大 1, 000 個の権限が返されます。

pageToken string

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

次のページを取得するには、あるリクエストで返された pageToken を次のリクエストの引数として指定します。

ページ分割を行う場合、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

特定の権限に関する情報を取得します。

エンドポイント

<ph type="x-smartling-placeholder"></ph> 入手 <ph type="x-smartling-placeholder"></ph> 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

出力専用。ID。権限名。作成時に一意の名前が生成されます。例: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} 出力のみ。形式は corpora/{corpora}/permissions/{permission} です。

クエリ パラメータ

updateMask string (FieldMask format)

必須。更新するフィールドのリスト。使用できるフィールド: - role（Permission.role フィールド）

完全修飾フィールド名のカンマ区切りリスト。例: "user.displayName,photo"。

リクエストの本文

リクエストの本文には Permission のインスタンスが含まれます。

<ph type="x-smartling-placeholder">
</ph> フィールド
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

権限を削除します。

エンドポイント

削除 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 つあります。各ロールは、前のロールで許可されているオペレーションのスーパーセットです。

  • リーダーは、リソース（チューニング済みモデル、コーパスなど）を推論に使用できます。
  • 作成者は閲覧者の権限を持ち、さらに編集と共有を行うことができます
  • オーナーは作成者の権限に加えて削除も行えます
で確認できます。
<ph type="x-smartling-placeholder">
</ph> フィールド <ph type="x-smartling-placeholder">
</ph>
name string

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