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

선택사항입니다. 변경할 수 없습니다. 이 권한이 참조하는 그룹 사용자의 이메일 주소입니다. 권한의 수혜자 유형이 EVERYONE인 경우 필드가 설정되지 않습니다.

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

특정 리소스에 대한 권한을 나열합니다.

엔드포인트

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 호출에서 받은 페이지 토큰입니다.

한 요청에서 반환된 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

특정 권한 정보를 가져옵니다.

엔드포인트

get 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

권한을 업데이트합니다.

엔드포인트

<ph type="x-smartling-placeholder"></ph> <ph type="x-smartling-placeholder"></ph> 패치 <ph type="x-smartling-placeholder"></ph> https://generativelanguage.googleapis.com/v1beta/{permission.name=corpora/*/permissions/*}

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

경로 매개변수

permission.name string

출력 전용입니다. 식별자. 권한 이름입니다. 생성 시 고유한 이름이 생성됩니다. 예: managedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} 출력 전용입니다. corpora/{corpora}/permissions/{permission} 형식이 사용됩니다.

쿼리 매개변수

updateMask string (FieldMask format)

필수 항목입니다. 업데이트할 필드 목록입니다. 허용된 역할: - 역할 (Permission.role 입력란)

정규화된 필드 이름의 쉼표로 구분된 목록입니다. 예: "user.displayName,photo"

요청 본문

요청 본문에 Permission의 인스턴스가 포함됩니다.

<ph type="x-smartling-placeholder">
</ph> 입력란 <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 리소스에서 특정 작업을 수행할 수 있도록 허용하는 작업의 모음입니다. 사용자, 그룹 또는 서비스 계정에서 사용할 수 있도록 하려면 역할을 할당합니다. 역할을 할당하면 역할에 포함된 권한을 부여하게 됩니다.

세 가지 역할이 있습니다. 각 역할은 이전 역할의 허용된 작업의 상위 집합입니다.

  • 리더가 추론에 리소스 (예: 조정된 모델, 코퍼스)를 사용할 수 있음
  • 작성자가 읽기 권한을 보유하고 있으며 추가로 수정 및 공유할 수 있습니다.
  • 소유자가 작성자 권한을 보유하고 있으며 추가로 삭제할 수 있음
를 통해 개인정보처리방침을 정의할 수 있습니다.
를 통해 개인정보처리방침을 정의할 수 있습니다. <ph type="x-smartling-placeholder">
</ph> 입력란 <ph type="x-smartling-placeholder">
</ph>
name string

출력 전용입니다. 식별자. 권한 이름입니다. 생성 시 고유한 이름이 생성됩니다. 예: tunedModels/{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)
}

GranteeType

이 권한의 피부여자 유형을 정의합니다.

열거형
GRANTEE_TYPE_UNSPECIFIED 기본값입니다. 이 값은 사용되지 않습니다.
USER 사용자를 나타냅니다. 설정하면 사용자의 emailAddress를 제공해야 합니다.
GROUP 그룹을 나타냅니다. 설정하면 그룹의 emailAddress를 제공해야 합니다.
EVERYONE 모든 사용자에 대한 액세스 권한을 나타냅니다. 추가 정보는 필요하지 않습니다.

역할

이 권한이 부여하는 역할을 정의합니다.

열거형
ROLE_UNSPECIFIED 기본값입니다. 이 값은 사용되지 않습니다.
OWNER 소유자는 리소스를 사용, 업데이트, 공유, 삭제할 수 있습니다.
WRITER 작성자가 리소스를 사용, 업데이트, 공유할 수 있습니다.
READER 리더가 리소스를 사용할 수 있습니다.

ListPermissionsResponse

페이징된 권한 목록이 포함된 ListPermissions의 응답입니다.

를 통해 개인정보처리방침을 정의할 수 있습니다. <ph type="x-smartling-placeholder">
</ph> 입력란 <ph type="x-smartling-placeholder">
</ph>
permissions[] object (Permission)

반환된 권한

nextPageToken string

다음 페이지를 검색하기 위해 pageToken으로 전송할 수 있는 토큰입니다.

이 필드를 생략하면 더 이상 페이지가 없습니다.

JSON 표현 
{
  "permissions": [
    {
      object (Permission)
    }
  ],
  "nextPageToken": string
}