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

Como gerenciar projetos na plataforma da API

Atualizado: 8 days ago

Os projetos têm como objetivo oferecer aos clientes a capacidade de organizar seu trabalho. As organizações podem gerenciar acesso e limites, provisionar contas de serviço (pela interface) e acompanhar o uso em relação a um escopo restrito dentro de um projeto (por exemplo, modelos, capacidades, threads, assistentes, ajuste fino, armazenamento etc.). A atividade de uso pode ser detalhada por projeto, e os usuários podem visualizar o faturamento e definir limites de gastos por projeto.

Proprietários da organização podem ver todos os seus projetos ativos e arquivados na página Projetos. Saiba mais sobre funções de usuário e permissões na Plataforma de API.

Image

Quem pode criar um projeto?

Somente proprietários da organização podem criar um projeto. Consulte funções e permissões para mais informações.

Para alternar entre organizações, passe o cursor sobre o nome da sua organização no canto superior esquerdo da página e selecione a organização na lista:

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

Para organizações que estão em um plano de faturamento consolidado, as suborganizações são identificadas separadamente. Projetos não podem ser criados dentro de suborganizações.

Image

Como os projetos funcionam?

Toda organização inclui um “Projeto padrão” que não pode ser excluído. Você pode configurar os limites de taxa, as permissões de modelos virtuais e os limites de gastos (a partir de novembro de 2024). Ele herda a configuração completa da organização, portanto você não pode adicionar membros nem contas de serviço diretamente a ele.

Como crio um projeto?

Primeiro, passe o cursor sobre o nome do projeto no canto esquerdo da página e selecione Criar projeto.

API platform project menu with Create project highlighted under Default project

Informe um nome, uma descrição e um site para o projeto. Depois, selecione Criar.

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

Como adiciono usuários a um projeto?

Os novos membros adicionados à organização não são incluídos automaticamente no “Projeto padrão”. Os novos membros podem ser convidados para o projeto ao receberem o convite para a organização, marcando a caixa "Convidar para o projeto padrão", ou depois de aceitarem o convite da organização.

Os usuários convidados pela API de administração seguem as regras descritas no endpoint /organization/invites.

Se ocorrer um erro ao convidar usuários para um projeto pela interface ou pela API de administração, primeiro confirme se o projeto de destino existe e não está arquivado antes de reenviar o convite.

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

Quais são as diferentes funções de usuário em organizações e projetos, e quais permissões elas incluem?

Enquanto as organizações têm as funções de “proprietário” e “leitor”, os projetos têm as funções de “proprietário” e “membro”. Membros do projeto são análogos aos leitores da organização. Consulte a tabela abaixo para ver uma descrição mais detalhada das permissões de cada função de usuário.

FunçãoEscopoDescrição
ProprietárioOrganizaçãoPode criar/visualizar todos os projetos, todos os usuários e todas as chaves de API. Pode monitorar todos os projetos da organização pela página Projetos. Pode definir limites de gastos da organização e limites de gastos do projeto. Pode conceder permissões para que outras pessoas na organização visualizem informações de uso. Pode arquivar projetos.
LeitorOrganizaçãoPode realizar inferência, usar recursos e criar chaves em seus projetos. Pode ser adicionado a projetos.
Não pode criar projetos nem gerenciar usuários.
ProprietárioProjetoPode adicionar outros usuários ao projeto e renomear o projeto, além de ter todas as permissões de um membro. Pode definir limites de gastos do projeto. Pode arquivar o projeto.
MembroProjetoPode realizar inferência, usar recursos e criar chaves no nível do projeto.

Se eu não for proprietário da organização, a que terei acesso?

Os usuários que não são proprietários da organização só podem ver os projetos dos quais são membros. Somente o proprietário da organização pode ver todos os projetos, membros e chaves de API no nível do projeto, além de acessar a página Projetos.

  • Somente os membros de um projeto e os proprietários da organização podem ver os modelos ajustados criados nesse projeto, as conversas de qualquer Assistente criado e os arquivos adicionados.

  • Os membros de um projeto podem ver todos os outros membros do projeto e suas funções, como Proprietário ou Membro.

Como atualizo a função de um usuário ou removo um usuário de um projeto?

Somente o proprietário de um projeto pode atualizar a função de um usuário ou removê-lo do projeto. Consulte funções e permissões para saber mais.

Para atualizar um usuário em um projeto, acesse as configurações da organização, selecione o projeto e clique em Membros. Você pode definir a função de cada integrante como Membro ou Proprietário. Você também pode selecionar Remover para retirar o usuário do projeto.

O que é uma conta de serviço e como ela difere de uma conta de usuário comum?

Uma conta de serviço atua como um pseudousuário projetado para acesso ao sistema, distinto das contas de usuários individuais. Somente os proprietários da organização e do projeto podem criar contas de serviço.

As contas de serviço têm escopo apenas para projetos.

Adicionar um membro a um projeto

Ao clicar no botão + Adicionar membro, você verá uma lista dos usuários da organização com a função Leitor. Para adicionar um usuário que ainda não faz parte da sua organização, primeiro será necessário adicioná-lo a ela. Se não quiser conceder um acesso mais amplo a esses usuários, deixe desmarcada a caixa "Adicionar ao projeto padrão". Essa lista não inclui contas de serviço. Nesta etapa, você pode escolher entre as funções Proprietário e Membro:

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

Ao adicionar um integrante da equipe, você deve atribuir a ele a função Membro ou Proprietário. Os membros do projeto podem fazer solicitações à API para ler ou modificar dados. Já os proprietários também podem alterar as configurações e os limites de gastos do projeto, além de gerenciar seus membros. Consulte funções e permissões para saber mais.

Como criar uma conta de serviço para um projeto

Primeiro, acesse o projeto para o qual deseja criar uma conta de serviço, escolhendo-o no menu suspenso da barra de navegação:

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

Em seguida, acesse as configurações da organização -> Projeto -> Membros -> e clique em + Conta de serviço:

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

Nomeando a conta de serviço

Independentemente de você criar a conta de serviço no nível da organização ou criar uma exclusiva para um projeto, ao criar uma conta de serviço você pode criar um ID exclusivo de conta de serviço composto por letras, números e hífens para identificar facilmente a conta de serviço.

Salve a chave de API da conta de serviço

Depois de selecionar o botão Criar, uma chave de API é criada imediatamente para a conta de serviço, e a chave secreta é exibida. Salve essa chave secreta em um local seguro. Por motivos de segurança, não será possível visualizá-la novamente pela sua conta da OpenAI. Se você perder essa chave secreta, precisará gerar uma nova.

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

Por padrão, a chave de API da conta de serviço tem permissão para ler e gravar em todos os recursos de API do projeto. Essas permissões podem ser atualizadas nas configurações de Chaves de API do projeto.

As contas de serviço aparecem junto aos membros do projeto na página de configurações de membros. Consulte esta seção para saber mais sobre como atualizar ou remover o acesso de uma conta de serviço na página de configurações de membros do projeto.

Todas as contas de serviço em projetos e organizações serão exibidas junto com seus usuários humanos na página de membros no nível da organização.

Contas de serviço são gerenciadas como contas comuns. No menu Organização -> Membros, você pode Remover uma conta de serviço ou atualizar a função:

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

Como gerencio as chaves de API nos projetos da minha organização?

Você pode criar e gerenciar chaves de API para cada projeto na página de configurações correspondente. Nas configurações da organização, selecione o projeto e clique em Chaves de API.

Para criar uma nova chave secreta, selecione + Criar nova chave secreta. Você também pode selecionar o ícone Editar ao lado de uma chave secreta para alterar as permissões dela.

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

Você pode definir as permissões de cada chave de API ao criar uma nova chave secreta ou editar uma chave existente.

Há três níveis de permissão disponíveis: Todas, Restritas e Somente leitura.

  • Todas — A chave secreta recebe todas as permissões. Essa é a configuração padrão.

  • Restritas — Permite definir as permissões Nenhuma, Leitura e Gravação para cada endpoint.

  • Por exemplo, você pode criar uma chave de API especificamente sem permissão de leitura ou gravação no endpoint /v1/assistants:

Create new secret key dialog in the API platform with Restricted permissions selected
  • Somente leitura — As permissões de leitura são definidas para todos os endpoints.

Como o acesso é gerenciado para usuários que pertencem a vários projetos ou organizações?

Os usuários podem ser membros de quantos projetos forem necessários. Dentro de um projeto, os usuários podem gerar uma chave de API pessoal com escopo e limitada ao acesso àquele projeto e seus recursos.

Como defino e gerencio limites de taxa para os projetos da minha organização?

Somente o Proprietário de uma organização pode definir e gerenciar limites de taxa no nível do projeto. Consulte funções e permissões para mais informações.

Nas suas configurações da organização, clique no projeto que deseja atualizar e selecione Limites na seção Projeto da lista de navegação. Você pode atualizar seu Uso de modelos nesta página.

O uso de modelos permite configurar quais modelos podem ser usados pelo projeto, e limites de taxa podem ser definidos para cada modelo conforme necessário.

Como defino e gerencio os limites de gastos dos projetos da minha organização?

Somente os proprietários da organização e do projeto podem definir e gerenciar os limites de gastos do projeto. Consulte funções e permissões para saber mais. Para alterar os limites da organização, acesse as configurações da organização, clique em Limites e role até Limites de uso.

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

Para definir os limites do projeto, acesse as configurações da organização, clique no projeto que deseja atualizar e selecione Limites. Você pode atualizar o Limite de gastos mensais, o Limite para notificações e o Uso do modelo.

Definir um limite de gastos mensais permite estabelecer limites flexíveis de gastos para o projeto. Quando o uso ultrapassar esse limite em um determinado mês civil (UTC), as solicitações à API continuarão sendo processadas sem interrupção. Esse recurso ajuda você a monitorar o uso por meio de alertas de limite de gastos, mas não impõe um teto rígido aos gastos. Quando um limite de gastos do projeto é criado, um alerta no limite de 100% também é criado por padrão. Para definir alertas adicionais em outros limites, clique em Adicionar alerta.

Os proprietários da organização e do projeto sempre receberão essas mensagens, e isso não pode ser personalizado.

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

Como defino limites de gastos para minha organização ou meu projeto?

A OpenAI agora oferece suporte a limites mensais de gastos de API tanto no nível da organização quanto no nível do projeto. Um limite de gastos pode monitorar os gastos sem aplicá-lo, ou você pode aplicá-lo como um limite rígido para que as solicitações de API falhem depois que os gastos atingirem o limite. Para ver as etapas de configuração e o comportamento mais recentes, consulte Limites de gastos na documentação para desenvolvedores.

Como excluo ou arquivo um projeto?

Os projetos podem ser arquivados pela nova página de listagem de projetos ou nas configurações de cada projeto. Depois que um projeto é arquivado, ele não pode ser restaurado. Ao arquivar um projeto, você deverá inserir o nome dele para prosseguir.

Você pode ver a lista de todos os projetos arquivados na aba “Arquivados” da mesma página de listagem de projetos.

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

Não é possível excluir projetos. Mantemos o histórico de todos os projetos para garantir a continuidade do acompanhamento do uso e do faturamento.

Existe um limite para o número de projetos que posso ter na minha organização?

As organizações podem criar até 2.000 projetos por padrão.

Os recursos podem ser compartilhados entre projetos?

Os recursos do projeto (como arquivos, assistants, armazenamento ou threads) têm escopo do projeto e não podem ser acessados por membros não administradores fora do projeto. Além disso, os recursos não podem ser movidos entre projetos.

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

Qual é a cota de armazenamento de arquivos por projeto?

Atualmente, a OpenAI oferece uma cota de armazenamento de 100 GB de arquivos por projeto.

Se essa cota for excedida, você verá o seguinte erro:

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.

Recomendamos excluir arquivos não utilizados armazenados na sua conta. Para referência, você pode visualizar e listar arquivos com a API.

Sou proprietário de um projeto. Por que não consigo ver o Painel de uso dele?

A visibilidade do Painel de uso de um projeto não está relacionada à função do usuário no projeto. Ela é determinada pela sua função na organização e pelas configurações em https://platform.openai.com/settings/organization/data-controls/visibility

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

Se você não consegue ver um Painel de uso, essa configuração provavelmente está definida como "Visível para proprietários da organização".

Este artigo foi útil?