Generar salidas estructuradas

Trabajar con la API Responses de OpenAI

James Chapman

AI Curriculum Manager, DataCamp

A continuación...

La necesidad de estructura

Parte 1: Definir el esquema de salida

from pydantic import BaseModel


class QuizResult(BaseModel):
    score: int
    passed: bool
    feedback: str

Parte 1: Definir el esquema de salida

from pydantic import BaseModel, Field

class QuizResult(BaseModel):
    score: int = Field(description="Número de aciertos de 10")
    passed: bool = Field(description="True si score es 7 o más")
    feedback: str = Field(
        description="Mensaje motivador con consejos concretos para mejorar"
    )

Parte 2: Enviar la solicitud

response = client.responses.parse(

    model="gpt-5-mini",

    instructions="Eres un tutor de vocabulario de español. Corrige el cuestionario del alumno. Puntúa con 2 puntos por acierto.",
    input="""1. casa = house
             2. perro = dog
             3. gato = car
             4. libro = book
             5. agua = water""",

    text_format=QuizResult

)

Parte 3: Extraer los resultados

result = response.output_parsed

print(f"Score: {result.score}/10")
print(f"Passed: {result.passed}")
print(f"Feedback: {result.feedback}")

Score: 8/10
Passed: True
Feedback: ¡Buen trabajo! Sacaste 8/10 (4/5 correctas). El único error fue la #3: 'gato'
significa 'cat', no 'car' (en español, 'car' es 'coche' o 'carro'). Consejo: repasa vocabulario
de animales con fichas y minicuestionarios para afianzar la memoria.

Estructuras de datos más complejas

class Mistake(BaseModel):
    word: str = Field(description="La palabra en español incorrecta")
    student_answer: str = Field(description="Lo que escribió el alumno")
    correct_answer: str = Field(description="La traducción correcta")


class DetailedQuizResult(BaseModel):
    score: int = Field(description="Número de aciertos de 10")
    passed: bool = Field(description="True si score es 7 o más")
    feedback: str = Field(description="Mensaje motivador con consejos concretos")

    mistakes: list[Mistake] = Field(description="Lista de respuestas incorrectas")

response = client.responses.parse(
    model="gpt-5-mini",
    instructions="Eres un tutor de vocabulario de español. Corrige el cuestionario del alumno. Puntúa con 2 puntos por acierto.",
    input="""1. casa = house
             2. perro = dog
             3. gato = car
             4. libro = library
             5. agua = water""",

    text_format=DetailedQuizResult

)

result = response.output_parsed
print(f"Score: {result.score}/10")
print(f"Passed: {result.passed}")

for mistake in result.mistakes:
    print(f"{mistake.word}: '{mistake.student_answer}' -> '{mistake.correct_answer}'")

Score: 6/10
Passed: False
gato: 'car' -> 'cat'
libro: 'library' -> 'book'

Resumen

from pydantic import BaseModel, Field

class QuizResult(BaseModel):
    score: int = Field(...)
    passed: bool = Field(...)
    feedback: str = Field(...)

result = response.output_parsed

print(f"Score: {result.score}/10")
print(f"Passed: {result.passed}")
print(f"Feedback: {result.feedback}")

response = client.responses.parse(
    model="gpt-5-mini",
    instructions="...",
    input="...",

    text_format=QuizResult

)

¡Vamos a practicar!

Trabajar con la API Responses de OpenAI