Corpus Permissions

Yöntem: corpora.permissions.create

Belirli bir kaynak için izin oluşturun.

Uç nokta

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

Yol parametreleri

parent string

Zorunlu. Permission öğesinin üst kaynağı. Biçimler: tunedModels/{tunedModel} corpora/{corpus} corpora/{corpora} biçimindedir.

İstek içeriği

İstek metni, Permission öğesinin bir örneğini içerir.

Alanlar
granteeType enum (GranteeType)

İsteğe bağlı. Sabit. Bağış alan tarafın türü.

emailAddress string

İsteğe bağlı. Değişmez. Bu iznin ait olduğu kullanıcı veya grubun e-posta adresi. İznin veriliş türü HERKES olduğunda alan ayarlanmaz.

role enum (Role)

Zorunlu. Bu izinle verilen rol.

Örnek istek

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",
)

Yanıt gövdesi

Başarılı olursa yanıt gövdesi, yeni oluşturulmuş bir Permission örneğini içerir.

Yöntem: corpora.permissions.list

Belirli bir kaynağın izinlerini listeler.

Uç nokta

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

Yol parametreleri

parent string

Zorunlu. İzinlerin üst kaynağı. Biçimler: tunedModels/{tunedModel} corpora/{corpus} corpora/{corpora} biçimindedir.

Sorgu parametreleri

pageSize integer

İsteğe bağlı. Döndürülecek maksimum Permission sayısı (sayfa başına). Hizmet daha az izin döndürebilir.

Belirtilmemesi halinde en fazla 10 izin döndürülür. Bu yöntem, daha büyük pageSize iletseniz bile sayfa başına en fazla 1.000 izin döndürür.

pageToken string

İsteğe bağlı. Önceki bir permissions.list çağrısından alınan sayfa jetonu.

Bir istek tarafından döndürülen pageToken değerini, sonraki sayfayı almak için bir sonraki isteğe bağımsız değişken olarak sağlayın.

Sayfalandırma yaparken permissions.list parametresine sağlanan diğer tüm parametreler, sayfa jetonunu sağlayan çağrıyla eşleşmelidir.

İstek içeriği

İstek metni boş olmalıdır.

Örnek istek

Python

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

# ...

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

Yanıt gövdesi

Başarılıysa yanıt metni, ListPermissionsResponse öğesinin bir örneğini içerir.

Yöntem: corpora.permissions.get

Belirli bir izin hakkında bilgi alır.

Uç nokta

indir https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/permissions/*}

Yol parametreleri

name string

Zorunlu. İznin kaynak adı.

Biçimler: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} corpora/{corpora}/permissions/{permission} biçimindedir.

İstek içeriği

İstek metni boş olmalıdır.

Örnek istek

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)

Yanıt gövdesi

Başarılıysa yanıt metni, Permission öğesinin bir örneğini içerir.

Yöntem: Corpora.permissions.patch

İzni günceller.

Uç nokta

yama https://generativelanguage.googleapis.com/v1beta/{permission.name=corpora/*/permissions/*}

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

Yol parametreleri

permission.name string

Yalnızca çıkış. Tanımlayıcı. İzin adı. Oluşturma sırasında benzersiz bir ad oluşturulur. Örnekler: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Yalnızca çıkış. corpora/{corpora}/permissions/{permission} biçimindedir.

Sorgu parametreleri

updateMask string (FieldMask format)

Zorunlu. Güncellenecek alanların listesi. Kabul edilenler: - rol (Permission.role alan)

Bu, tam nitelikli alan adlarının virgülle ayrılmış bir listesidir. Örnek: "user.displayName,photo".

İstek içeriği

İstek metni, Permission öğesinin bir örneğini içerir.

Alanlar
role enum (Role)

Zorunlu. Bu izinle verilen rol.

Örnek istek

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()

Yanıt gövdesi

Başarılıysa yanıt metni, Permission öğesinin bir örneğini içerir.

Yöntem: Corpora.permissions.delete

İzni siler.

Uç nokta

delete https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/permissions/*}

Yol parametreleri

name string

Zorunlu. İznin kaynak adı. Biçimler: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} corpora/{corpora}/permissions/{permission} biçimindedir.

İstek içeriği

İstek metni boş olmalıdır.

Örnek istek

Python

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

public_permission = model_info.permissions.create(
    role="READER",
    grantee_type="EVERYONE",
)

public_permission.delete()

Yanıt gövdesi

Başarılı olursa yanıt gövdesi boş olur.

REST Kaynağı: Corpora.permissions

Kaynak: İzin

İzin kaynağı; kullanıcıya, gruba veya dünyanın geri kalanına PaLM API kaynağına (ör. hassaslaştırılmış bir model, topluluk) erişim izni verir.

Rol, kullanıcıların PaLM API kaynakları üzerinde belirli işlemleri gerçekleştirmesine olanak tanıyan izin verilen işlemler koleksiyonudur. Bunları kullanıcılar, gruplar veya hizmet hesaplarında kullanılabilir hale getirmek için roller atarsınız. Bir rol atadığınızda, rolün içerdiği izinleri verirsiniz.

Üç eş merkezli rol vardır. Her rol, önceki rolün izin verilen işlemlerinin bir üst kümesidir:

  • Okuyucu, kaynak (ör. ayarlanmış model, kitaplık) için çıkarım yapabilir
  • Yazar, okuyucunun izinlerine sahiptir ve ayrıca düzenleyebilir ve paylaşabilir.
  • sahibi, yazar izinlerine sahiptir ve ayrıca
'nı inceleyin.
Alanlar
name string

Yalnızca çıkış. Tanımlayıcı. İzin adı. Oluşturma sırasında benzersiz bir ad oluşturulur. Örnekler: TunedModels/{tunedModel}/permissions/{permission} Corpora/{Corpus}/permissions/{permission} Yalnızca çıkış.

granteeType enum (GranteeType)

İsteğe bağlı. Değişmez. Bağış alan tarafın türü.

emailAddress string

İsteğe bağlı. Değişmez. Bu iznin ait olduğu kullanıcı veya grubun e-posta adresi. İznin veriliş türü HERKES olduğunda alan ayarlanmaz.

role enum (Role)

Zorunlu. Bu izinle verilen rol.

JSON gösterimi
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}

GranteeType

Bu iznin verileni türlerini tanımlar.

Sıralamalar
GRANTEE_TYPE_UNSPECIFIED Varsayılan değerdir. Bu değer kullanılmamaktadır.
USER Bir kullanıcıyı temsil eder. Bu parametre ayarlandığında kullanıcı için emailAddress'i sağlamanız gerekir.
GROUP Bir grubu temsil eder. Ayarlandığında grup için emailAddress değerini sağlamanız gerekir.
EVERYONE Herkese erişimi temsil eder. Ek bilgi gerekmez.

Rol

Bu izinle verilen rolü tanımlar.

Sıralamalar
ROLE_UNSPECIFIED Varsayılan değer. Bu değer kullanılmamaktadır.
OWNER Sahibi kaynağı kullanabilir, güncelleyebilir, paylaşabilir ve silebilir.
WRITER Yazar, kaynağı kullanabilir, güncelleyebilir ve paylaşabilir.
READER Okuyucu kaynağı kullanabilir.

ListPermissionsResponse

ListPermissions tarafından gönderilen, izinlerin sayfalandırılmış listesini içeren yanıt.

Alanlar
permissions[] object (Permission)

İzinler geri verildi.

nextPageToken string

Sonraki sayfayı almak için pageToken olarak gönderilebilecek bir jeton.

Bu alan atlanırsa başka sayfa yoktur.

JSON gösterimi
{
  "permissions": [
    {
      object (Permission)
    }
  ],
  "nextPageToken": string
}