Permissions

メソッド: tuningModels.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

import google.generativeai as genai

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 のインスタンスが含まれます。

メソッド: tuningModels.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

import google.generativeai as genai

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 のインスタンスが含まれます。

メソッド: tuningModels.permissions.list

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

エンドポイント

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

パスパラメータ

parent string

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

クエリ パラメータ

pageSize integer

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

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

pageToken string

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

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

ページ分割を行う場合、permissions.list に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

リクエストの本文

リクエストの本文は空にする必要があります。

リクエスト例

Python

import google.generativeai as genai

model_info = genai.get_model("tunedModels/my-increment-model")

# ...

for p in model_info.permissions.list():
    print(p)
tuned_models.py

レスポンスの本文

成功した場合、レスポンスの本文には ListPermissionsResponse のインスタンスが含まれます。

メソッド: tuningModels.permissions.patch

権限を更新します。

エンドポイント

<ph type="x-smartling-placeholder"></ph> パッチ <ph type="x-smartling-placeholder"></ph> https://generativelanguage.googleapis.com/v1beta/{permission.name=tunedModels/*/permissions/*}

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

パスパラメータ

permission.name string

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

クエリ パラメータ

updateMask string (FieldMask format)

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

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

リクエストの本文

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

<ph type="x-smartling-placeholder">
</ph> フィールド
role enum (Role)

必須。この権限によって付与されるロール。

リクエスト例

Python

        import google.generativeai as genai

        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):
        import google.generativeai as genai

        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 のインスタンスが含まれます。

メソッド: 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

import google.generativeai as genai

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

レスポンスの本文

成功すると、レスポンスの本文は空になります。

メソッド: tuningModels.transferOwnership

チューニング済みモデルの所有権を譲渡します。これは、チューニング済みモデルの所有権を変更する唯一の方法です。現在のオーナーは書き込みロールにダウングレードされます。

エンドポイント

<ph type="x-smartling-placeholder"></ph> 投稿 <ph type="x-smartling-placeholder"></ph> https://generativelanguage.googleapis.com/v1beta/{name=tunedModels/*}:transferOwnership

パスパラメータ

name string

必須。所有権を移行するチューニング済みモデルのリソース名。

形式: tunedModels/my-model-id。tunedModels/{tunedmodel} の形式になります。

リクエスト本文

リクエストの本文には、次の構造のデータが含まれます。

フィールド
emailAddress string

必須。チューニング済みモデルの転送先となるユーザーのメールアドレス。

レスポンスの本文

成功すると、レスポンスの本文は空になります。

REST リソース: tunedModels.permissions

リソース: Permission

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

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

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

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

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