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 )

Необязательный. Неизменяемый. Тип грантополучателя.

string emailAddress

Необязательный. Неизменяемый. Адрес электронной почты пользователя группы, к которому относится это разрешение. Поле не задается, если типом получателя разрешения является ВСЕ.

перечисление role enum ( Role )

Необходимый. Роль, предоставленная этим разрешением.

Пример запроса

Питон 

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

Перечисляет разрешения для конкретного ресурса.

Конечная точка

получите https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/permissions

Параметры пути

parent string

Необходимый. Родительский ресурс разрешений. Форматы: tunedModels/{tunedModel} corpora/{corpus} Он принимает форму corpora/{corpora} .

Параметры запроса

pageSize integer

Необязательный. Максимальное количество возвращаемых Permission (на страницу). Служба может возвращать меньше разрешений.

Если не указано, будет возвращено не более 10 разрешений. Этот метод возвращает не более 1000 разрешений на страницу, даже если вы передаете больший размер страницы.

string pageToken

Необязательный. Токен страницы, полученный в результате предыдущего вызова permissions.list .

Предоставьте pageToken возвращенный одним запросом, в качестве аргумента для следующего запроса для получения следующей страницы.

При разбиении на страницы все остальные параметры, предоставленные в permissions.list должны соответствовать вызову, который предоставил токен страницы.

Тело запроса

Тело запроса должно быть пустым.

Пример запроса

Питон 

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

Получает информацию о конкретном Разрешении.

Конечная точка

получите https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/permissions/*}

Параметры пути

string name

Необходимый. Имя ресурса разрешения.

Форматы: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Он принимает форму corpora/{corpora}/permissions/{permission} .

Тело запроса

Тело запроса должно быть пустым.

Пример запроса

Питон 

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

Обновляет разрешение.

Конечная точка

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

Параметры пути

string permission.name

Только вывод. Идентификатор. Имя разрешения. Уникальное имя будет сгенерировано при создании. Примеры: TunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Только вывод. Он принимает форму corpora/{corpora}/permissions/{permission} .

Параметры запроса

строка updateMask string ( FieldMask format)

Необходимый. Список полей для обновления. Принимаются: - роль (поле Permission.role )

Это разделенный запятыми список полных имен полей. Пример: "user.displayName,photo" .

Тело запроса

Тело запроса содержит экземпляр Permission .

Поля
перечисление role enum ( Role )

Необходимый. Роль, предоставленная этим разрешением.

Пример запроса

Питон 

        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/*}

Параметры пути

string name

Необходимый. Имя ресурса разрешения. Форматы: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Он принимает форму corpora/{corpora}/permissions/{permission} .

Тело запроса

Тело запроса должно быть пустым.

Пример запроса

Питон 

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

Ресурс: Разрешение

Ресурс разрешения предоставляет пользователю, группе или остальному миру доступ к ресурсу API PaLM (например, настроенной модели, корпусу).

Роль — это набор разрешенных операций, который позволяет пользователям выполнять определенные действия с ресурсами PaLM API. Чтобы сделать их доступными для пользователей, групп или учетных записей служб, вы назначаете роли. Назначая роль, вы предоставляете разрешения, которые содержит эта роль.

Есть три концентрические роли. Каждая роль представляет собой расширенный набор разрешенных операций предыдущей роли:

  • читатель может использовать ресурс (например, настроенную модель, корпус) для вывода
  • писатель имеет права читателя и, кроме того, может редактировать и делиться
  • владелец имеет права записи и, кроме того, может удалять
Поля
string name

Только вывод. Идентификатор. Имя разрешения. Уникальное имя будет сгенерировано при создании. Примеры: TunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Только вывод.

granteeType enum ( GranteeType )

Необязательный. Неизменяемый. Тип грантополучателя.

string emailAddress

Необязательный. Неизменяемый. Адрес электронной почты пользователя группы, к которому относится это разрешение. Поле не задается, если типом получателя разрешения является ВСЕ.

перечисление role enum ( Role )

Необходимый. Роль, предоставленная этим разрешением.

JSON-представление 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}

Тип получателя гранта

Определяет типы получателя этого разрешения.

Перечисления
GRANTEE_TYPE_UNSPECIFIED Значение по умолчанию. Это значение не используется.
USER Представляет пользователя. Если этот параметр установлен, вы должны предоставить пользователю адрес электронной почты.
GROUP Представляет группу. Если этот параметр установлен, вы должны указать адрес электронной почты для группы.
EVERYONE Представляет доступ для всех. Никакой дополнительной информации не требуется.

Роль

Определяет роль, предоставляемую этим разрешением.

Перечисления
ROLE_UNSPECIFIED Значение по умолчанию. Это значение не используется.
OWNER Владелец может использовать, обновлять, делиться и удалять ресурс.
WRITER Writer может использовать, обновлять и делиться ресурсом.
READER Читатель может воспользоваться ресурсом.

ListPermissionsResponse

Ответ от ListPermissions содержащий список разрешений с разбивкой на страницы.

Поля
объект permissions[] object ( Permission )

Возвращены разрешения.

nextPageToken string PageToken

Токен, который можно отправить как pageToken для получения следующей страницы.

Если это поле опущено, страниц больше нет.

JSON-представление 
{
  "permissions": [
    {
      object (Permission)
    }
  ],
  "nextPageToken": string
}