Crear salidas estructuradas

POST

/v1/messages

• Punto de conexión Structured Outputs (salidas estructuradas) de Anthropic Messages API
• Use output_format con json_schema para restringir el modelo a devolver JSON conforme al esquema
• Encabezado de solicitud anthropic-beta: structured-outputs-2025-11-13 para habilitar esta capacidad
• Documentación oficial: Structured Outputs

Authorizations

bearer

Type

HTTP (bearer)

Request Body

application/json

object

ID del modelo a usar. Consulte la tabla de compatibilidad de endpoints para modelos compatibles con la API Chat.

object[]

Required

Lista de mensajes que componen la conversación. Ejemplo de código Python.

Temperatura de muestreo entre 0 y 2. Valores más altos (p. ej. 0,8) hacen la salida más aleatoria; valores más bajos (p. ej. 0,2) la hacen más enfocada y determinista. Recomendamos cambiar esto o top_p, pero no ambos.

Muestreo nucleus alternativo a la temperatura: el modelo considera tokens cuya masa de probabilidad acumulada está dentro de top_p. 0,1 significa solo el 10 % superior de masa de probabilidad. Recomendamos cambiar esto o temperature, pero no ambos.

Predeterminado 1
Cuántas opciones de completado de chat generar por cada mensaje de entrada.

Predeterminado false. Si se establece, se envían deltas parciales de mensaje vía SSE como en ChatGPT, hasta que el flujo termina con data: [DONE]. Ejemplo de código Python.

Predeterminado null. Hasta 4 secuencias donde la API deja de generar tokens.

Predeterminado inf
Número máximo de tokens a generar en el completado de chat.

La longitud total de tokens de entrada y generados está limitada por el contexto del modelo. Ejemplo Python para contar tokens.

Número entre -2,0 y 2,0. Valores positivos penalizan tokens nuevos según si ya aparecieron en el texto, aumentando la probabilidad de nuevos temas. Más sobre penalizaciones

Predeterminado 0. Número entre -2,0 y 2,0. Valores positivos penalizan tokens nuevos según su frecuencia en el texto, reduciendo repeticiones. Más sobre penalizaciones de frecuencia y presencia.

Modifica la probabilidad de que aparezcan tokens especificados en el completado.

Acepta un objeto JSON que mapea IDs de token (del tokenizador) a valores de sesgo de -100 a 100. El sesgo se suma a los logits antes del muestreo; el efecto varía según el modelo. Valores entre -1 y 1 deben disminuir o aumentar la probabilidad de selección; -100 o 100 deben deshabilitar o seleccionar exclusivamente el token.

Identificador único del usuario final. Ayuda a OpenAI a monitorear y detectar abusos. Más información

Objeto que especifica el formato que debe producir el modelo. { "type": "json_object" } habilita el modo JSON. Importante: en modo JSON también debe indicar al modelo que produzca JSON vía mensaje system o user; de lo contrario puede emitir espacios hasta el límite de tokens. Si finish_reason="length", el contenido puede truncarse al superar max_tokens o el contexto.

Función beta. Si se especifica, el sistema intenta muestreo determinista para que solicitudes repetidas con la misma semilla y parámetros devuelvan el mismo resultado. No está garantizado; use system_fingerprint para monitorear cambios del backend.

Lista de herramientas que el modelo puede llamar. Actualmente solo se admiten funciones. Proporcione funciones para las que el modelo pueda generar entrada JSON.

Controla qué función (si alguna) llama el modelo. none significa sin llamada a función, solo mensaje. auto deja elegir entre mensaje y función. Forzar función con {"type": "function", "function": {"name": "my_function"}}. Predeterminado none sin funciones; auto si hay funciones.

object

Configuración de salida estructurada; cuando type es json_schema, schema restringe el JSON devuelto.