Pular para o conteúdo principal

Guia para iniciantes sobre a API da OpenAI: Tutorial prático e práticas recomendadas

Este tutorial apresenta a você a API OpenAI, seus casos de uso, uma abordagem prática para usar a API e todas as práticas recomendadas a serem seguidas.
Actualizado 11 de set. de 2024  · 13 min de leitura

Com o lançamento do ChatGPT, houve muito entusiasmo em relação à inteligência artificial e suas aplicações em todo o mundo, especialmente entre as partes interessadas sênior não técnicas da empresa. Todas as empresas querem fazer uso da tecnologia que experimentaram no ChatGPT, adaptada ao seu setor e ao seu crescimento.

Mas como podemos conseguir isso?

A resposta é simples: as empresas podem usar a API OpenAI, em rápida evolução, desenvolvida e disponibilizada pelos criadores do ChatGPT, para criar soluções personalizadas adaptadas às necessidades da empresa.

Como cientistas de dados iniciantes e praticantes de aprendizado de máquina, sabemos que a OpenAI já existe há algum tempo, mesmo antes do hype do ChatGPT, mas a maioria de nós não a estava usando para resolver problemas de negócios no setor. Com todo o progresso dos últimos tempos, é mais importante do que nunca entender a API de forma abrangente.

Neste tutorial, faremos exatamente isso: apresentaremos o OpenAI e sua API, abordaremos a prática desde a criação de uma conta do OpenAI até o uso da API para obter respostas e discutiremos as práticas recomendadas ao usar a API para fornecer uma visão geral abrangente da API do OpenAI.

Você tem interesse em ver a OpenAPI em ação? Confira nosso code-along sobre a criação de chatbots com a API OpenAI e o Pinecone:

Uma visão geral da OpenAI e de sua API

A OpenAI é uma empresa de pesquisa e implantação de IA que trabalha com a missão de garantir que a inteligência artificial geral beneficie toda a humanidade.

A empresa foi fundada como uma organização sem fins lucrativos em 2015, com a equipe fundadora incluindo nomes como Elon Musk e Sam Altman. Ao longo dos anos, a OpenAI fez a transição de seu início sem fins lucrativos para um modelo mais diversificado para cumprir sua missão, com parcerias com gigantes da tecnologia, como a Microsoft.

O que é a API da OpenAI?

A API (Interface de Programação de Aplicativos) da OpenAI serve como uma ponte para os modelos avançados de aprendizado de máquina da OpenAI, permitindo que você integre recursos de IA de ponta em seus projetos com relativa facilidade.

Em termos mais simples, a API é como um auxiliar que permite que você use os programas inteligentes da OpenAI em seus projetos. Por exemplo, você pode adicionar recursos interessantes, como a compreensão e a criação de texto, sem precisar conhecer todos os detalhes minuciosos dos modelos subjacentes.

Desenvolver aplicativos de IA

Aprenda a criar aplicativos de IA usando a API OpenAI.
Comece a Treinar Gratuitamente

Recursos da API da OpenAI

Aqui estão alguns dos principais recursos que tornam a API OpenAI uma ferramenta valiosa para quem deseja incorporar a IA em seus negócios:

1. Modelos de IA pré-treinados

Modelos pré-treinados são modelos de aprendizado de máquina que já foram treinados em um grande conjunto de dados, geralmente em uma tarefa geral, antes de serem usados para uma tarefa específica. A equipe da OpenAI treinou e lançou esses modelos na forma de API, o que significa que "eles treinam uma vez, nós usamos muitas vezes", o que pode economizar muito tempo e recursos.

Alguns dos modelos lançados são:

  • GPT-4: Versões aprimoradas dos modelos GPT-3.5, capazes de compreender e criar texto e código.
  • GPT-3.5:: Versões aprimoradas dos modelos GPT-3, capazes de compreender e gerar texto ou código.
  • Base GPT: Modelos que podem processar e gerar texto ou código, mas não têm capacidade de seguir instruções.
  • DALL-E: Um modelo que cria e modifica imagens com base em solicitações de texto.
  • Sussurre: Transforma a entrada de áudio em texto escrito.
  • Embeddings: Modelos que transformam texto em valores numéricos.
  • Moderação: Um modelo ajustado que identifica texto potencialmente sensível ou inseguro.

Esses modelos foram treinados com grandes quantidades de dados e utilizaram um poder de computação significativamente alto, geralmente não disponível ou acessível a indivíduos ou mesmo a muitas organizações. Agora, os cientistas de dados e as empresas podem utilizar facilmente os modelos pré-treinados na forma de uma API.

2. Modelos de IA personalizáveis

A personalização de modelos na API OpenAI envolve principalmente um processo conhecido como ajuste fino, que permite aos usuários adaptar modelos pré-treinados para melhor atender aos seus casos de uso específicos.

A API da OpenAI nos permite pegar os modelos pré-treinados e usar nossos dados de treinamento, treinar ainda mais os modelos e usar os modelos ajustados para nossos casos de uso. Você pode ler mais sobre o processo de ajuste fino de um modelo GPT-3 aqui. O ajuste fino economiza custos e permite solicitações de menor latência para aplicativos downstream.

3. Interface API simples

A plataforma da API da OpenAI é intuitiva e simples de usar para um iniciante. Com algumas linhas de código, graças à documentação abrangente e aos exemplos de início rápido, é fácil começar a usar a API em seus casos de uso sem precisar passar por uma curva de aprendizado acentuada.

Essa simplicidade é útil para pessoas que estão no início de suas carreiras de dados, tornando o passo para a IA menos intimidador e mais envolvente.

4. Infraestrutura escalável

A OpenAI dimensionou clusters Kubernetes para 7.500 nós para fornecer uma infraestrutura dimensionável para modelos grandes como GPT-3, CLIP e DALL-E, bem como para pesquisas iterativas rápidas em pequena escala. O Serviço Azure OpenAI é executado na infraestrutura global do Azure para atender às necessidades de produção, como segurança empresarial crítica, conformidade e disponibilidade regional, indicando uma infraestrutura escalável para dar suporte ao uso da API OpenAI.

À medida que seus projetos se tornam maiores e mais complexos, você precisa de uma infraestrutura que possa crescer com eles. A capacidade da API OpenAI de ser dimensionada quando o uso aumenta é especialmente útil quando você passa de projetos pequenos para projetos maiores e mais exigentes, tornando a API OpenAI uma ferramenta confiável para seus projetos.

Casos de uso da API OpenAI no setor

Mais de 300 aplicativos estão agora utilizando o GPT-3 por meio da API OpenAI, indicando uma vasta gama de aplicativos criativos e exclusivos que estão sendo desenvolvidos em todo o mundo. Aqui estão alguns dos aplicativos comuns do setor da API OpenAI:

1. Chatbots e assistentes virtuais

A capacidade da API OpenAI de compreender e gerar texto semelhante ao humano faz dela uma excelente candidata para a criação de chatbots inteligentes e assistentes virtuais. Os modelos pré-treinados, como o GPT-4 ou o ChatGPT, podem ser empregados para alimentar agentes de conversação que podem interagir com os usuários de forma natural e intuitiva. Esses agentes podem ser implantados em sites, aplicativos ou plataformas de atendimento ao cliente para melhorar o envolvimento do usuário e fornecer suporte automatizado.

2. Análise de sentimento

A análise de sentimento consiste em entender o sentimento por trás dos dados textuais. Com a API OpenAI, você pode analisar avaliações de clientes, comentários em mídias sociais ou qualquer dado textual para avaliar a opinião pública ou a satisfação do cliente. Ao utilizar modelos como o GPT-4 ou 3.5, você pode automatizar o processo de análise de sentimentos, obtendo insights que podem ser essenciais para as estratégias de negócios.

3. Reconhecimento de imagens

Embora a OpenAI seja frequentemente associada ao processamento de texto, ela também se aventura no domínio do reconhecimento de imagens com modelos como o CLIP. O CLIP é um modelo que aprende conceitos visuais a partir de descrições de linguagem natural e pode ser empregado por meio da API OpenAI para tarefas como detecção de objetos, classificação de imagens e muito mais. Isso abre possibilidades em vários campos, inclusive na área da saúde, onde o reconhecimento de imagens pode ser usado para identificar condições médicas a partir de dados de imagens.

4. Jogos e aprendizado por reforço

A API OpenAI também é aplicada no setor de jogos e em ambientes de aprendizado por reforço. Os modelos podem ser treinados ou ajustados para interagir com os ambientes de jogos, tomando decisões que podem jogar o jogo de forma autônoma ou auxiliar os jogadores na jogabilidade.

A OpenAI demonstrou isso com modelos como o Dactyl, que aprendeu a resolver um cubo de Rubik usando o aprendizado por reforço, e o OpenAI Five, que competiu contra jogadores humanos no jogo Dota 2.

Agora que você já entendeu a API da OpenAI e seus casos de uso, vamos colocar a mão na massa e começar a usá-la.

Prática: Primeiros passos com a API OpenAI

Vamos supor que você seja um iniciante absoluto na API da OpenAI e vamos fazer sua primeira chamada à API passo a passo.

Etapa 1: Criar uma conta na plataforma OpenAI

Antes de mais nada, você precisará de uma conta na plataforma OpenAI.

Acesse a plataforma da OpenAI e siga as instruções para criar uma conta. Você deverá ver algo parecido com isso depois de se inscrever:

Página de destino da plataforma OpenAI

Etapa 2: Obtenha sua chave de API

Depois que sua conta estiver configurada, você precisará recuperar sua chave de API, que é essencial para interagir com a API.

Navegue até a página de chaves de API em sua conta da OpenAI, conforme mostrado no diagrama abaixo.

Submenu Chave de API

Agora você pode criar uma chave de API, que deve ser copiada e mantida em segurança, pois não será possível visualizá-la novamente. No entanto, se você a perder ou precisar de uma nova, uma nova poderá ser gerada.

Botão Criar nova chave secreta

Etapa 3: Instale a biblioteca OpenAI Python

Agora que a configuração da conta e as chaves de API estão prontas, a próxima etapa é trabalhar na configuração da máquina local. Podemos acessar a API da OpenAI em nosso computador local por meio da biblioteca Python da OpenAI.

Você pode instalá-lo usando o pip com o comando abaixo:

pip install openai

Etapa 4: Fazendo sua primeira chamada à API

Agora que você tem sua chave de API e a biblioteca OpenAI instaladas, é hora de fazer sua primeira chamada de API.

Aqui está o código para você fazer isso:

def get_chat_completion(prompt, model="gpt-3.5-turbo"):
  
   # Creating a message as required by the API
   messages = [{"role": "user", "content": prompt}]
  
   # Calling the ChatCompletion API
   response = openai.ChatCompletion.create(
       model=model,
       messages=messages,
       temperature=0,
   )

   # Returning the extracted response
   return response.choices[0].message["content"]

response = get_chat_completion("Translate into Spanish: As a beginner data scientist, I'm excited to learn about OpenAI API!")

print(response)

Escrevemos uma função auxiliar para usar a API ChatCompletion selecionando o modelo "gpt-3.5-turbo", que aceita o prompt gerado pelo usuário e retorna a resposta.

Aqui está a resposta (sinta-se à vontade para validá-la se você souber um pouco de espanhol!)

Tradução para o espanhol usando a API

Etapa 5: Explorando mais

Com sua primeira chamada à API, você está no caminho certo! Aqui estão algumas próximas etapas que você deve considerar:

  • Explore diferentes mecanismos e descubra o que funciona melhor para seu caso de uso.
  • Faça experiências com diferentes prompts e parâmetros para ver como a API responde.
  • Mergulhe na documentação da OpenAI para saber mais sobre o que você pode fazer com a API.

A ideia aqui é que você faça um brainstorming sobre como usar a API para o problema comercial em questão (há mais recursos fornecidos no final do tutorial).

Práticas recomendadas ao usar a API da OpenAI

Agora que você já se sente confortável com a API, veja algumas práticas recomendadas que devem ser observadas antes de usá-las em seus projetos:

1. Compreensão dos preços da API

A API oferece uma variedade de modelos, cada um com diferentes recursos e pontos de preço, na abordagem "pague pelo que você usa". Os custos são incorridos por 1.000 tokens, onde os tokens são essencialmente pedaços de palavras, e 1.000 tokens equivalem a cerca de 750 palavras. Você pode encontrar os preços atualizados para todos os modelos na página de preços da OpenAI.

Ao se inscrever, você começa com US$ 5 em crédito gratuito que pode ser utilizado durante os três primeiros meses. Você pode experimentar o tutorial e entender melhor a API antes de decidir pagar.

2. Protegendo sua chave de API

Em vez de codificar a chave da API diretamente no código-fonte do aplicativo, use variáveis de ambiente para armazenar e recuperar a chave da API, o que é uma prática mais segura.

Também é um desafio gerenciar chaves de API codificadas, especialmente em um ambiente de equipe. Se a chave precisar ser girada ou alterada, cada instância da chave codificada no código-fonte precisará ser encontrada e atualizada.

3. Usando os modelos mais recentes

A OpenAI recomenda usar os modelos mais recentes para o problema que você deseja resolver quando houver várias versões disponíveis. Isso faz sentido, pois os modelos mais novos são mais capazes, mas também têm um custo mais alto. Em geral, vale a pena experimentar alguns modelos disponíveis e escolher o que melhor se aplica às necessidades do seu caso de uso, considerando a relação custo x desempenho.

4. Utilização eficiente dos limites de tokens por meio do Batching

Batching é uma técnica que permite que você agrupe várias tarefas em uma única solicitação de API para processá-las juntas com eficiência, em vez de enviar solicitações individuais para cada tarefa.

A API da OpenAI impõe limites separados para o número de solicitações por minuto e o número de tokens por minuto que você pode processar. Se você estiver atingindo o limite de solicitações por minuto, mas tiver capacidade não utilizada no limite de tokens por minuto, a criação de lotes pode ajudar a utilizar essa capacidade com eficiência.

Ao agrupar várias tarefas menores em uma única solicitação, você reduz o número total de solicitações enviadas e, ao mesmo tempo, possivelmente processa mais tokens em uma única solicitação, ficando assim abaixo dos limites de taxa e otimizando os custos.

Conclusão

Se você é relativamente novo na ciência de dados, talvez não tenha se envolvido muito com APIs. Embora isso fosse normal no passado, com o rápido progresso e os recursos de IA de empresas como a OpenAI, saber como usar efetivamente seus modelos pré-treinados (e ajustá-los) a partir de sua API tornou-se uma habilidade essencial para todo cientista de dados economizar tempo, custos e outros recursos.

Este tutorial apresentou a OpenAI, sua API e alguns casos de uso comuns específicos do setor para ela. Você também aprendeu a usar a API da OpenAI e as práticas recomendadas a serem seguidas.

A próxima etapa seria ampliar seu conhecimento sobre a API da OpenAI usando tutoriais como:

Se, em vez disso, você preferir uma abordagem guiada que ofereça uma experiência prática complementar a este tutorial, confira nosso próprio curso Trabalhando com a API OpenAI.

Obtenha uma das melhores certificações de IA

Demonstre que você pode usar a IA de forma eficaz e responsável.

Photo of Arunn Thevapalan
Author
Arunn Thevapalan
LinkedIn
Twitter

Como cientista de dados sênior, eu projeto, desenvolvo e implanto soluções de aprendizado de máquina em larga escala para ajudar as empresas a tomar melhores decisões baseadas em dados. Como redator de ciência de dados, compartilho aprendizados, conselhos de carreira e tutoriais práticos e detalhados.

Temas

Comece sua jornada de IA hoje mesmo!

curso

Introduction to ChatGPT

1 hr
261.9K
Learn how to use ChatGPT. Discover best practices for writing prompts and explore common business use cases for the powerful AI tool.
Ver DetalhesRight Arrow
Iniciar Curso
Ver maisRight Arrow
Relacionado

blog

Como aprender IA do zero em 2024: Um guia completo dos especialistas

Descubra tudo o que você precisa saber sobre o aprendizado de IA em 2024, desde dicas para começar, recursos úteis e insights de especialistas do setor.
Adel Nehme's photo

Adel Nehme

20 min

blog

O que é IA? Um guia rápido para iniciantes

Descubra o que realmente é inteligência artificial com exemplos, opiniões de especialistas e todas as ferramentas de que você precisa para aprender mais.
Matt Crabtree's photo

Matt Crabtree

11 min

tutorial

Tutorial da API de assistentes da OpenAI

Uma visão geral abrangente da API Assistants com nosso artigo, que oferece uma análise aprofundada de seus recursos, usos no setor, orientação de configuração e práticas recomendadas para maximizar seu potencial em vários aplicativos de negócios.
Zoumana Keita 's photo

Zoumana Keita

14 min

tutorial

Guia para iniciantes no uso da API do ChatGPT

Este guia o orienta sobre os conceitos básicos da API ChatGPT, demonstrando seu potencial no processamento de linguagem natural e na comunicação orientada por IA.
Moez Ali's photo

Moez Ali

11 min

tutorial

Introdução ao Text Embeddings com a API OpenAI

Explore nosso guia sobre como usar a API OpenAI para criar incorporações de texto. Descubra suas aplicações na classificação de textos, recuperação de informações e detecção de similaridade semântica.
Zoumana Keita 's photo

Zoumana Keita

7 min

tutorial

Como usar a API de conversão de texto em fala da OpenAI

A API TTS da OpenAI é um ponto de extremidade que permite que os usuários interajam com seu modelo de IA TTS que converte texto em linguagem falada com som natural.
Kurtis Pykes 's photo

Kurtis Pykes

12 min

See MoreSee More