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

# With Gemini 2 we're launching a new SDK. See the following doc for details.
# https://ai.google.dev/gemini-api/docs/migrate
README.md

响应正文

如果成功，响应正文将包含一个新创建的 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 较大，此方法每页最多也只会返回 1000 项权限。

pageToken string

可选。从之前的 permissions.list 调用接收的页面令牌。

将一个请求返回的 pageToken 作为实参提供给下一个请求，以检索下一页。

进行分页时，提供给 permissions.list 的所有其他参数必须与提供页面令牌的调用匹配。

请求正文

请求正文必须为空。

示例请求

Python

# With Gemini 2 we're launching a new SDK. See the following doc for details.
# https://ai.google.dev/gemini-api/docs/migrate
README.md

响应正文

如果成功，则响应正文包含一个 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

# With Gemini 2 we're launching a new SDK. See the following doc for details.
# https://ai.google.dev/gemini-api/docs/migrate
README.md

响应正文

如果成功，则响应正文包含一个 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

仅限输出。标识符。权限名称。系统会在创建时生成一个唯一名称。示例：tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} 仅限输出。其格式为 corpora/{corpora}/permissions/{permission}。

查询参数

updateMask string (FieldMask format)

必需。要更新的字段的列表。接受的：- role（Permission.role 字段）

这是完全限定字段名称的逗号分隔列表。示例："user.displayName,photo"。

请求正文

请求正文包含一个 Permission 实例。

字段
role enum (Role)

必需。此权限所授予的角色。

示例请求

Python

# With Gemini 2 we're launching a new SDK. See the following doc for details.
# https://ai.google.dev/gemini-api/docs/migrate
README.md

响应正文

如果成功，则响应正文包含一个 Permission 实例。

方法：corpora.permissions.delete

删除权限。

端点

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

路径参数

name string

必需。相应权限的资源名称。格式：tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} 采用 corpora/{corpora}/permissions/{permission} 格式。

请求正文

请求正文必须为空。

示例请求

Python

# With Gemini 2 we're launching a new SDK. See the following doc for details.
# https://ai.google.dev/gemini-api/docs/migrate
README.md

响应正文

如果成功，则响应正文为空的 JSON 对象。

REST 资源：corpora.permissions

资源：Permission

权限资源用于授予用户、群组或全球其他用户对 PaLM API 资源（例如经过调优的模型、语料库）的访问权限。

角色是一组允许的操作，可让用户对 PaLM API 资源执行特定操作。如需向用户、群组或服务账号提供这些权限，您需要分配角色。分配角色时，您会授予该角色包含的权限。

有三个同心角色。每个角色都是前一个角色允许的操作的超集：

  • 读者可以使用资源（例如调优后的模型、语料库）进行推理
  • 写入者拥有读者的权限，此外还可以修改和共享内容
  • 所有者拥有写入者权限，此外还可以删除
字段
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 的响应，包含分页的权限列表。

字段
permissions[] object (Permission)

返回的权限。

nextPageToken string

可作为 pageToken 发送并用于检索下一页的令牌。

如果省略此字段，则没有更多页面。

JSON 表示法 
{
  "permissions": [
    {
      object (Permission)
    }
  ],
  "nextPageToken": string
}