Como obter e usar uma chave de API OpenAI
Se você estiver interessado em usar os modelos de inteligência artificial (IA) mais recentes e avançados para seus projetos, confira o OpenAI. A OpenAI é uma organização de pesquisa que cria e publica modelos de IA de código aberto que qualquer pessoa pode usar. No entanto, para acessar esses modelos, você precisa de uma chave de API OpenAI. Neste artigo, explicaremos o que é OpenAI, por que você precisa de uma chave de API, como obter uma, como usá-la e como solucionar alguns problemas comuns.
O que é OpenAI e por que você precisa de uma chave de API
OpenAI: uma breve introdução
A OpenAI é uma organização de pesquisa fundada em 2015 por um grupo de proeminentes empreendedores e visionários de tecnologia, como Elon Musk, Peter Thiel, Reid Hoffman e Y Combinator. A missão da OpenAI é garantir que a inteligência artificial possa estar alinhada com os valores humanos e possa beneficiar toda a humanidade. Para atingir esse objetivo, a OpenAI cria e publica modelos de IA de código aberto que qualquer pessoa pode usar gratuitamente ou mediante pagamento, dependendo do uso e da complexidade do modelo.
openai api key
Os benefícios de usar os modelos de IA da OpenAI
Alguns dos modelos de IA que a OpenAI criou e publicou estão entre os mais poderosos e versáteis do mundo. Por exemplo, o GPT-4 é um modelo de processamento de linguagem natural (NLP) que pode gerar um texto coerente e realista sobre qualquer tópico, dado alguma entrada. O GPT-4 pode ser usado para vários aplicativos, como chatbots, criação de conteúdo, resumo, tradução e muito mais. Outro exemplo é o DALL-E, um modelo de visão computacional que pode gerar imagens a partir de descrições de texto. DALL-E pode ser usado para fins criativos, como design de logotipos, ilustrações ou memes.
Ao usar os modelos de IA da OpenAI, você pode aproveitar a tecnologia de ponta para seus projetos sem precisar criar seus próprios modelos do zero. Você também pode se beneficiar da melhoria contínua e inovação que o OpenAI oferece para seus modelos.No entanto, para usar esses modelos, você precisa de uma chave de API OpenAI.
Como obter uma chave de API OpenAI
Uma chave de API OpenAI é um identificador exclusivo que permite acessar a API OpenAI, que é a interface que conecta você aos modelos de IA. Para obter uma chave de API OpenAI, você precisa seguir estas etapas:
Vá para em platform.openai.com e entre com uma conta OpenAI.
Clique no ícone do seu perfil no canto superior direito da página e selecione "Exibir chaves de API".
Clique em "Criar nova chave secreta" para gerar uma nova chave de API.
Você verá uma janela pop-up que mostra sua nova chave de API. Certifique-se de copiá-lo e salvá-lo em algum lugar seguro, pois você não poderá vê-lo novamente depois de fechar a janela. Você também verá uma tabela que mostra suas chaves de API existentes e seus detalhes, como data de criação, data de expiração, limite de uso e status.
Como usar uma chave de API OpenAI
Como configurar sua chave de API no código ou na variável de ambiente
Depois de ter sua chave de API, você precisa configurá-la em seu código ou variável de ambiente para poder fazer solicitações à API OpenAI. Existem diferentes maneiras de fazer isso, dependendo da linguagem de programação ou estrutura ou ferramenta que você está usando. Aqui estão alguns exemplos de como configurar sua chave API em diferentes linguagens e ferramentas: - Python: Você pode usar a biblioteca Python oficial para a API OpenAI, que pode ser instalada com `pip install openai`. Em seguida, você pode importar o módulo `openai` e definir a variável `openai.api_key` para sua chave de API.Por exemplo: ```python import os import openai.api_key = os.getenv("OPENAI_API_KEY") # obtenha a chave API de uma variável de ambiente # ou openai.api_key = "sk-xxxxxxxxxxxxxxxxx" # codifique a chave API (não recomendado) # use o módulo openai para fazer solicitações à API OpenAI response = openai.Completion.create( engine="davinci", prompt="Hello, world!", max_tokens =5 ) ``` - Node.js: Você pode usar a biblioteca Node.js oficial para a API OpenAI, que pode ser instalada com `npm install openai`. Em seguida, você pode importar a classe `OpenAIApi` e criar uma instância com sua chave de API. Por exemplo: ```javascript const OpenAIApi = require("openai"); const openai = new OpenAIApi( apiKey: process.env.OPENAI_API_KEY // obtém a chave API de uma variável de ambiente // ou // apiKey: "sk-xxxxxxxxxxxxxxxxxxx" // codifica a chave API (não recomendado) ); // use a instância openai para fazer solicitações à API OpenAI openai.complete( engine: "davinci", prompt: "Hello, world!", maxTokens: 5 ).then(response => console.log(response); ); ``` - curl: Você pode usar a ferramenta de linha de comando curl para fazer solicitações HTTP para a API OpenAI. Você precisa incluir sua chave de API no cabeçalho `Authorization` de sua solicitação. Por exemplo: ```bash curl \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $OPENAI_API_KEY" \ # obtenha a chave API de uma variável de ambiente # ou # -H "Authorization: Bearer sk-xxxxxxxxxxxxxxxxxxxx" \ # hard-code a chave API (não recomendado) -d ' "prompt" : "Olá, mundo!", "max_tokens": 5 ' ``` Como fazer solicitações de API com sua chave de API
Depois de configurar sua chave de API em seu código ou ferramenta, você pode começar a fazer solicitações à API OpenAI. A API OpenAI consiste em vários endpoints que correspondem a diferentes modelos e funcionalidades de IA.Por exemplo, você pode usar o terminal `/v1/engines` para listar todos os mecanismos disponíveis ou usar o terminal `/v1/engines/engine_id/completions` para gerar conclusões de texto de um determinado mecanismo e prompt. Você pode encontrar mais detalhes sobre os endpoints e seus parâmetros no .
Para fazer uma solicitação para um endpoint, você precisa especificar o método HTTP (geralmente `GET` ou `POST`), a URL do endpoint e, opcionalmente, alguns dados ou parâmetros no formato JSON. Você também precisa incluir sua chave de API no cabeçalho `Authorization` conforme explicado acima. Dependendo do endpoint e dos dados, você receberá uma resposta da API OpenAI que contém algumas informações ou resultados no formato JSON. Você pode analisar e processar a resposta de acordo com suas necessidades.
Aqui estão alguns exemplos de como fazer solicitações para diferentes endpoints usando diferentes linguagens e ferramentas:
- Python: Você pode usar o módulo `openai` para fazer requisições para qualquer endpoint com uma simples chamada de função. Por exemplo, para listar todos os mecanismos disponíveis, você pode usar: ```python import openai response = openai.Engine.list() print(response) ``` Para gerar uma conclusão de texto a partir de um determinado mecanismo e prompt, você pode usar: ```python import openai response = openai.Completion.create( engine="davinci", prompt="Hello, world!", max_tokens=5 ) print(response) ``` - Node.js: Você pode usar o instância `openai` para fazer solicitações a qualquer terminal com uma simples chamada de método. Por exemplo, para listar todos os engines disponíveis, você pode usar: ```javascript openai.listEngines().then(response => console.log(response); ); ``` Para gerar uma conclusão de texto a partir de um determinado mecanismo e prompt, você pode usar: ```javascript openai.complete( engine: "davinci", prompt: "Hello, world!", maxTokens: 5 ).then(response => console.log(response); ); ``` - curl: Você pode usar a ferramenta de linha de comando curl para fazer solicitações a qualquer endpoint com um comando simples.Por exemplo, para listar todos os mecanismos disponíveis, você pode usar: ```bash curl \ -H "Autorização: Bearer $OPENAI_API_KEY" ``` Para gerar uma conclusão de texto a partir de um determinado mecanismo e prompt, você pode usar: ```bash curl \ -H "Autorização: Bearer $OPENAI_API _KEY" \ -d ' "prompt": "Olá, mundo!", "max_tokens": 5 ' ``` Como gerenciar e proteger suas chaves de API
Como você pode ver, sua chave de API é muito importante para acessar a API OpenAI e seus modelos. Portanto, você precisa gerenciar e proteger suas chaves de API adequadamente para evitar o uso não autorizado ou mal-intencionado. Aqui estão algumas práticas recomendadas para gerenciar e proteger suas chaves de API:
Não compartilhe sua chave de API com ninguém nem a exponha publicamente. Se você precisar compartilhar seu código ou projeto com outras pessoas, remova ou oculte sua chave de API do código ou use uma variável de ambiente.
Não codifique sua chave de API em seu código ou ferramenta. Em vez disso, use uma variável de ambiente ou um arquivo de configuração para armazenar sua chave de API e carregá-la dinamicamente quando necessário.
Use diferentes chaves de API para diferentes projetos ou finalidades. Dessa forma, você pode rastrear e controlar facilmente o uso e o limite de cada chave de API. Você também pode revogar ou regenerar uma chave de API se ela estiver comprometida ou não for mais necessária.
Defina um limite de uso ou data de expiração para suas chaves de API. Dessa forma, você pode evitar o uso excessivo ou indesejado da API OpenAI e seus modelos. Você também pode evitar cobranças inesperadas se estiver usando um plano pago.
Monitore e audite o uso de sua chave de API regularmente. Você pode usar o para obter notificações de eventos importantes relacionados ao uso da chave de API, como limite de taxa excedido, chave expirada ou chave revogada.
Problemas comuns e dicas de solução de problemas para chaves de API OpenAI
Como corrigir o erro "Chave de API incorreta fornecida"
Se você receber uma mensagem de erro que diz "Chave API incorreta fornecida" ao fazer uma solicitação para a API OpenAI, isso significa que sua chave API é inválida ou incorreta. Isso pode acontecer por vários motivos, como:
Você inseriu uma chave de API incorreta ou incompleta em seu código ou ferramenta.
Você usou uma chave de API expirada ou revogada.
Você usou uma chave de API que pertence a uma conta ou organização diferente.
Você usou uma chave de API que não tem as permissões ou escopos necessários para o terminal ou modelo que está tentando acessar.
Para corrigir esse erro, você precisa verificar e verificar sua chave de API e garantir que ela seja válida, correta e tenha as permissões e os escopos apropriados. Você pode fazer isso seguindo estas etapas:
Vá para em platform.openai.com e entre com sua conta OpenAI.
Clique no ícone do seu perfil no canto superior direito da página e selecione "Exibir chaves de API".
Encontre a chave de API que você está usando e verifique seus detalhes, como data de expiração, status, limite de uso e escopos.
Se a chave de API expirou ou foi revogada, você precisa gerar uma nova clicando em "Criar nova chave secreta".
Se a chave API estiver incorreta ou incompleta, você precisará copiá-la novamente na janela pop-up ou na tabela.
Se a chave de API pertencer a uma conta ou organização diferente, você precisará alternar para a correta clicando no ícone do seu perfil e selecionando "Alternar organização".
Se a chave de API não tiver as permissões ou escopos necessários, você precisará editá-la clicando em "Editar" e selecionando as apropriadas.
Como corrigir o erro "Limite de taxa excedido"
Se você receber uma mensagem de erro dizendo "Rate Limit Exceeded" ao fazer uma solicitação para a API OpenAI, isso significa que você excedeu o número máximo de solicitações que pode fazer por segundo ou por mês com sua chave de API. Isso pode acontecer por vários motivos, como:
Você fez muitas solicitações em um curto período de tempo, como em um loop ou em lote.
Você fez solicitações que consomem uma grande quantidade de tokens, como usar um modelo complexo ou um prompt longo.
Você compartilhou sua chave de API com outras pessoas que também estão fazendo solicitações com ela.
Para corrigir esse erro, você precisa reduzir a frequência ou o tamanho de suas solicitações e certificar-se de que não está compartilhando sua chave de API com ninguém. Você pode fazer isso seguindo estas etapas:
Vá para em platform.openai.com e entre com sua conta OpenAI.
Clique no ícone do seu perfil no canto superior direito da página e selecione "Exibir chaves de API".
Encontre a chave de API que você está usando e verifique seu limite de uso e uso atual. Você pode ver o número de solicitações por segundo e por mês, bem como o número de tokens consumidos por mês.
Se você estiver próximo ou acima do limite, precisará aguardar até o próximo segundo ou mês para fazer mais solicitações ou atualizar seu plano para obter um limite maior.
Se você não estiver perto do limite, mas ainda receber o erro, verifique seu código ou ferramenta e veja se pode otimizá-lo para fazer menos ou menores solicitações. Por exemplo, você pode usar um modelo mais simples ou um prompt mais curto ou adicionar algum atraso ou limitação entre as solicitações.
Se você suspeitar que outra pessoa está usando sua chave de API, você precisa revogá-la e gerar uma nova clicando em "Revogar" e "Criar nova chave secreta".
Como corrigir o erro "Chave de API não está funcionando"
Se você receber uma mensagem de erro dizendo "API Key Not Working" ao fazer uma solicitação para a OpenAI API, isso significa que sua chave de API não é reconhecida ou aceita pela OpenAI API. Isso pode acontecer por vários motivos, como:
Você não configurou sua chave de API corretamente em seu código ou ferramenta.
Você cometeu um erro de digitação ou de formatação em sua chave de API ou solicitação.
Você encontrou uma falha ou interrupção temporária no serviço OpenAI API.
Para corrigir esse erro, você precisa verificar e verificar sua chave e solicitação de API e garantir que estejam corretos e válidos. Você pode fazer isso seguindo estas etapas:
Vá para em platform.openai.com e entre com sua conta OpenAI.
Clique no ícone do seu perfil no canto superior direito da página e selecione "Exibir chaves de API".
Encontre a chave de API que você está usando e copie-a da janela pop-up ou da tabela.
Cole sua chave de API em seu código ou ferramenta e verifique se ela está configurada corretamente de acordo com as instruções de seu idioma ou ferramenta. Por exemplo, certifique-se de que ele esteja incluído no cabeçalho `Authorization` de sua solicitação e que tenha o prefixo `sk-`.
Verifique sua solicitação e certifique-se de que esteja formatada corretamente de acordo com o . Por exemplo, certifique-se de que ele tenha um URL, método, dados e parâmetros válidos.
Tente fazer sua solicitação novamente e veja se funciona. Caso contrário, tente usar uma chave de API ou endpoint diferente ou entre em contato para assistência.
Conclusão
Neste artigo, abordamos como obter e usar uma chave de API OpenAI. Explicamos o que é OpenAI, por que você precisa de uma chave de API, como obter uma, como usá-la, como gerenciá-la e protegê-la e como solucionar alguns problemas comuns. Esperamos que este artigo tenha ajudado você a entender como acessar e aproveitar os incríveis modelos de IA que o OpenAI fornece para seus projetos. Se você tiver alguma dúvida ou feedback, sinta-se à vontade para deixar um comentário abaixo.
perguntas frequentes
O que é uma chave de API OpenAI?
Uma chave de API OpenAI é um identificador exclusivo que permite acessar a API OpenAI, que é a interface que conecta você aos modelos de IA que OpenAI cria e publica.
Como obtenho uma chave de API OpenAI?
Para obter uma chave de API OpenAI, você precisa ir para em platform.openai.com e entre com uma conta OpenAI.Em seguida, você precisa clicar no ícone do seu perfil no canto superior direito da página e selecionar "Exibir chaves de API". Então você precisa clicar em "Criar nova chave secreta" para gerar uma nova chave de API. Certifique-se de copiá-lo e salvá-lo em algum lugar seguro, pois você não poderá vê-lo novamente depois de fechar a janela.
Como uso uma chave de API OpenAI?
Para usar uma chave de API OpenAI, você precisa configurá-la em seu código ou ferramenta e incluí-la no cabeçalho `Authorization` de suas solicitações para a API OpenAI. Você pode usar diferentes linguagens ou ferramentas para fazer solicitações, como Python, Node.js ou curl. Você também pode usar as bibliotecas oficiais ou wrappers para a API OpenAI que estão disponíveis para diferentes linguagens ou estruturas.
Como faço para gerenciar e proteger minhas chaves de API OpenAI?
Para gerenciar e proteger suas chaves de API OpenAI, você precisa seguir algumas práticas recomendadas, como:
Não compartilhe sua chave de API com ninguém nem a exponha publicamente.
Não codifique sua chave de API em seu código ou ferramenta.
Use diferentes chaves de API para diferentes projetos ou finalidades.
Defina um limite de uso ou data de expiração para suas chaves de API.
Monitore e audite o uso de sua chave de API regularmente.
Como soluciono alguns problemas comuns com minhas chaves de API OpenAI?
Para solucionar alguns problemas comuns com suas chaves de API OpenAI, você precisa verificar e verificar sua chave e solicitação de API e certificar-se de que estejam corretos e válidos. Alguns dos problemas comuns e suas soluções são:
Erro "Chave de API incorreta fornecida": verifique se sua chave de API expirou, foi revogada, incorreta, incompleta ou pertence a uma conta ou organização diferente. Nesse caso, gere um novo ou edite-o de acordo.
Erro "Rate Limit Exceeded": verifique se você excedeu o número máximo de solicitações ou tokens que pode fazer por segundo ou por mês com sua chave de API. Nesse caso, espere até o próximo segundo ou mês, atualize seu plano ou otimize seu código ou ferramenta para fazer menos ou menores solicitações.
Erro "API Key Not Working": Verifique se você configurou sua chave API corretamente em seu código ou ferramenta e se sua solicitação está formatada corretamente de acordo com o para assistência.
0517a86e26
Comments