OpenAI
Эта страница была переведена машинным переводом. Открыть оригинальную статью на английском.

Управление проектами на платформе API

Создавайте проекты API и управляйте ими: доступом участников, сервисными аккаунтами, ключами API, доступом к моделям, использованием и лимитами расходов.

Обновлено: 10 days ago

Обзор

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

Владельцы организации могут просматривать все активные и архивные проекты на странице «Проекты».

Image

Прежде чем начать

Для создания проекта необходима роль владельца организации. По умолчанию организации могут создавать до 2 000 проектов.

Если ваша организация использует консолидированный биллинг, дочерние организации отображаются отдельно в меню выбора организации. Создавать проекты в дочерних организациях нельзя.

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

Projects page with the organization switcher open, listing Personal and Staging organizations
Image

Проект по умолчанию

В каждой организации есть проект по умолчанию, который нельзя удалить. Он наследует все настройки организации. Вы можете настроить для него лимиты запросов, права доступа к виртуальным моделям и лимиты расходов.

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

Создание проекта

  1. Откройте меню выбора проекта и нажмите Создать проект.

  2. Укажите название, описание и сайт проекта.

  3. Нажмите Создать.

API platform project menu with Create project highlighted under Default project
Create a new project dialog in the API platform with fields for project name, use case, and business website

Владельцы организации автоматически становятся владельцами новых проектов.

Роли и права доступа

В таблице приведены краткие сведения о ролях владельца и читателя организации, а также владельца и участника проекта, упомянутых в этих инструкциях. Права участников проекта схожи с правами читателей организации.

РольОбласть действияПрава
ВладелецОрганизацияСоздание и просмотр всех проектов, пользователей и ключей API. Отслеживание проектов на странице «Проекты». Настройка лимитов расходов организации и проектов. Предоставление доступа к данным об использовании других пользователей. Архивация проектов.
ЧитательОрганизацияМожет быть добавлен в проекты, выполнять инференс, использовать ресурсы и создавать ключи в этих проектах. Не может создавать проекты и управлять пользователями.
ВладелецПроектВсе права участника, а также добавление пользователей, управление участниками и настройками проекта, переименование проекта, настройка его лимитов расходов и архивация.
УчастникПроектВыполнение инференса, использование ресурсов, создание ключей уровня проекта и отправка запросов API на чтение или изменение данных.

Подробнее о ролях в организации см. в статье «Роли в организации». Сведения о дополнительных и пользовательских ролях, а также полный список прав см. в руководстве по ролям и правам доступа к API.

Видимость проектов

При использовании этих стандартных ролей пользователи, не являющиеся владельцами организации, видят только те проекты, в которых состоят. Владельцы организации видят все проекты, участников и ключи API уровня проекта, а также имеют доступ к странице «Проекты».

Участники проекта видят других участников своего проекта и их роли. Только участники проекта и владельцы организации могут видеть дообученные модели, ветки диалогов с ассистентами и файлы, созданные или добавленные в этом проекте.

Вы можете состоять в любом количестве проектов. Личный ключ API, созданный в проекте, действует только в рамках этого проекта и его ресурсов.

Границы доступа к ресурсам

Файлы, ассистенты, хранилище и ветки диалогов доступны только в рамках своего проекта. Участники без прав администратора, не входящие в проект, не могут получить доступ к его ресурсам. Перемещать ресурсы между проектами нельзя.

Исключение — дообученные модели в проекте по умолчанию: они доступны из других проектов.

Управление участниками проекта

Приглашение пользователя в организацию

Прежде чем добавить пользователя в проект, нужно включить его в вашу организацию.

Приглашая пользователя в организацию, вы можете предоставить ему доступ к проекту по умолчанию, выбрав соответствующий параметр в форме приглашения. Не выбирайте этот параметр, если не хотите предоставлять доступ к проекту по умолчанию. Новые участники организации не добавляются в проект по умолчанию автоматически.

Для приглашения пользователя не нужно предварительно создавать другой проект. Вы также можете добавить пользователя в проект после того, как он примет приглашение в организацию.

На приглашения, отправляемые через Admin API, распространяются правила для конечной точки /organization/invites.

Добавление участника организации в проект

Владельцы организации и проекта могут добавлять участников:

  1. Перейдите в настройки организации.

  2. Выберите проект и откройте раздел Участники.

  3. Нажмите + Добавить участника.

  4. Выберите пользователя и назначьте ему роль Участник или Владелец.

В списке отображаются пользователи организации с ролью «Читатель». Сервисные аккаунты в этот список не входят.

Project members with Add team members dialog assigning a user the Member role

Если не удалось отправить приглашение через интерфейс или Admin API, перед повторной отправкой убедитесь, что целевой проект существует и не находится в архиве.

Изменение роли или удаление участника

Владельцы организации и проекта могут изменить роль пользователя в проекте или удалить его из этого проекта.

  1. Перейдите в настройки организации.

  2. Выберите проект и откройте раздел Участники.

  3. Назначьте пользователю роль Участник или Владелец либо нажмите Удалить, чтобы удалить его из проекта.

Создание сервисных аккаунтов и управление ими

Сервисный аккаунт предоставляет доступ системам, а не представляет отдельного пользователя. Сервисные аккаунты действуют только в рамках своих проектов.

Для создания сервисных аккаунтов необходимы права на управление ими. Эти права есть у владельцев организации и проекта.

Создание сервисного аккаунта

  1. Выберите проект в меню выбора проекта.

  2. Перейдите в настройки организации и выберите проект.

  3. Откройте раздел Участники и нажмите + Сервисный аккаунт.

  4. Введите уникальный идентификатор сервисного аккаунта, используя буквы, цифры и дефисы.

  5. Нажмите Создать.

API platform project switcher open with options to create a project or manage projects

Сервисные аккаунты, созданные на уровне проекта, уникальны для проекта и не могут использоваться за пределами проекта, в котором они созданы.

Project Members page with Create a service account dialog after selecting the Service account option

Для идентификатора используется один и тот же формат независимо от того, создаете ли вы сервисный аккаунт в настройках организации или проекта.

Сервисный аккаунт, созданный для проекта, привязан только к этому проекту и не может использоваться за его пределами.

Сохранение секретного ключа

При создании сервисного аккаунта сразу создается ключ API и отображается его секретное значение. Сохраните секретный ключ в надежном месте. Повторно просмотреть его в аккаунте OpenAI будет невозможно. Если вы потеряете ключ, создайте новый.

Members page with Save your key modal after creating a service account

По умолчанию ключ сервисного аккаунта дает доступ на чтение и запись ко всем ресурсам API в его проекте. Впоследствии эти права можно изменить в разделе Ключи API в настройках проекта.

Изменение или удаление сервисного аккаунта

Сервисные аккаунты отображаются вместе с пользователями в разделе Участники в настройках проекта. Для управления их доступом к проекту изменяйте роли или удаляйте аккаунты так же, как и для других участников проекта.

Все сервисные аккаунты также отображаются вместе с пользователями на странице «Участники» организации, в том числе аккаунты, созданные в настройках организации и проекта.

В меню «Участники» организации можно изменить роль сервисного аккаунта или нажать Удалить.

OpenAI API Members settings with a service account role menu open for Reader or Owner

Создание ключей API и управление ими

У каждого проекта есть собственные ключи API:

  1. Перейдите в настройки организации.

  2. Выберите проект и откройте раздел Ключи API.

  3. Нажмите + Создать новый секретный ключ, чтобы создать ключ, или значок редактирования рядом с существующим ключом, чтобы изменить его права доступа.

API keys page for a project with the Create new secret key button highlighted

Выбор прав доступа для ключа

Для ключей, принадлежащих пользователям, права доступа можно задать при создании или изменить позже:

  • Все: полный доступ. Это значение по умолчанию.

  • Ограниченные: выбор прав доступа к отдельным ресурсам или конечным точкам. Доступные варианты зависят от ресурса и могут включать Нет доступа, Чтение, Запись или права для отдельных типов запросов.

  • Только чтение: права на чтение для всех конечных точек.

Например, ключ с ограниченными правами может исключать доступ на чтение и запись к конечной точке /v1/assistants.

Create new secret key dialog in the API platform with Restricted permissions selected

Для создания ключей сервисных аккаунтов необходимы права на управление сервисными аккаунтами. Если этот параметр не отображается, попросите владельца организации или проекта создать ключ сервисного аккаунта. В диалоговом окне создания ключа эти настройки прав доступа не отображаются для ключей сервисных аккаунтов. Изменить их права можно после создания в разделе Ключи API в настройках проекта.

Настройка доступа к моделям и лимитов запросов

Для управления лимитами запросов проекта необходимы права администратора. Эти права есть у владельцев организации. Владельцы проектов также могут управлять лимитами запросов своих проектов через API управления.

  1. Перейдите в настройки организации.

  2. Выберите проект и откройте раздел Лимиты.

  3. В разделе Использование моделей выберите модели, доступные для проекта.

  4. При необходимости задайте лимит запросов для каждой модели.

Настройка лимитов расходов и уведомлений

Месячные лимиты расходов на API доступны как на уровне организации, так и на уровне проекта. Для изменения лимита необходимы права на управление настройками соответствующей организации или проекта.

Лимит расходов позволяет отслеживать затраты без блокировки запросов. Активируйте параметр Включить режим жесткого лимита, чтобы запросы API завершались ошибкой, когда учтенные расходы достигнут лимита. Блокировка срабатывает не мгновенно, поэтому учтенные расходы могут немного превышать заданную сумму.

Уведомления о расходах сообщают о достижении порога, но не блокируют запросы.

Настройка лимита расходов организации

  1. Перейдите в настройки организации.

  2. Откройте раздел Лимиты и найдите подраздел Расходы.

Project Limits page with organization budget controls, usage alerts, and model rate limits table

Настройка лимита расходов проекта

  1. Перейдите в настройки организации.

  2. Выберите проект и откройте раздел Лимиты.

  3. Задайте значения в полях Лимит месячных расходов и Уведомлять, когда расходы достигнут.

  4. Активируйте параметр Включить режим жесткого лимита, чтобы блокировать запросы API, когда учтенные расходы достигнут лимита.

На этой странице также можно изменить настройки в разделе Использование моделей.

Управление уведомлениями о расходах

При создании лимита расходов проекта по умолчанию также создается уведомление о достижении 100% лимита. Нажмите Добавить уведомление, чтобы настроить уведомления для других порогов.

Уведомления о расходах проекта получают владельцы организации и проекта. В настройках уведомлений можно добавить адреса электронной почты других получателей.

Project Limits page with Add budget alert dialog set to notify at 90% budget usage

Актуальные инструкции по настройке и описание того, как применяются лимиты, см. в руководстве по лимитам расходов.

Просмотр данных об использовании и платежах

Данные об использовании можно просматривать в разбивке по проектам, а также просматривать платежную информацию и задавать лимиты расходов для отдельных проектов.

Доступ к панели использования проекта зависит от вашей роли в организации и настроек видимости панели использования. Сама по себе роль владельца проекта не дает такого доступа.

Project setting for Usage dashboard visibility with Visible to organization owners selected

Если вы не видите панель использования проекта, проверьте, не задано ли для видимости значение Видно владельцам организации.

Управление хранилищем файлов

Каждому проекту выделяется 100 ГБ для хранения файлов. При превышении этого объема может появиться следующая ошибка:

Вы превысили квоту на хранение файлов. Для организаций объем хранимых файлов ограничен 100 ГБ. Уменьшите размер файла или обратитесь в службу поддержки.

Удалите неиспользуемые файлы, чтобы освободить место. Вы можете получить список сохраненных файлов через API, чтобы найти те, которые больше не нужны.

Архивация проекта

Владельцы организации и проекта могут архивировать проекты на странице «Проекты» или в настройках отдельного проекта. При запросе подтверждения введите название проекта.

Архивация необратима: архивный проект нельзя восстановить.

Чтобы просмотреть архивные проекты, откройте вкладку Архивные на странице «Проекты».

API platform Projects page with the Archived tab selected to view archived projects

Единственное исключение заключается в том, что файнтюны в «Проекте по умолчанию» доступны из других проектов.

Вы превысили квоту на хранение файлов. Для организаций действует ограничение в 100 ГБ файлов. Уменьшите размер файлов или обратитесь в поддержку.

Проекты нельзя удалить. OpenAI сохраняет их историю для учета использования и платежей.

Была ли эта статья полезной?