Corpus Permissions

Phương thức: corpora.permissions.create

Tạo quyền đối với một tài nguyên cụ thể.

Điểm cuối

bài đăng https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/permissions

Tham số đường dẫn

parent string

Bắt buộc. Tài nguyên mẹ của Permission. Định dạng: tunedModels/{tunedModel} corpora/{corpus} Có dạng corpora/{corpora}.

Nội dung yêu cầu

Nội dung yêu cầu chứa một bản sao của Permission.

Trường
granteeType enum (GranteeType)

Không bắt buộc. Không thể thay đổi. Loại bên được cấp phép.

emailAddress string

Không bắt buộc. Bất biến. Địa chỉ email của người dùng nhóm có quyền này. Trường này không được đặt khi loại người được cấp quyền là MỌI NGƯỜI.

role enum (Role)

Bắt buộc. Vai trò được cấp theo quyền này.

Yêu cầu mẫu

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

Nội dung phản hồi

Nếu thành công, nội dung phản hồi sẽ chứa một thực thể Permission mới tạo.

Phương thức: corpora.permissions.list

Liệt kê các quyền của tài nguyên cụ thể.

Điểm cuối

nhận https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/permissions

Tham số đường dẫn

parent string

Bắt buộc. Tài nguyên mẹ của quyền. Định dạng: tunedModels/{tunedModel} corpora/{corpus} Có dạng corpora/{corpora}.

Tham số truy vấn

pageSize integer

Không bắt buộc. Số Permission giây tối đa cần trả về (trên mỗi trang). Dịch vụ có thể trả về ít quyền hơn.

Nếu bạn không chỉ định, hệ thống sẽ trả về tối đa 10 quyền. Phương thức này trả về tối đa 1.000 quyền trên mỗi trang, ngay cả khi bạn chuyển pageSize lớn hơn.

pageToken string

Không bắt buộc. Mã thông báo trang, nhận được từ lệnh gọi permissions.list trước đó.

Cung cấp pageToken do một yêu cầu trả về làm đối số cho yêu cầu tiếp theo để truy xuất trang tiếp theo.

Khi phân trang, tất cả các tham số khác được cung cấp cho permissions.list phải khớp với lệnh gọi đã cung cấp mã thông báo trang.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Yêu cầu mẫu

Python

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

# ...

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

Nội dung phản hồi

Nếu thành công, nội dung phản hồi sẽ chứa một phiên bản của ListPermissionsResponse.

Phương thức: corpora.permissions.get

Lấy thông tin về một Quyền cụ thể.

Điểm cuối

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

Tham số đường dẫn

name string

Bắt buộc. Tên tài nguyên của quyền.

Định dạng: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission}. Định dạng này có dạng corpora/{corpora}/permissions/{permission}.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Yêu cầu mẫu

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

Nội dung phản hồi

Nếu thành công, nội dung phản hồi sẽ chứa một phiên bản của Permission.

Phương thức: corpora.permissions.patch

Cập nhật quyền.

Điểm cuối

bản vá https://generativelanguage.googleapis.com/v1beta/{permission.name=corpora/*/permissions/*}

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

Tham số đường dẫn

permission.name string

Chỉ có đầu ra. Giá trị nhận dạng. Tên quyền. Một tên duy nhất sẽ được tạo khi tạo. Ví dụ: TuningModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Mã này có dạng corpora/{corpora}/permissions/{permission}.

Tham số truy vấn

updateMask string (FieldMask format)

Bắt buộc. Danh sách các trường cần cập nhật. Những quyền được chấp nhận: – vai trò (trường Permission.role)

Đây là danh sách các tên trường đủ điều kiện được phân tách bằng dấu phẩy. Ví dụ: "user.displayName,photo"

Nội dung yêu cầu

Nội dung yêu cầu chứa một bản sao của Permission.

Trường
role enum (Role)

Bắt buộc. Vai trò được cấp bằng quyền này.

Yêu cầu mẫu

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

Nội dung phản hồi

Nếu thành công, nội dung phản hồi sẽ chứa một phiên bản của Permission.

Phương thức: corpora.permissions.delete

Xoá quyền đó.

Điểm cuối

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

Tham số đường dẫn

name string

Bắt buộc. Tên tài nguyên của quyền. Định dạng: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Có dạng corpora/{corpora}/permissions/{permission}.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Yêu cầu mẫu

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

Nội dung phản hồi

Nếu thành công, nội dung phản hồi sẽ trống.

Tài nguyên REST: corpora.permissions

Tài nguyên: Quyền

Tài nguyên cấp quyền cấp cho người dùng, nhóm người dùng hoặc những người khác trên thế giới quyền truy cập vào tài nguyên PaLM API (ví dụ: mô hình được điều chỉnh, tập sao lục).

Vai trò là tập hợp các thao tác được phép, cho phép người dùng thực hiện các thao tác cụ thể trên các tài nguyên PaLM API. Để cung cấp các quyền này cho người dùng, nhóm hoặc tài khoản dịch vụ, bạn chỉ định vai trò. Khi chỉ định một vai trò, bạn sẽ cấp các quyền có trong vai trò đó.

Có 3 vai trò đồng tâm. Mỗi vai trò là tập mẹ của các thao tác được phép của vai trò trước đó:

  • người đọc có thể sử dụng tài nguyên (ví dụ: mô hình được điều chỉnh, tập sao lục) để suy luận
  • writer có các quyền của reader và ngoài ra có thể chỉnh sửa và chia sẻ
  • chủ sở hữu có quyền của người viết và có thể xoá thêm
Số trường
name string

Chỉ có đầu ra. Giá trị nhận dạng. Tên quyền. Hệ thống sẽ tạo một tên duy nhất khi bạn tạo. Ví dụ: TuningModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission}

granteeType enum (GranteeType)

Không bắt buộc. Không thể thay đổi. Loại người nhận tài trợ.

emailAddress string

Không bắt buộc. Bất biến. Địa chỉ email của người dùng nhóm có quyền này. Trường này không được đặt khi loại người được cấp quyền là MỌI NGƯỜI.

role enum (Role)

Bắt buộc. Vai trò được cấp bằng quyền này.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}

GranteeType

Xác định các loại người được cấp quyền này.

Enum
GRANTEE_TYPE_UNSPECIFIED Giá trị mặc định. Giá trị này không được sử dụng.
USER Biểu thị một người dùng. Khi đặt giá trị này, bạn phải cung cấp emailAddress cho người dùng.
GROUP Đại diện cho một nhóm. Khi đặt giá trị này, bạn phải cung cấp emailAddress cho nhóm.
EVERYONE Biểu thị quyền truy cập của mọi người. Bạn không cần phải cung cấp thêm thông tin.

Vai trò

Xác định vai trò được cấp bởi quyền này.

Enum
ROLE_UNSPECIFIED Giá trị mặc định. Giá trị này chưa được sử dụng.
OWNER Chủ sở hữu có thể sử dụng, cập nhật, chia sẻ và xoá tài nguyên.
WRITER Người viết có thể sử dụng, cập nhật và chia sẻ tài nguyên.
READER Trình đọc có thể sử dụng tài nguyên.

ListPermissionsResponse

Phản hồi của ListPermissions chứa danh sách các quyền được phân trang.

Trường
permissions[] object (Permission)

Đã trả lại quyền.

nextPageToken string

Mã thông báo có thể được gửi dưới dạng pageToken để truy xuất trang tiếp theo.

Nếu bạn bỏ qua trường này, thì sẽ không có trang nào khác.

Biểu diễn dưới dạng JSON 
{
  "permissions": [
    {
      object (Permission)
    }
  ],
  "nextPageToken": string
}