Tutorial: Integrando a API da Open AI em uma aplicação Node.js

Tutorial: Integrando a API da Open AI em uma aplicação Node.js

Tabela de Conteúdos

1. Introdução
2. Preparação
3. Configuração do Node.js e NPM
4. Criação da Aplicação Node
5. Integração da API Open AI
   1. Criação de uma Conta na Open AI
   2. Acesso às Chaves da API
   3. Importação dos Plugins Necessários
6. Instalação do Express
7. Instalação do Body Parser
8. Instalação do Open AI
9. Definição das Variáveis de Configuração
10. Criação das Rotas da API
11. Recebendo os Parâmetros de Requisição
12. Configurando a Chamada para a API da Open AI
13. Recebendo a Resposta da API e Retornando para o Cliente
14. Conclusão

🚀 Introdução

Neste artigo, vamos explorar a integração da API da Open AI em uma aplicação Node.js. A Open AI é uma plataforma que oferece serviços de computação cognitiva, permitindo que desenvolvedores utilizem modelos de inteligência artificial em suas aplicações. Vamos aprender como configurar a API, instalar os plugins necessários e fazer chamadas para a Open AI através de uma aplicação Node.js.

Preparação

Antes de começarmos, é importante ter o Node.js e o NPM (Node Package Manager) instalados em sua máquina. Caso ainda não tenha, faça o download e a instalação seguindo as instruções do site oficial do Node.js.

Configuração do Node.js e NPM

Após a instalação do Node.js e NPM, vamos iniciar a criação de nossa aplicação Node. Abra o terminal ou Prompt de comando e navegue até o diretório onde deseja criar o projeto. Em seguida, execute o comando npm init para criar um novo projeto Node. Siga as instruções no terminal para definir o nome do projeto, versão, descrição e outros detalhes relevantes.

Criação da Aplicação Node

Com o projeto Node criado, vamos prosseguir para a criação do arquivo index.js, que é onde faremos todo o trabalho necessário para integrar a API da Open AI. Certifique-se de que possui uma conta na Open AI e faça o login para acessar suas chaves de API.

💡 Dica: Caso ainda não tenha uma conta, você pode se inscrever gratuitamente no site da Open AI.

Em sua conta, localize a opção "View API Keys" para acessar suas chaves de API. Aqui você pode criar novas chaves, revisar as existentes ou excluí-las. Copie a chave de acesso gerada, pois precisaremos dela em nosso código.

Integração da API Open AI

Para começar a integração com a API da Open AI, vamos importar alguns plugins em nosso projeto. Primeiramente, vamos instalar o Express, um framework web para Node.js. Em seguida, vamos instalar o Body Parser, responsável por analisar o corpo das requisições HTTP. Por fim, instalaremos o Open AI, a biblioteca que nos auxiliará na integração com a API.

Utilize os seguintes comandos para instalar os plugins:

npm install express
npm install body-parser
npm install openai

Após a instalação dos plugins, vamos importá-los em nosso código. Começaremos importando o Express:

const express = require('express');

Instalação do Express

Para instalar o Express, utilizaremos o comando:

npm install express

Instalação do Body Parser

Agora, vamos instalar o Body Parser, que será responsável por analisar o corpo das requisições HTTP:

npm install body-parser

Instalação do Open AI

Por fim, instalaremos a biblioteca Open AI, que nos ajudará na integração com a API:

npm install OpenAI

Definição das Variáveis de Configuração

Antes de prosseguirmos, vamos definir as variáveis de configuração necessárias para a integração com a API da Open AI. A primeira variável a ser definida é a chave de API. Como já copiamos nossa chave de acesso anteriormente, podemos definir a variável dessa forma:

const apiKey = 'SUA_CHAVE_DE_API';

💡 Dica: Você também pode definir a chave de API como uma variável de ambiente, caso prefira. Para isso, utilize process.env.API_KEY em vez de 'SUA_CHAVE_DE_API'.

Em seguida, vamos configurar a API da Open AI utilizando a chave de API:

const openai = require('openai');
const configuration = {
  apiKey: apiKey
};
const openAiApi = new openai.OpenAiApi(configuration);

Criação das Rotas da API

Agora, vamos criar a rota que receberá os parâmetros da requisição e fará a chamada para a API da Open AI. Utilizaremos o método POST para passar um prompt para nosso backend.

app.post('/api/openai', (req, res) => {
  const prompt = req.body.prompt;

  // Chamada para a API da Open AI
});

Recebendo os Parâmetros de Requisição

Para receber os parâmetros de requisição, vamos passar o JSON como corpo da requisição. Esperamos que o objeto JSON contenha uma chave chamada "prompt" que conterá o texto a ser enviado para a API da Open AI.

app.post('/api/openai', (req, res) => {
  const prompt = req.body.prompt;

  // Restante do código
});

Configurando a Chamada para a API da Open AI

Agora que temos o prompt recebido, podemos fazer a chamada para a API da Open AI. Utilizaremos a biblioteca openai e a função createCompletion() para isso.

app.post('/api/openai', (req, res) => {
  const prompt = req.body.prompt;

  const response = openAiApi.createCompletion({
    model: 'text-davinci-002',
    prompt: prompt,
    maxTokens: 2048,
    temperature: 0,
    stop: '\n'
  });

  // Restante do código
});

Recebendo a Resposta da API e Retornando para o Cliente

Após fazer a chamada para a API da Open AI, receberemos a resposta com possíveis completions. Vamos enviar apenas a primeira completion, limitando-nos a um único retorno.

app.post('/api/openai', (req, res) => {
  const prompt = req.body.prompt;

  const response = openAiApi.createCompletion({
    model: 'text-davinci-002',
    prompt: prompt,
    maxTokens: 2048,
    temperature: 0,
    stop: '\n'
  });

  const firstCompletion = response.data.choices[0].text;

  res.json({ completion: firstCompletion });
});

Conclusão

Neste artigo, aprendemos como integrar a API da Open AI em uma aplicação Node.js. Configuramos o ambiente, instalamos os plugins necessários e criamos as rotas para receber e processar os parâmetros da requisição. Com as respostas da API, retornamos para o cliente a primeira completion obtida. Agora você está pronto para explorar e utilizar os poderosos recursos de inteligência artificial da Open AI em suas aplicações.

Destaques

• Integração da API da Open AI em uma aplicação Node.js
• Configuração do ambiente com Node.js e NPM
• Criação das rotas para receber e processar os parâmetros da requisição
• Utilização da biblioteca Open AI para fazer chamadas à API
• Retorno do resultado da API para o cliente

FAQ

Como posso criar uma conta na Open AI?

Para criar uma conta na Open AI, acesse o site oficial da plataforma e siga as instruções de registro.

Onde posso encontrar as chaves de API da Open AI?

Após fazer o login em sua conta na Open AI, você pode acessar suas chaves de API na seção "View API Keys".

Posso definir a chave de API como uma variável de ambiente?

Sim, é possível definir a chave de API como uma variável de ambiente. Basta utilizar process.env.API_KEY em vez de 'SUA_CHAVE_DE_API' no código.

Recursos

• Site oficial da Open AI
• Repositório GitHub da biblioteca Open AI