Como usar a API ChatGPT

Principais conclusões

  • A OpenAI lançou a API ChatGPT, permitindo aos desenvolvedores integrar os recursos do ChatGPT em seus aplicativos.
  • Para começar, você precisará de uma chave de API OpenAI e de um ambiente de desenvolvimento com as bibliotecas oficiais.
  • Você pode usar a API ChatGPT para tarefas de conclusão de bate-papo e de texto, abrindo possibilidades para diversas aplicações.

Com o lançamento de sua API, a OpenAI abriu os recursos do ChatGPT para todos. Agora você pode integrar perfeitamente os recursos do ChatGPT ao seu aplicativo.

Siga estas etapas para começar, se você deseja integrar o ChatGPT ao seu aplicativo existente ou desenvolver novos aplicativos com ele.

1. Obtendo uma chave de API OpenAI

Para começar a usar a API ChatGPT, você precisa obter uma chave de API.

  • Cadastre-se ou faça login no site oficial OpenAI plataforma.
  • Depois de fazer login, clique na guia Chaves de API no painel esquerdo.
  • Em seguida, clique no botão Criar nova chave secreta para gerar a chave API.
  • Você não poderá visualizar a chave de API novamente, então copie-a e guarde-a em algum lugar seguro.
  • O código utilizado neste projeto está disponível em um
    Repositório GitHub
    e é gratuito para você usar sob a licença do MIT.

    2. Configurando o Ambiente de Desenvolvimento

    Você pode usar o endpoint da API diretamente ou aproveitar as vantagens da biblioteca openai Python/JavaScript para começar a construir aplicativos com API ChatGPT. Este guia usa Python e o openai-python biblioteca.

    Para começar:

  • Crie um ambiente virtual Python
  • Instale as bibliotecas openai e python-dotenv via pip:
    pip install openai python-dotenv 
  • Crie um arquivo .env na raiz do diretório do seu projeto para armazenar sua chave de API com segurança.
  • A seguir, no mesmo arquivo, defina a variável OPENAI_API_KEY com o valor-chave que você copiou anteriormente:
    OPENAI_API_KEY="YOUR_API_KEY" 
  • Certifique-se de não compartilhar acidentalmente sua chave de API por meio do controle de versão.
    Adicione um arquivo .gitignore
    ao diretório raiz do seu projeto e adicione “.env” a ele para ignorar o arquivo dotenv.

      Aqui está tudo o que você deve saber

    3. Fazendo solicitações de API ChatGPT

    O GPT-3.5 Turbo, GPT-4 e GPT-4 Turbo da API OpenAI são os mesmos modelos que o ChatGPT usa. Esses modelos poderosos são capazes de compreender e gerar texto e código em linguagem natural. O GPT-4 Turbo pode até processar entradas de imagens, o que abre portas para diversos usos, incluindo análise de imagens, análise de documentos com figuras e transcrição de texto de imagens.

    Observe que API ChatGPT é um termo geral que se refere a APIs OpenAI que usam modelos baseados em GPT, incluindo os modelos gpt-3.5-turbo, gpt-4 e gpt-4-turbo.

    A API ChatGPT é otimizada principalmente para bate-papo, mas também funciona bem para tarefas de preenchimento de texto. Se você deseja gerar código, traduzir idiomas ou redigir documentos, esta API pode cuidar de tudo.

    Para obter acesso à API GPT-4, você precisa fazer um pagamento bem-sucedido de US$ 1 ou mais. Caso contrário, você poderá receber um erro semelhante a “O modelo `gpt-4` não existe ou você não tem acesso a ele”.

    Usando a API para conclusão de bate-papo

    Você precisa configurar o modelo de chat para prepará-lo para uma chamada de API. Aqui está um exemplo:

    from openai import OpenAI
    from dotenv import load_dotenv

    load_dotenv()
    client = OpenAI()

    response = client.chat.completions.create(
      model = "gpt-3.5-turbo-0125",
      temperature = 0.8,
      max_tokens = 3000,
      response_format={ "type": "json_object" },
      messages = [
        {"role": "system", "content": "You are a funny comedian who tells dad jokes. The output should be in JSON format."},
        {"role": "user", "content": "Write a dad joke related to numbers."},
        {"role": "assistant", "content": "Q: How do you make 7 even? A: Take away the s."},
        {"role": "user", "content": "Write one related to programmers."}
      ]
    )

    A API ChatGPT envia uma resposta no seguinte formato:

      5 melhores carteiras de fibra de carbono com tecnologia de bloqueio RFID (edição 2021)

    Você pode extrair o conteúdo da resposta, como uma string JSON, com este código:

    print(response.choices[0].message.content) 

    A execução deste código produz a seguinte saída:

    O código demonstra uma chamada de API ChatGPT usando Python. Observe que o modelo entendeu o contexto (“piada do pai”) e o tipo de resposta (formulário de perguntas e respostas) que esperávamos, com base nas instruções fornecidas a ele.

    A parte mais significativa da configuração é o parâmetro messages que aceita uma matriz de objetos de mensagem. Cada objeto de mensagem contém uma função e um conteúdo. Você pode usar três tipos de funções:

    • sistema que configura o contexto e o comportamento do assistente.
    • usuário que dá instruções ao assistente. O usuário final normalmente fornecerá isso, mas você também pode fornecer algumas solicitações padrão ao usuário com antecedência.
    • assistente que pode incluir exemplos de respostas.

    Você pode personalizar ainda mais os parâmetros de temperatura e max_tokens do modelo para obter a saída de acordo com seus requisitos.

    Quanto maior a temperatura, maior a aleatoriedade da saída e vice-versa. Se você deseja que suas respostas sejam mais focadas e determinísticas, opte pelo valor de temperatura mais baixo. E se quiser que seja mais criativo, use um valor maior. O valor da temperatura varia entre 0 e 2.

    Assim como o ChatGPT, a API também possui um limite de palavras. Use o parâmetro max_tokens para limitar o comprimento das respostas. Esteja ciente de que definir um valor max_tokens mais baixo pode causar problemas, pois pode interromper a saída no meio do caminho.

    No momento em que este artigo foi escrito, o modelo gpt-3.5-turbo tinha um limite de tokens de 4.096, enquanto o do gpt-4 era 8.192. Os modelos mais recentes gpt-3.5-turbo-0125 e gpt-4-turbo-preview têm limites de 16.385 e 128.000, respectivamente.

    Após grande demanda dos desenvolvedores, a OpenAI introduziu o modo JSON que instrui o modelo a sempre retornar um objeto JSON. Você pode ativar o modo JSON definindo response_format como { “type”: “json_object” }. Atualmente, esse recurso está disponível apenas para os modelos mais recentes: gpt-3.5-turbo-0125 e gpt-4-turbo-preview.

      A chave para uma conectividade flexível e segura

    Você pode configurar ainda mais o modelo usando os outros parâmetros fornecidos por OpenAI.

    Usando a API ChatGPT para conclusão de texto

    Além das tarefas de conversação com vários turnos, a API de conclusão de bate-papo (API ChatGPT) faz um bom trabalho com a conclusão de texto. O exemplo a seguir demonstra como você pode configurar a API ChatGPT para preenchimento de texto:


    from openai import OpenAI
    from dotenv import load_dotenv

    load_dotenv()
    client = OpenAI()

    response = client.chat.completions.create(
      model = "gpt-3.5-turbo",
      temperature = 0.8,
      max_tokens = 3000,
      messages = [
        {"role": "system", "content": "You are a poet who creates poems that evoke emotions."},
        {"role": "user", "content": "Write a short poem for programmers."}
      ]
    )

    print(response.choices[0].message.content)

    Você nem precisa fornecer a função do sistema e seu conteúdo. Fornecer apenas o prompt do usuário fará o trabalho para você.

    messages = [
      {"role": "user", "content": "Write a short poem for programmers."}
    ]

    A execução do código acima irá gerar um poema para programadores, por exemplo:

    Preços da API ChatGPT

    O preço da API ChatGPT é baseado no modelo “preço por 1.000 tokens”. Para solicitações de conclusão de chat, o custo é calculado com base no número de tokens de entrada mais o número de tokens de saída retornados pela API. Em termos leigos, os tokens são equivalentes a pedaços de palavras, onde 1.000 tokens são aproximadamente iguais a 750 palavras.

    Modelo

    Entrada

    Saída

    gpt-4-0125-visualização

    US$ 0,01/1 mil tokens

    US$ 0,03/1 mil tokens

    gpt-4-1106-visualização

    US$ 0,01/1 mil tokens

    US$ 0,03/1 mil tokens

    gpt-4-1106-vision-preview

    US$ 0,01/1 mil tokens

    US$ 0,03/1 mil tokens

    gpt-4

    US$ 0,03/1 mil tokens

    US$ 0,06/1 mil tokens

    gpt-4-32k

    US$ 0,06/1 mil tokens

    US$ 0,12/1 mil tokens

    gpt-3.5-turbo-0125

    US$ 0,0005/1 mil tokens

    US$ 0,0015/1 mil tokens

    gpt-3.5-turbo-instrução

    US$ 0,0015/1 mil tokens

    US$ 0,0020/1 mil tokens

    Observe que o preço pode mudar ao longo do tempo com melhorias no modelo.

    Crie aplicativos de próxima geração usando a API ChatGPT

    A API ChatGPT abriu portas para desenvolvedores de todo o mundo criarem produtos inovadores com o poder da IA.

    Você pode usar essa ferramenta para desenvolver aplicativos como redatores de histórias, tradutores de código, geradores de cópias de marketing e resumidores de texto. Sua imaginação é o limite para construir aplicações utilizando esta tecnologia.