OpenAI API: Preparação eficaz para chamadas de API

Neste tutorial, você aprenderá como se preparar para usar a API OpenAI. Vou guiar você passo a passo pelo processo, garantindo que você configure todos os componentes necessários - desde a criação de uma chave de API até a instalação do pacote OpenAI-NPM necessário. Em seguida, vou mostrar como você pode usar a API em seu aplicativo. Vamos começar!

Principais conclusões

• Uma chave de API é necessária para acessar a API OpenAI, que você pode gerar na plataforma OpenAI.
• Você precisa do pacote openai-npm para fazer chamadas à API.
• Tudo isso é feito com Node.js e JavaScript, e vou mostrar como configurar isso.

Guia passo a passo

Para poder usar com sucesso a API OpenAI, siga estes passos:

1. Crie uma conta na plataforma OpenAI

Primeiro, você precisa criar uma conta na plataforma OpenAI. Abra seu navegador e vá para platform.openai.com. Clique em "Inscrever-se" para se registrar.

Informe seu endereço de e-mail e escolha uma senha. Alternativamente, você também pode se inscrever usando sua conta do Google, Microsoft ou Apple.

2. Gere sua chave de API

Depois de criar sua conta, acesse as configurações. Lá, você encontrará a opção "Chaves da API". Aqui você pode gerar sua chave de API.

Clique no botão correspondente para criar uma nova chave de API. Você pode dar a ela um nome. Após a criação, a chave de API será exibida. Copie essa chave e salve-a com segurança - seja no código de sua aplicação ou em um arquivo separado.

Esteja ciente de que não deve perder essa chave. Se fechar a janela de diálogo, não será possível visualizar a chave novamente e será necessário criar uma nova.

3. Entenda o sistema de tokens

Para usar a API, você precisará de tokens ou créditos. Cada chamada à API consome uma certa quantidade de tokens. É importante saber que os tokens muitas vezes são mais do que o número real de palavras, pois também podem incluir partes de palavras.

Ao se inscrever, você geralmente recebe uma quantidade de créditos que pode usar em suas chamadas à API. Certifique-se de guardar suas chaves com segurança para poder acessá-las a qualquer momento.

4. Instale o pacote openai-npm

O próximo passo é instalar o pacote openai-npm. Vá para o seu terminal e navegue até o diretório onde você criou sua aplicação.

Execute o comando npm install openai para instalar o pacote.

Depois que a instalação estiver concluída, verifique o arquivo package.json para garantir que o pacote tenha sido adicionado com sucesso.

5. Importe os módulos necessários

Agora que o pacote está instalado, você precisa importar os módulos necessários em seu código JavaScript. Importe os módulos Configuration e OpenAI do pacote openai.

6. Configurar a API da OpenAI

Agora podes configurar a API. Cria um novo objeto de configuração que contenha a tua chave de API.

Para isso, utiliza a chamada new Configuration() e passa o teu objeto de chave de API.

Depois, podes inicializar a OpenAI API com o comando new OpenAI({configuration}).

7. Preparar a solicitação da API

Em seguida, deves preparar a solicitação da API para fazer a chamada da API. Cria uma função assíncrona na qual vais precisar da consulta à API.

A função completeChat recebe uma mensagem passada em uma variável. Chame o método createChatCompletion do OpenAI e passe os parâmetros necessários, como o modelo (por exemplo, gpt-3.5-turbo) e todas as mensagens que enviaste.

8. Processar a resposta da API

Quando tiveres feito com sucesso a chamada à API, vais receber uma resposta que tens de processar. Na resposta, vais encontrar os dados de que precisas, como escolhas, que contêm a resposta gerada pela API.

Guarda o conteúdo da resposta e devolve-o, para que o possas usar na tua aplicação.

9. Testar a tua função

Agora é hora de testar a função. Inicia o teu servidor local e verifique se recebes uma resposta do AI.

Screenshot_567

Deverás ser capaz de obter respostas diferentes ao fazer várias consultas, o que demonstra que a comunicação com o modelo está a funcionar.

Resumo

Neste tutorial, aprendeste como preparar-te para aceder à API da OpenAI. Desde a geração de uma chave de API e a instalação do pacote npm necessário até à criação de um pedido à API e processamento de respostas - passaste por todos os passos básicos.