Aprende a usar correctamente el API de OpenAI

En este artículo, exploraremos la API de OpenAI, una herramienta poderosa que permite a los desarrolladores integrar modelos de inteligencia artificial de vanguardia en sus aplicaciones. Desglosaremos cinco claves fundamentales para aprovechar al máximo esta API, desde la autenticación hasta la optimización de las solicitudes, incluyendo ejemplos de código en Python para ilustrar su uso práctico. ¡Prepárate para desbloquear el potencial de la IA en tus proyectos!

1. Autenticación: El primer paso indispensable

Antes de comenzar a interactuar con la API de OpenAI, necesitas autenticarte. Esto se hace mediante una clave API (API key) que obtienes al crear una cuenta en la plataforma de OpenAI. Esta clave es como tu "contraseña" para acceder a los servicios de OpenAI, así que guárdala de forma segura.

Ejemplo:

from openai import OpenAI // Importamos libreria de OpenAI
open_ai_api_key = os.getenv("OPENAI_API_KEY") // Variable de entorno
client = OpenAI(api_key=open_ai_api_key) // Creamos el cliente

¡Importante! Nunca compartas tu clave API públicamente, por ejemplo, en tu código fuente que subes a GitHub. Considera usar variables de entorno para almacenarla de forma segura.

2. Elegir el Modelo adecuado

OpenAI ofrece una variedad de modelos, cada uno con sus propias fortalezas y debilidades. Algunos modelos son mejores para la generación de texto, otros para la traducción, y otros para la finalización de código. Elegir el modelo correcto para tu tarea es crucial para obtener los mejores resultados.

Algunos modelos populares incluyen:

• text-davinci-003: Un modelo potente para una amplia gama de tareas de generación de texto.
• code-davinci-002: Optimizado para la generación y finalización de código.
• gpt-4.1: Un modelo más reciente y eficiente, ideal para conversaciones y tareas generales.

Ejemplo:

from openai import OpenAI
client = OpenAI()

response = client.chat.completions.create(
    model="gpt-4.1",
    messages=[{"role": "user", "content": "Escribir un poema de la primavera."}],
    temperature=0.7,
    max_tokens=100
)
content = response.choices[0].message.content
print(content)

3. El poder de Prompt

El "prompt" es la instrucción que le das al modelo. Es la clave para obtener la respuesta que deseas. Un prompt bien definido es específico, claro y conciso.
Cuanto más claro sea tu prompt, mejor será la respuesta del modelo.

Ejemplo:

from openai import OpenAI
client = OpenAI()

response = client.responses.create(
  model="gpt-4o",
  input=[
    {
      "role": "system",
      "content": [
        {
          "type": "input_text",
          "text": "Se le proporcionarán declaraciones y su tarea es convertirlas
           al inglés estándar." <-- Instrucción clara, específica y concisa
        }
      ]
    },
    {
      "role": "user",
      "content": [
        {
          "type": "input_text",
          "text": "She no went to the market." <-- Declaracion suministrada
        }
      ]
    }
  ],
  temperature=1,
  max_output_tokens=256
)
content = response.choices[0].message.content
print(content) // She did not go to the market. <-- Respuesta de OpenAI

4. Controlar la generacion: Parámetros

La API de OpenAI ofrece varios parámetros que te permiten controlar la generación de texto. Algunos de los parámetros más importantes son: max_tokens: El número máximo de tokens (palabras o partes de palabras) que el modelo puede generar. temperature: Controla la aleatoriedad de la generación. Un valor más bajo (por ejemplo, 0.2) produce resultados más predecibles, mientras que un valor más alto (por ejemplo, 0.8) produce resultados más creativos. top_p: Sirve para controlar la diversidad de las respuestas generadas por los modelos n: El número de respuestas que quieres que el modelo genere.

Ejemplo:

from openai import OpenAI
client = OpenAI()

response = client.chat.completions.create(
  model="gpt-4o",
  input=[
    {
      "role": "system",
      "content": [
        {
          "type": "input_text",
          "text": "Eres un inventor de aplicaciones móviles",
        }
      ]
    },
    {
      "role": "user",
      "content": [
        {
          "type": "input_text",
          "text": "Escribe una idea para una aplicación móvil"
        }
      ]
    }
  ],
  max_tokens=150,
  temperature=0.7,
  n=2  # Genera dos ideas
)

for i, choice in enumerate(response.choices):
  print(f"Idea {i+1}: {choice.message.content}")

En este ejemplo, estamos pidiendo al modelo que genere dos ideas para una aplicación móvil, con una temperatura de 0.7 para fomentar la creatividad.

5. Manejo de errores

Como con cualquier API, es importante manejar los errores que puedan ocurrir. La API de OpenAI puede devolver errores por varias razones, como problemas de autenticación, límites de uso excedidos o errores internos del servidor.

import openai
from openai import OpenAI

openai.api_key = "YOUR_API_KEY"

try:
  response = client.chat.completions.create(
    model="gpt-4.1",
    messages=[{"role": "user", "content": "Escribe un cuento corto."}],
    max_tokens=200
  )
  print(response.choices[0].message.content)

except openai.APIStatusError as e:
  print(f"Error de OpenAI: {e}")

except Exception as e:
  print(f"Otro error: {e}")

Conclusiones

La API de OpenAI es una herramienta poderosa que puede transformar la forma en que construyes aplicaciones. Al comprender y aplicar estas cinco claves, estarás en camino de desbloquear todo su potencial y crear experiencias innovadoras impulsadas por la inteligencia artificial. ¡Experimenta, explora y diviértete!

Infografía