OpenAI
Esta página foi traduzida automaticamente. Veja o artigo original em inglês.

Como gerenciar projetos na plataforma da API

Crie e gerencie projetos de API, incluindo acesso de membros, contas de serviço, chaves de API, acesso a modelos, uso e limites de gastos.

Atualizado: 5 days ago

Visão geral

Os projetos organizam o trabalho dentro de uma organização da API. Use os projetos para gerenciar o acesso, configurar limites de modelos e limites de taxa, criar contas de serviço e acompanhar o uso, o faturamento e os limites de gastos de um conjunto definido de recursos, como modelos, funcionalidades, threads, assistentes, ajuste fino e armazenamento.

Os proprietários da organização podem visualizar todos os projetos ativos e arquivados na página Projetos.

Image

Antes de começar

Você precisa ter a função de proprietário da organização para criar um projeto. Por padrão, as organizações podem criar até 2.000 projetos.

Se sua organização usa faturamento consolidado, as suborganizações aparecem separadamente no seletor de organizações. Não é possível criar projetos dentro de uma suborganização.

Para mudar de organização, abra o seletor de organizações e selecione a organização que deseja usar.

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

Projeto Padrão

Toda organização inclui um projeto Padrão, que não pode ser excluído. Ele herda toda a configuração da organização. Você pode configurar seus limites de taxa, permissões de modelos virtuais e limites de gastos.

Não é possível adicionar membros ou contas de serviço diretamente ao projeto Padrão. Você pode incluir o acesso ao projeto Padrão ao convidar alguém para a organização, seguindo as etapas de convite para a organização descritas neste artigo.

Criar um projeto

  1. Abra o seletor de projetos e selecione Criar projeto.

  2. Insira um nome, uma descrição e um site para seu projeto.

  3. Selecione Criar.

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

Os proprietários da organização são adicionados automaticamente como proprietários aos novos projetos.

Entender as funções e o acesso

A tabela resume as funções de proprietário e leitor da organização e de proprietário e membro do projeto usadas nestas etapas. Os membros do projeto têm permissões semelhantes às dos leitores da organização.

FunçãoEscopoPermissões
ProprietárioOrganizaçãoCriar e visualizar todos os projetos, usuários e chaves de API. Monitorar projetos na página Projetos. Definir limites de gastos da organização e dos projetos. Conceder acesso às informações de uso de outros usuários. Arquivar projetos.
LeitorOrganizaçãoSer adicionado a projetos, realizar inferências, usar recursos e criar chaves nesses projetos. Não pode criar projetos nem gerenciar usuários.
ProprietárioProjetoTodas as permissões de membro, além de adicionar usuários, gerenciar membros e configurações do projeto, renomeá-lo, definir seus limites de gastos e arquivá-lo.
MembroProjetoRealizar inferências, usar recursos, criar chaves no nível do projeto e fazer solicitações à API que leiam ou modifiquem dados.

Para saber mais sobre as funções na organização, consulte: funções na organização. Para conhecer outras funções, funções personalizadas e todas as permissões, consulte o guia de funções e permissões da API.

Visibilidade dos projetos

Com essas funções padrão, os usuários que não são proprietários da organização só podem ver os projetos dos quais fazem parte. Os proprietários da organização podem ver todos os projetos, membros e chaves de API de cada projeto, além de acessar a página Projetos.

Os membros do projeto podem ver os outros membros do projeto e a função de cada um. Somente os membros do projeto e os proprietários da organização podem ver os modelos com ajuste fino, as threads de assistentes e os arquivos criados ou adicionados nesse projeto.

Você pode fazer parte de quantos projetos precisar. Uma chave de API pessoal criada dentro de um projeto fica restrita a esse projeto e aos seus recursos.

Escopo dos recursos

Arquivos, assistentes, armazenamento e threads ficam restritos ao projeto a que pertencem. Membros de fora desse projeto que não sejam administradores não podem acessar seus recursos, e os recursos não podem ser movidos entre projetos.

Os modelos com ajuste fino no projeto Padrão são uma exceção: eles podem ser acessados a partir de outros projetos.

Gerenciar membros do projeto

Convidar alguém para sua organização

Uma pessoa precisa fazer parte da sua organização antes que você possa adicioná-la a um projeto.

Ao convidar alguém para a organização, você pode incluir o acesso ao projeto Padrão selecionando essa opção no formulário de convite. Deixe a opção desmarcada se não quiser conceder acesso ao projeto Padrão. Novos membros da organização não são adicionados automaticamente ao projeto Padrão.

Você não precisa criar outro projeto antes de convidar alguém. Você também pode adicionar alguém a um projeto depois que a pessoa aceitar o convite para a organização.

Convites enviados pela API de administração seguem as regras do endpoint /organization/invites.

Adicionar um membro da organização a um projeto

Os proprietários da organização e do projeto podem adicionar membros:

  1. Acesse as configurações da organização.

  2. Selecione o projeto e abra Membros.

  3. Selecione + Adicionar membro.

  4. Selecione o usuário e atribua a função de Membro ou Proprietário.

A lista de usuários mostra os usuários da organização com a função de Leitor. Ela não inclui contas de serviço.

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

Se um convite falhar na interface ou na API de administração, confirme se o projeto de destino existe e não está arquivado antes de reenviar o convite.

Alterar uma função ou remover um membro

Os proprietários da organização e do projeto podem alterar a função de um usuário no projeto ou removê-lo desse projeto.

  1. Acesse as configurações da organização.

  2. Selecione o projeto e abra Membros.

  3. Defina a função do usuário como Membro ou Proprietário, ou selecione Remover para removê-lo.

Criar e gerenciar contas de serviço

Uma conta de serviço fornece acesso para sistemas, em vez de representar um usuário individual. As contas de serviço ficam restritas aos seus projetos.

A criação de contas de serviço exige permissões de gerenciamento de contas de serviço. Os proprietários da organização e do projeto têm essas permissões.

Criar uma conta de serviço

  1. Escolha o projeto no seletor de projetos.

  2. Acesse as configurações da organização e selecione o projeto.

  3. Abra Membros e selecione + Conta de serviço.

  4. Insira um ID exclusivo para a conta de serviço usando letras, números e hífens.

  5. Selecione Criar.

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

As contas de serviço criadas no nível do projeto são exclusivas do projeto e não podem ser usadas fora do projeto em que são criadas.

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

O mesmo formato de ID se aplica tanto às contas de serviço criadas nas configurações da organização quanto às criadas nas configurações do projeto.

Uma conta de serviço criada para um projeto é exclusiva desse projeto e não pode ser usada fora dele.

Salvar a chave secreta

Ao criar a conta de serviço, uma chave de API é criada imediatamente e sua chave secreta é exibida. Salve a chave secreta em um local seguro. Você não poderá visualizá-la novamente pela sua conta da OpenAI. Se você a perder, gere uma nova chave.

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

Por padrão, a chave da conta de serviço permite ler e gravar em todos os recursos da API no projeto ao qual pertence. Você pode alterar essas permissões depois nas configurações de Chaves de API do projeto.

Atualizar ou remover uma conta de serviço

As contas de serviço aparecem junto com os usuários nas configurações de Membros do projeto. Gerencie o acesso dessas contas ao projeto seguindo as mesmas etapas de alteração de função e remoção dos demais membros do projeto.

Todas as contas de serviço também aparecem junto com os usuários na página Membros da organização, incluindo as contas criadas nas configurações da organização e do projeto.

No menu Membros da organização, você pode alterar a função de uma conta de serviço ou selecionar Remover.

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

Criar e gerenciar chaves de API

Cada projeto tem suas próprias chaves de API:

  1. Acesse as configurações da organização.

  2. Selecione o projeto e abra Chaves de API.

  3. Selecione + Criar nova chave secreta para criar uma chave ou selecione o ícone de edição ao lado de uma chave existente para alterar suas permissões.

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

Escolher as permissões da chave

Para chaves pertencentes a usuários, você pode definir as permissões ao criar uma chave ou editá-las depois:

  • Todas: permissões completas. Esta é a opção padrão.

  • Restritas: escolha os escopos para recursos ou endpoints específicos. As opções disponíveis dependem do recurso e podem incluir Nenhuma, Leitura, Gravação ou permissões específicas para cada solicitação.

  • Somente leitura: permissões de leitura para todos os endpoints.

Por exemplo, uma chave restrita pode excluir o acesso de leitura e gravação ao endpoint /v1/assistants.

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

A criação de chaves de contas de serviço exige permissões de gerenciamento de contas de serviço. Se essa opção não aparecer, peça a um proprietário da organização ou do projeto que crie a chave da conta de serviço. A caixa de diálogo de criação de chaves não mostra esses controles de permissão para chaves de contas de serviço; altere as permissões depois nas configurações de Chaves de API do projeto.

Configurar o acesso a modelos e os limites de taxa

O gerenciamento dos limites de taxa do projeto exige permissões administrativas. Os proprietários da organização têm essas permissões, e os proprietários do projeto também podem gerenciar os limites de taxa do projeto pela API de gerenciamento.

  1. Acesse as configurações da organização.

  2. Selecione o projeto e abra Limites.

  3. Use Uso de modelos para escolher quais modelos o projeto pode usar.

  4. Defina um limite de taxa para cada modelo conforme necessário.

Definir limites de gastos e alertas

Os limites de gastos mensais com a API estão disponíveis tanto no nível da organização quanto no do projeto. Para alterar um limite, você precisa de permissão para gerenciar as configurações da organização ou do projeto em questão.

Um limite de gastos pode monitorar os gastos sem interromper as solicitações. Ative Aplicar um limite rígido se quiser que as solicitações à API falhem quando os gastos contabilizados atingirem o limite. A aplicação do limite não é instantânea, então os gastos registrados podem exceder um pouco o valor configurado.

Os alertas de gastos notificam você quando um valor definido é atingido; eles não interrompem as solicitações.

Definir um limite de gastos para a organização

  1. Acesse as configurações da organização.

  2. Abra Limites e encontre Gastos.

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

Definir um limite de gastos para um projeto

  1. Acesse as configurações da organização.

  2. Selecione o projeto e abra Limites.

  3. Defina os valores de Limite de gastos mensais e Alertar quando os gastos atingirem.

  4. Ative Aplicar um limite rígido se quiser interromper o tráfego da API quando os gastos contabilizados atingirem o limite.

Você também pode alterar o Uso de modelos nesta página.

Gerenciar alertas de gastos

Ao criar um limite de gastos para um projeto, também é criado, por padrão, um alerta para quando os gastos atingirem 100% do limite. Selecione Adicionar alerta para adicionar alertas em outros patamares de gastos.

Os proprietários da organização e do projeto recebem alertas de gastos do projeto. Você pode adicionar outros destinatários de e-mail nas configurações de alertas.

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

Para consultar as etapas atuais de configuração e entender como os limites são aplicados, veja o guia de limites de gastos.

Visualizar uso e faturamento

A atividade de uso pode ser detalhada por projeto, e você pode visualizar o faturamento e definir limites de gastos para cada projeto.

O acesso ao Painel de uso de um projeto depende da sua função na organização e das configurações de visibilidade do Painel de uso. Ser proprietário de um projeto, por si só, não concede acesso.

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

Se você não conseguir ver o Painel de uso de um projeto, verifique se a visibilidade está definida como Visível para proprietários da organização.

Gerenciar o armazenamento de arquivos

Cada projeto tem uma cota de armazenamento de arquivos de 100 GB. Se você exceder essa cota, poderá ver este erro:

Você excedeu sua cota de armazenamento de arquivos. As organizações estão limitadas a 100 GB de arquivos. Reduza o tamanho do arquivo ou entre em contato com o suporte.

Exclua arquivos não utilizados para liberar espaço de armazenamento. Você pode listar os arquivos armazenados pela API para identificar aqueles de que não precisa mais.

Arquivar um projeto

Os proprietários da organização e do projeto podem arquivar projetos na página Projetos ou nas configurações de cada projeto. Insira o nome do projeto quando for solicitado a confirmar.

O arquivamento é permanente: um projeto arquivado não pode ser restaurado.

Para visualizar projetos arquivados, abra a aba Arquivados na página Projetos.

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

A única exceção é que fine-tunes no "Projeto padrão" podem ser acessados de outros projetos.

Você excedeu sua cota de armazenamento de arquivos. As organizações estão limitadas a 100 GB de arquivos. Reduza o tamanho dos arquivos ou entre em contato com o suporte.

Os projetos não podem ser excluídos. A OpenAI mantém o histórico deles para acompanhar o uso e o faturamento.

Este artigo foi útil?