Os poderosos modelos de linguagem da OpenAI, como o GPT-4, estão a mudar a forma como interagimos com a tecnologia. Para tirar partido destes modelos e criar as suas próprias aplicações com IA, precisa de um componente crucial: uma chave de API da OpenAI.
Pense numa chave de API como uma palavra-passe secreta. É um identificador único que autentica os seus pedidos aos servidores da OpenAI, permitindo que a sua aplicação aceda aos modelos deles. Também ajuda a OpenAI a monitorizar a sua utilização para fins de faturação e controlo.
Este guia irá explicar tudo o que precisa de saber sobre as chaves de API da OpenAI, desde como obter a sua primeira chave até como geri-la de forma segura.
O que são as chaves de API da OpenAI?
Uma chave de API da OpenAI é uma cadeia alfanumérica única que os programadores usam para autenticar os seus pedidos à API da OpenAI. Quando envia um pedido para usar um modelo como o GPT-4 ou o DALL-E, inclui esta chave. A chave informa a OpenAI sobre quem está a fazer o pedido, garantindo que apenas utilizadores autorizados possam aceder ao serviço.
Estas chaves são essenciais para:
-
Autenticação: Provar a sua identidade aos servidores da OpenAI.
-
Monitorização do uso: Permitir que a OpenAI controle quantos pedidos faz para a faturação.
-
Segurança: Impedir o acesso não autorizado à sua conta e aos seus recursos associados.
[asset]
Imagem: Um diagrama simples que mostra uma aplicação a fazer um pedido com uma chave de API para o servidor da OpenAI, que depois devolve uma resposta.
[/asset]
Como obter a sua chave de API da OpenAI
Obter uma chave de API da OpenAI é um processo simples. Aqui está um guia passo a passo para começar.
Passo 1: Crie uma conta OpenAI
Primeiro, precisa de uma conta OpenAI. Se não tiver uma, aceda à plataforma da OpenAI e registe-se. Pode usar o seu endereço de e-mail ou uma conta Google, Microsoft ou Apple.
Passo 2: Navegue até à secção de chaves de API
Assim que iniciar sessão, procure a secção "API keys" (Chaves de API) no menu de navegação à esquerda. Este é o seu centro de controlo para gerir todas as suas chaves.
Passo 3: Crie uma nova chave secreta
No painel de chaves de API, clique no botão "Create new secret key" (Criar nova chave secreta). Ser-lhe-á pedido que dê um nome à sua chave. É uma boa prática nomear a sua chave com base no projeto em que a vai usar (por exemplo, "Meu-Projeto-Chatbot"). Isto ajuda a manter um registo de onde cada chave é usada.
Passo 4: Copie e guarde a sua chave
Depois de nomear a sua chave, a OpenAI irá gerá-la e exibi-la no seu ecrã. Esta é a única vez que conseguirá ver a chave completa. Certifique-se de que a copia imediatamente e a guarda num local seguro, como um gestor de palavras-passe ou um ficheiro de variáveis de ambiente. Não a partilhe publicamente nem a submeta para um sistema de controlo de versões como o Git.
[asset]
Vídeo: Uma curta gravação de ecrã a percorrer os passos para criar uma nova chave de API da OpenAI no painel da plataforma.
[/asset]
Melhores práticas para gerir as suas chaves de API da OpenAI
As suas chaves de API da OpenAI são poderosas. Se caírem nas mãos erradas, podem ser usadas para fazer pedidos em seu nome, o que pode levar a cobranças inesperadas e potencial utilização indevida. Aqui estão algumas das melhores práticas essenciais para manter as suas chaves seguras.
Mantenha as suas chaves confidenciais
Trate as suas chaves de API como palavras-passe. Nunca as insira diretamente no código-fonte da sua aplicação. Se enviar o seu código para um repositório público como o GitHub, a sua chave ficará exposta para qualquer pessoa encontrar e usar.
Utilize variáveis de ambiente
A forma recomendada de lidar com chaves de API é armazená-las como variáveis de ambiente. Uma variável de ambiente é uma variável guardada fora do código da sua aplicação, no ambiente onde o seu código está a ser executado.
Por exemplo, pode criar um ficheiro .env no diretório raiz do seu projeto:
OPENAI_API_KEY="a-sua-chave-secreta-vai-aqui"
Depois, pode carregar esta variável na sua aplicação usando uma biblioteca como a "dotenv" (para Node.js) ou acedendo a "os.environ" (para Python).
Faça a rotação das suas chaves regularmente
É uma boa prática de segurança apagar periodicamente as chaves antigas e gerar novas. Este processo, conhecido como rotação de chaves, limita os danos que podem ser causados se uma chave for comprometida. Se suspeitar que uma chave foi exposta, deve revogá-la imediatamente no seu painel da OpenAI e criar uma nova.
Configure limites de utilização
Para evitar custos inesperados, a OpenAI permite-lhe definir limites de utilização na sua conta. Pode configurar tanto limites rígidos (que param os pedidos de API assim que são atingidos) como limites flexíveis (que lhe enviam uma notificação por e-mail). Este é um passo crucial para controlar os seus gastos, especialmente quando está a começar.
Resolução de problemas comuns com chaves de API
Mesmo com uma gestão cuidadosa, pode encontrar alguns problemas com as suas chaves de API da OpenAI. Aqui estão alguns problemas comuns e como resolvê-los.
Autenticação inválida (erro 401)
Este é o erro mais comum. Geralmente, significa que a sua chave de API está incorreta, foi revogada ou não está a ser enviada corretamente no seu pedido de API.
-
Verifique a sua chave: Confirme que copiou a chave corretamente e que não existem espaços ou caracteres extra.
-
Verifique se a chave está ativa: Aceda ao seu painel de chaves de API na plataforma da OpenAI e certifique-se de que a chave que está a usar não foi eliminada.
-
Verifique o seu código: Certifique-se de que está a incluir corretamente a chave no cabeçalho "Authorization" do seu pedido como um token "Bearer".
Limite de pedidos excedido (erro 429)
Este erro ocorre quando envia demasiados pedidos num curto período de tempo. A OpenAI impõe limites de pedidos para garantir uma utilização justa para todos.
-
Verifique o seu nível de utilização: O seu limite de pedidos depende do seu nível de utilização. Pode verificar os seus limites nas definições da sua conta.
-
Implemente um recuo exponencial (exponential backoff): Se receber um erro 429, aguarde um curto período antes de tentar novamente o pedido. Uma estratégia de recuo exponencial envolve aumentar o tempo de espera entre as tentativas, o que ajuda a suavizar os picos de pedidos.
Excedeu a sua quota atual (erro 429)
Este é um tipo diferente de erro 429 que indica que ficou sem créditos ou atingiu o seu limite de gastos mensal.
- Verifique as suas informações de faturação: Aceda à secção "Billing" (Faturação) da sua conta OpenAI para verificar a sua utilização atual e adicionar detalhes de pagamento ou aumentar o seu orçamento mensal, se necessário.
[asset]
Infográfico: Um fluxograma que mostra os passos para resolver problemas comuns com chaves de API da OpenAI, como os erros 401 e 429.
[/asset]
Gerir a sua utilização e custos da API
As chaves de API da OpenAI estão diretamente ligadas à faturação da sua conta. Compreender como a utilização é medida e como monitorizá-la é fundamental para evitar faturas surpresa.
Como a utilização é medida
A utilização é tipicamente medida em "tokens". Para modelos de linguagem, um token equivale aproximadamente a quatro caracteres de texto em inglês. Tanto o seu input (o prompt que envia) como o output (a resposta do modelo) contam para o seu uso total de tokens. Modelos diferentes têm preços diferentes por token.
Monitorizar a sua utilização
A plataforma da OpenAI fornece um painel de utilização detalhado onde pode ver quantos tokens usou em diferentes períodos. Pode filtrar por modelo e por intervalo de tempo para obter uma imagem clara do seu consumo. Verificar regularmente este painel ajuda-o a manter os seus custos sob controlo.
Considerações finais
As chaves de API da OpenAI são a sua porta de entrada para criar aplicações incríveis com alguns dos modelos de IA mais avançados do mundo. Ao compreender como gerá-las, geri-las e protegê-las, pode construir com confiança e responsabilidade. Dê sempre prioridade à segurança, mantendo as suas chaves privadas, use variáveis de ambiente e monitorize a sua utilização regularmente para controlar os custos. Com estas melhores práticas em mente, está pronto para começar a inovar com o poder da OpenAI.
