Estruturando uma chamada de API

Desenvolvimento de sistemas de IA com a API OpenAI

Francesca Donadoni

Curriculum Manager, DataCamp

Registro de progresso

Um logo preto e branco com as palavras "opal library"

Registro de progresso

Um diagrama com a biblioteca OpenAI e logo, e uma chamada de API com ícone de API

Registro de progresso

Um diagrama com a biblioteca OpenAI e logo, uma chamada genérica de API com ícone, e uma mensagem de resposta com ícone

Registro de progresso

from openai import OpenAI
client = OpenAI(api_key="ENTER YOUR KEY HERE")

response = client.chat.completions.create(
  model="gpt-4o-mini",
  messages=[
   {"role": "user", 
   "content": "Who developed ChatGPT?"}
 ]
)

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

ChatGPT was developed by OpenAI, an artificial intelligence research lab.

Desafios do ambiente de produção

Duas pessoas estudando um mapa com bússola, planejando a rota

Um celular exibindo um app de mapa com GPS

Desafios do ambiente de produção

Tratamento de erros
- Mensagens de erro claras para o usuário
- Alternativas quando o serviço estiver indisponível

Moderação e segurança
- Controlar entradas indesejadas
- Reduzir o risco de vazamento de dados

Testes e validação
- Verificar respostas fora do tema
- Testar comportamentos inconsistentes

Comunicação com sistemas externos
- Chamar funções e APIs externas
- Otimizar tempos de resposta

Componentes de uma requisição à API da OpenAI

from openai import OpenAI

client = OpenAI(api_key="ENTER YOUR KEY HERE")

response = client.chat.completions.create(
  model="gpt-4o-mini",

  messages=[
   {"role": "user", 
   "content": "Please write down five trees with their scientific names in json format."}
 ],

  response_format={"type": "json_object"}

)

Componentes de uma resposta da API da OpenAI

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

{
  "trees": [
    {"commonName": "Oak", "scientificName": "Quercus"},
    {"commonName": "Maple", "scientificName": "Acer"},
    {"commonName": "Pine", "scientificName": "Pinus"},
    {"commonName": "Birch", "scientificName": "Betula"},
    {"commonName": "Willow", "scientificName": "Salix"}
  ]
}

O que vem a seguir

Integração em produção
Chamar funções externas
Boas práticas

Uma pessoa com mochila e mapa apontando um destino

Vamos praticar!

Desenvolvimento de sistemas de IA com a API OpenAI