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

Gerir projetos na plataforma API

Saiba como criar e gerir projetos da API da OpenAI, incluindo membros, funções, contas de serviço, chaves de API, limites de utilização e orçamentos.

Atualizado: 16 days ago

Os projetos têm como objetivo permitir que os clientes organizem o seu trabalho. As organizações podem gerir o acesso e os limites, aprovisionar contas de serviço (através da IU) e acompanhar a utilização num âmbito limitado dentro de um projeto (por exemplo, modelos, capacidades, threads, assistentes, fine-tuning, armazenamento, etc.). A atividade de utilização pode ser discriminada por projeto, e os utilizadores podem ver a faturação e definir limites de gastos por projeto.

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

Image

Quem pode criar um projeto?

Apenas os proprietários da organização podem criar projetos. Para obter mais informações, consulte funções e permissõ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 uma organização na lista:

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

Nas organizações com um plano de faturação consolidada, as suborganizações são identificadas separadamente. Não é possível criar projetos em suborganizações.

Image

Como funcionam os projetos?

Todas as organizações incluem um «Projeto predefinido» que não pode ser eliminado. Pode configurar os limites de taxa, as permissões de modelos virtuais e os limites de despesas (desde novembro de 2024). Este projeto herda toda a configuração da organização, pelo que não pode adicionar-lhe diretamente membros nem contas de serviço.

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

Indique um nome, uma descrição e um site para o projeto e, em seguida, selecione Criar.

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

Como adiciono utilizadores a um projeto?

Os membros recém-adicionados à organização não são automaticamente adicionados ao «Projeto predefinido». Os novos membros podem ser convidados para o projeto quando são convidados para a organização (ativando a caixa «Convidar para o projeto predefinido») ou depois de aceitarem o convite para a organização.

Os utilizadores convidados através da API de administração seguem as regras definidas pelo endpoint /organization/invites.

Se ocorrer um erro ao convidar utilizadores para um projeto através da interface ou da API de administração, confirme primeiro se o projeto de destino existe e não está arquivado antes de reenviar o convite.

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

Quais são as diferentes funções de utilizador nas organizações e nos projetos, e que permissões concedem?

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». Os membros de projetos são equivalentes aos leitores das organizações. Consulte a tabela abaixo para obter uma descrição mais detalhada das permissões associadas a cada função de utilizador.

FunçãoÂmbitoDescrição
ProprietárioOrganizaçãoPode criar e ver todos os projetos, utilizadores e chaves de API. Pode monitorizar todos os projetos da organização através da

página Projetos
. Pode definir os limites de despesas da organização e dos projetos. Pode conceder a outras pessoas da organização permissão para ver informações de utilização. Pode arquivar projetos.
LeitorOrganizaçãoPode realizar inferências, utilizar recursos e criar chaves nos projetos a que pertence. Pode ser adicionado a projetos.
Não pode criar projetos nem gerir utilizadores.
ProprietárioProjetoPode adicionar outros utilizadores ao projeto e alterar o nome do projeto, além de ter todas as capacidades de um Membro. Pode definir os limites de despesas do projeto. Pode arquivar o projeto.
MembroProjetoPode realizar inferências, utilizar recursos e criar chaves ao nível do projeto.

Se não for proprietário da organização, a que conteúdos tenho acesso?

Os utilizadores que não são proprietários da organização só podem ver os projetos de que são membros. Apenas o proprietário da organização pode ver todos os projetos, membros e chaves de API ao nível do projeto, e aceder à página Projetos.

  • Apenas os membros de um projeto (e os proprietários da organização) podem ver os modelos com otimização criados nesse projeto, as threads dos Assistentes criados ou os ficheiros adicionados.

  • Os membros de um projeto podem ver todos os outros membros desse projeto e as respetivas funções (por exemplo, Proprietário ou Membro).

Como atualizo a função de um utilizador num projeto ou o removo do projeto?

Apenas o proprietário de um projeto pode atualizar a função de um utilizador ou removê-lo desse projeto. Para obter mais informações, consulte funções e permissões.

Para atualizar um utilizador num projeto, aceda às definições da organização, selecione o projeto e clique em Membros. Pode definir a função de cada membro como Membro ou Proprietário. Também pode selecionar Remover para remover o utilizador do projeto.

O que é uma conta de serviço e em que difere de uma conta de utilizador normal?

Uma conta de serviço funciona como um pseudoutilizador concebido para acesso por sistemas, distinto das contas de utilizadores individuais. Apenas os proprietários da organização e do projeto podem criar contas de serviço.

As contas de serviço estão limitadas apenas a projetos.

Adicionar um membro a um projeto

Se clicar no botão + Adicionar membro, verá uma lista dos utilizadores da sua organização com a função de Leitor. Se quiser adicionar um utilizador que ainda não pertence à sua organização, terá primeiro de o adicionar à organização (pode deixar desmarcada a caixa «Adicionar ao projeto predefinido» se não quiser conceder a estes utilizadores um acesso mais amplo). Esta lista não inclui contas de serviço. Neste passo, pode atribuir-lhes a função de Proprietário ou Membro:

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

Ao adicionar um membro da equipa, tem de lhe atribuir a função de Membro ou Proprietário. Os membros do projeto podem fazer pedidos à API que leiam ou alterem dados, enquanto os proprietários também podem alterar as definições e os limites de despesas do projeto, bem como gerir os respetivos membros. Para obter mais informações, consulte funções e permissões.

Como criar uma conta de serviço para um projeto

Primeiro, aceda ao projeto para o qual pretende criar uma conta de serviço, selecionando-o no menu pendente da barra de navegação:

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

Em seguida, aceda às definições da organização -> Projeto -> Membros -> e clique em + Conta de serviço:

As contas de serviço criadas ao nível do projeto são exclusivas desse projeto e não podem ser utilizadas fora do projeto em que foram criadas.

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

Atribuir um nome à conta de serviço

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

Guardar a chave de API da conta de serviço

Depois de selecionar o botão Criar, é criada imediatamente uma chave de API para a conta de serviço e é apresentada a chave secreta. Guarde esta chave secreta num local seguro. Por motivos de segurança, não poderá voltar a vê-la através da sua conta OpenAI. Se perder esta chave secreta, terá de gerar uma nova.

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

Por predefinição, a chave de API da conta de serviço tem permissões de leitura e escrita para todos os recursos de API do projeto. Estas permissões podem ser atualizadas nas definições de Chaves de API do projeto.

As contas de serviço aparecem juntamente com os membros do projeto na página de definições dos membros. Consulte esta secção para saber mais sobre como atualizar ou remover o acesso de uma conta de serviço na página de definições dos membros do projeto.

Todas as contas de serviço, tanto em projetos como em organizações, serão apresentadas juntamente com os utilizadores humanos na página de membros ao nível da organização.

As contas de serviço são geridas como contas normais. No menu Organização -> Membros, 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 giro as chaves de API nos projetos da minha organização?

Pode criar e gerir as chaves de API de cada projeto na página de definições desse projeto. Nas definições da organização, selecione o projeto e clique em Chaves de API.

Para criar uma nova chave secreta, selecione + Criar nova chave secreta. Também pode selecionar o ícone Editar junto a uma chave secreta para alterar as respetivas permissões.

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

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

Estão disponíveis três níveis de permissões: Todas, Restritas e Só de leitura.

  • Todas — São atribuídas permissões totais à chave secreta. Esta é a definição predefinida.

  • Restritas — Permite definir as permissões Nenhuma, Leitura e Escrita para cada endpoint.

  • Por exemplo, pode criar uma chave de API especificamente sem permissão para ler ou escrever no endpoint /v1/assistants:

Create new secret key dialog in the API platform with Restricted permissions selected
  • Só de leitura — São atribuídas permissões de leitura a todos os endpoints.

Como é gerido o acesso dos utilizadores que pertencem a vários projetos ou organizações?

Os utilizadores podem ser membros de tantos projetos quantos forem necessários. Num projeto, os utilizadores podem gerar uma chave de API pessoal cujo âmbito e acesso estão limitados a esse projeto e aos respetivos recursos.

Como defino e giro os limites de taxa dos projetos da minha organização?

Apenas o proprietário de uma organização pode definir e gerir limites de taxa ao nível dos projetos. Para obter mais informações, consulte funções e permissões.

Nas definições da organização, clique no projeto que pretende atualizar e selecione Limites na secção Projeto da lista de navegação. Pode atualizar a Utilização de modelos nesta página.

A utilização de modelos permite configurar os modelos que o projeto pode utilizar e definir limites de taxa para cada modelo, conforme necessário.

Como defino e giro os limites de despesas dos projetos da minha organização?

Apenas os proprietários de uma organização e de um projeto podem definir e gerir os limites de despesas do projeto. Para obter mais informações, consulte funções e permissões. Para alterar os limites ao nível da organização, aceda às definições da organização, clique em Limites e desloque-se até Limites de utilização.

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

Para definir os limites do projeto, aceda às definições da organização, clique no projeto que pretende atualizar e selecione Limites. Pode atualizar o Limite de despesas mensal, o Limiar de notificação e a Utilização de modelos.

Definir um limite de despesas mensal permite estabelecer limiares de despesas flexíveis para o projeto. Quando a utilização excede este limite num determinado mês civil (UTC), os pedidos à API continuam a ser processados sem interrupção. Esta funcionalidade ajuda a monitorizar a utilização através de alertas de limites de despesas, mas não impõe um limite máximo rígido às despesas. Por predefinição, ao criar um limite de despesas para um projeto, é criado um alerta no limiar de 100%. Pode definir alertas adicionais com limiares diferentes clicando em Adicionar alerta.

Tenha em atenção que os proprietários da organização e do projeto receberão sempre estas mensagens e que esta opção não pode ser personalizada.

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

Como defino limites de despesas para a minha organização ou projeto?

A OpenAI permite agora definir limites mensais de despesas da API ao nível da organização e do projeto. Um limite de despesas pode apenas monitorizar as despesas ou ser aplicado como limite rígido, fazendo com que os pedidos à API falhem depois de o valor ser atingido. Para conhecer os passos de configuração e o comportamento mais recentes, consulte Limites de despesas na documentação para programadores.

Como elimino ou arquivo um projeto?

Os projetos podem ser arquivados na nova página da lista de projetos ou nas definições de cada projeto. Depois de arquivado, um projeto não pode ser restaurado. Ao arquivar um projeto, ser-lhe-á pedido que introduza o respetivo nome para continuar.

Pode ver uma lista de todos os projetos arquivados no separador «Arquivados» da mesma página da lista de projetos.

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

Não é possível eliminar projetos. Mantemos um histórico de todos os projetos para assegurar a continuidade do acompanhamento da utilização e da faturação.

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

Por predefinição, as organizações podem criar até 2000 projetos.

É possível partilhar recursos entre projetos?

Os recursos de um projeto (como ficheiros, assistentes, armazenamento ou threads) estão limitados a esse projeto e não podem ser acedidos por membros não administradores externos ao projeto. Além disso, não é possível mover recursos entre projetos.

A única exceção é que os fine-tunes no "Projeto predefinido" podem ser acedidos a partir de outros projetos.

Qual é a quota de armazenamento de ficheiros por projeto?

Atualmente, a OpenAI disponibiliza uma quota de armazenamento de 100 GB de ficheiros por projeto.

Se esta quota for excedida, verá o seguinte erro:

Excedeu a quota de armazenamento de ficheiros. As organizações estão limitadas a 100 GB de ficheiros. Reduza o tamanho dos ficheiros ou contacte o suporte.

Recomendamos que elimine os ficheiros não utilizados armazenados na sua conta. Para referência, pode ver e listar ficheiros com a API.

Sou proprietário de um projeto. Porque não consigo ver o Painel de utilização do meu projeto?

A visibilidade do Painel de utilização de um projeto não está relacionada com a função do utilizador nesse projeto. Em vez disso, é determinada pela sua função na organização e pelas definições em https://platform.openai.com/settings/organization/data-controls/visibility

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

Se não conseguir ver um Painel de utilização, é provável que esta definição esteja configurada como «Visível para os proprietários da organização».

Este artigo foi útil?