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

Gerir projetos na plataforma API

Crie e gira projetos de API, incluindo o acesso dos membros, contas de serviço, chaves de API, acesso a modelos, utilização e limites de despesa.

Atualizado: 43 minutes ago

Visão geral

Os projetos organizam o trabalho numa organização da API. Utilize-os para gerir o acesso, configurar limites de modelos e limites de taxa, criar contas de serviço e acompanhar a utilização, a faturação e os limites de despesa de um conjunto definido de recursos, como modelos, capacidades, conversas, assistentes, ajuste fino e armazenamento.

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

Image

Antes de começar

Precisa da função de proprietário da organização para criar um projeto. Por predefinição, as organizações podem criar até 2000 projetos.

Se a sua organização utilizar faturação consolidada, as suborganizações aparecem separadamente no seletor de organizações. Não é possível criar projetos numa suborganização.

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

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

Projeto Predefinido

Todas as organizações incluem um projeto Predefinido, que não pode ser eliminado. Este herda toda a configuração da organização. Pode configurar os seus limites de taxa, permissões de modelos virtuais e limites de despesa.

Não é possível adicionar membros ou contas de serviço diretamente ao projeto Predefinido. Pode incluir o acesso ao projeto Predefinido ao convidar alguém para a organização, seguindo os passos de convite para a organização descritos neste artigo.

Criar um projeto

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

  2. Introduza um nome, uma descrição e um site para o 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 automaticamente adicionados como proprietários aos novos projetos.

Compreender as funções e o acesso

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

FunçãoÂmbitoPermissões
ProprietárioOrganizaçãoCriar e ver todos os projetos, utilizadores e chaves de API. Monitorizar projetos na página Projetos. Definir limites de despesa para a organização e os projetos. Conceder acesso às informações de utilização de outros utilizadores. Arquivar projetos.
LeitorOrganizaçãoSer adicionado a projetos, executar inferência, utilizar recursos e criar chaves nesses projetos. Não pode criar projetos nem gerir utilizadores.
ProprietárioProjetoTodas as permissões de membro, além de adicionar utilizadores, gerir os membros e as definições do projeto, mudar o nome do projeto, definir os seus limites de despesa e arquivá-lo.
MembroProjetoExecutar inferência, utilizar recursos, criar chaves ao nível do projeto e efetuar pedidos à API que leiam ou modifiquem dados.

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

Visibilidade dos projetos

Com estas funções padrão, os utilizadores que não sejam proprietários da organização só podem ver os projetos a que pertencem. Os proprietários da organização podem ver todos os projetos, membros e chaves de API ao nível do projeto, e podem aceder à página Projetos.

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

Pode pertencer a tantos projetos quantos precisar. Uma chave de API pessoal criada num projeto está limitada a esse projeto e aos seus recursos.

Delimitação dos recursos

Os ficheiros, assistentes, armazenamento e conversas estão limitados ao âmbito do respetivo projeto. Os membros que não pertençam a esse projeto e não sejam administradores não podem aceder aos seus recursos, e os recursos não podem ser movidos entre projetos.

Os modelos com ajuste fino no projeto Predefinido são uma exceção: é possível aceder-lhes a partir de outros projetos.

Gerir os membros do projeto

Convidar alguém para a sua organização

Uma pessoa tem de pertencer à sua organização para poder adicioná-la a um projeto.

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

Não precisa de criar outro projeto antes de convidar alguém. Também pode adicionar alguém a um projeto depois de essa pessoa aceitar o convite para a organização.

Os convites enviados através da 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 dos projetos podem adicionar membros:

  1. Aceda às definições da organização.

  2. Selecione o projeto e abra Membros.

  3. Selecione + Adicionar membro.

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

A lista de utilizadores mostra os utilizadores da organização com a função de Leitor. 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 que 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 utilizador no projeto ou removê-lo desse projeto.

  1. Aceda às definições da organização.

  2. Selecione o projeto e abra Membros.

  3. Defina a função do utilizador como Membro ou Proprietário, ou selecione Remover para o remover.

Criar e gerir contas de serviço

Uma conta de serviço fornece acesso a sistemas, em vez de representar um utilizador individual. As contas de serviço estão limitadas ao âmbito dos projetos.

A criação de contas de serviço requer permissões de gestão de contas de serviço. Os proprietários da organização e dos projetos têm estas permissões.

Criar uma conta de serviço

  1. Escolha o projeto no seletor de projetos.

  2. Aceda às definições da organização e selecione o projeto.

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

  4. Introduza um ID único para a conta de serviço, utilizando letras, números e hífenes.

  5. Selecione Criar.

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

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

O formato do ID é o mesmo, quer crie a conta de serviço nas definições da organização ou nas do projeto.

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

Guardar a chave secreta

Ao criar a conta de serviço, é imediatamente criada uma chave de API e apresentada a respetiva chave secreta. Guarde a chave secreta em segurança. Não poderá voltar a vê-la através da sua conta OpenAI. Se a perder, gere uma nova chave.

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

Por predefinição, a chave da conta de serviço permite ler e escrever em todos os recursos da API do respetivo projeto. Pode alterar essas permissões posteriormente nas definições de Chaves de API do projeto.

Atualizar ou remover uma conta de serviço

As contas de serviço aparecem juntamente com os utilizadores nas definições de Membros do projeto. Para gerir o acesso destas contas ao projeto, siga os mesmos passos de alteração de função e remoção que utiliza para os outros membros do projeto.

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

No menu Membros da organização, 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 gerir chaves de API

Cada projeto tem as suas próprias chaves de API:

  1. Aceda às definiçõ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 junto a uma chave existente para alterar as suas permissões.

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

Escolher as permissões da chave

Nas chaves pertencentes a utilizadores, pode definir as permissões ao criar a chave ou editá-las mais tarde:

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

  • Restritas: escolha os âmbitos de acesso para recursos ou endpoints específicos. As opções disponíveis dependem do recurso e podem incluir Nenhuma, Leitura, Escrita ou permissões específicas do pedido.

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

Por exemplo, uma chave com permissões restritas pode excluir o acesso de leitura e escrita 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 requer permissões de gestão de contas de serviço. Se não vir essa opção, 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 apresenta estes controlos de permissões para chaves de contas de serviço; altere as permissões posteriormente nas definições de Chaves de API do projeto.

Configurar o acesso a modelos e os limites de taxa

A gestão dos limites de taxa do projeto requer permissões administrativas. Os proprietários da organização têm estas permissões, e os proprietários dos projetos também podem gerir os limites de taxa dos projetos através da API de gestão.

  1. Aceda às definições da organização.

  2. Selecione o projeto e abra Limites.

  3. Utilize Utilização de modelos para escolher os modelos que o projeto pode utilizar.

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

Definir limites e alertas de despesa

Os limites de despesa mensal com a API estão disponíveis tanto ao nível da organização como do projeto. Para alterar um limite, precisa de permissão para gerir as definições da organização ou do projeto em causa.

Um limite de despesa permite monitorizar os gastos sem interromper os pedidos. Ative Aplicar um limite rígido se quiser que os pedidos à API falhem quando a despesa registada atingir o limite. A aplicação do limite não é instantânea, pelo que a despesa registada pode ultrapassar ligeiramente o montante configurado.

Os alertas de despesa notificam quando um limiar é atingido; não interrompem os pedidos.

Definir um limite de despesa para a organização

  1. Aceda às definições da organização.

  2. Abra Limites e procure Despesa.

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

Definir um limite de despesa para um projeto

  1. Aceda às definições da organização.

  2. Selecione o projeto e abra Limites.

  3. Defina os valores de Limite de despesa mensal e Alertar quando a despesa atingir.

  4. Ative Aplicar um limite rígido se quiser interromper o tráfego da API quando a despesa registada atingir o limite.

Também pode alterar a Utilização de modelos nesta página.

Gerir alertas de despesa

Ao criar um limite de despesa para um projeto, é também criado, por predefinição, um alerta para 100% do limite. Selecione Adicionar alerta para adicionar alertas noutros limiares.

Os proprietários da organização e do projeto recebem os alertas de despesa do projeto. Pode adicionar outros destinatários de e-mail nas definições do alerta.

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

Para conhecer os passos de configuração e o comportamento atual de aplicação dos limites, consulte o guia de limites de despesa.

Consultar a utilização e a faturação

A atividade de utilização pode ser discriminada por projeto, e pode consultar a faturação e definir limites de despesa para cada projeto.

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

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

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

Gerir o armazenamento de ficheiros

Cada projeto tem uma quota de armazenamento de ficheiros de 100 GB. Se a ultrapassar, poderá ver este erro:

Excedeu a sua quota de armazenamento de ficheiros. As organizações estão limitadas a 100 GB de ficheiros. Reduza o tamanho do ficheiro ou contacte o apoio.

Elimine os ficheiros que não utiliza para libertar espaço de armazenamento. Pode listar os ficheiros armazenados através da API para identificar os ficheiros de que já não precisa.

Arquivar um projeto

Os proprietários da organização e dos projetos podem arquivar projetos a partir da página Projetos ou das definições de cada projeto. Quando lhe for pedido, introduza o nome do projeto para confirmar.

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

Para ver os projetos arquivados, abra o separador Arquivados na página Projetos.

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

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

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.

Os projetos não podem ser eliminados. A OpenAI mantém o histórico dos projetos para acompanhar a utilização e a faturação.

Este artigo foi útil?