Support structured outputs (JSON schema) per message, passed through to provider
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 38/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Bastante claro
- Estado de actividad
- Activo
- Stack tecnológico
- java, typescript
- Área
- api, backend-api-design
Línea de trabajo
Comienza en la API sendMessage o equivalente y sigue cómo las opciones por mensaje llegan a las solicitudes de los proveedores OpenAI y Anthropic. Después, sigue las rutas de finalización y streaming de mensajes del asistente, junto con los hooks preToolUse y los interceptores HTTP sin procesar. Se considera terminado cuando responseFormat se conserva, structuredOutput está expuesto en el mensaje del asistente, los proveedores no compatibles informan de un error claro y se cubren los criterios de aceptación indicados.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Summary
The Copilot SDK should expose first-class support for structured outputs (JSON schema–constrained responses) when targeting model providers that natively support the feature — OpenAI (response_format: { type: "json_schema", ... }) and Anthropic (structured output / tool-schema). The schema must be settable per message and passed through unchanged to the provider.
Motivation
The primary use case is deterministic agent flows that operate on the output of Copilot Studio agents.
In Copilot Studio, an agent turn is frequently a step inside a larger orchestrated agent flow — its output is not just rendered to a user, it's fed into:
- Agent flows that expect specific fields in the output
- Routing/branching logic that switches on a category, intent, or decision
These consumers require stable, schema-validated JSON from the agent turn. Today the SDK only emits free-form assistant text, which forces every agent flow to either:
- Post-parse model prose with regex / JSON-extraction heuristics — brittle and silently breaks when the model rephrases.
- Coerce JSON via a fake single-tool tool-call — adds a round-trip per turn, pollutes tool-use telemetry, and confuses
preToolUsehooks and authoring UX. - Rewrite the outgoing HTTP body in an LLM interceptor to inject
response_format— fights the SDK's own retry/streaming logic and is unsupported.
Both OpenAI and Anthropic already accept a JSON schema directly on the request. The SDK is the only layer blocking Copilot Studio from getting deterministic agent output end-to-end.
Proposed API
Structured output must be per message, because different turns in an agent flow need different schemas (classify → plan → extract → summarize).
await session.sendMessage({
content: "Classify this support ticket.",
responseFormat: {
type: "json_schema",
schema: {
name: "TicketClassification",
strict: true,
schema: {
type: "object",
properties: {
category: { type: "string", enum: ["billing", "technical", "other"] },
priority: { type: "string", enum: ["low", "medium", "high"] },
summary: { type: "string" }
},
required: ["category", "priority", "summary"],
additionalProperties: false
}
}
}
});
Requirements
- Per-message setting —
responseFormataccepted onsendMessage/ equivalent. Optional; absent ⇒ current behavior. - Schema passthrough — Forwarded verbatim to the provider request:
- OpenAI BYOM:
response_format: { type: "json_schema", json_schema: <schema> } - Anthropic BYOM: equivalent structured output / tool-schema mechanism
- OpenAI BYOM:
- Typed result on the assistant message — Parsed JSON exposed on the resulting message (e.g.,
message.structuredOutput) so agent flows can bind to fields without re-parsing. - Streaming compatible — Final structured payload available on turn completion.
- Hook/interceptor friendly —
preToolUsehooks and raw-HTTP interceptors observe the schema in the outgoing body unchanged. - Provider capability check — Clear error if the target provider does not support structured output (rather than silently dropping the field).
Non-goals
- Inventing a new schema dialect — accept JSON Schema as the providers do.
- Cross-provider schema translation beyond what each provider natively accepts.
Acceptance criteria
-
responseFormat(JSON schema) accepted on per-message send APIs - Forwarded verbatim to OpenAI and Anthropic provider requests
- Sructured payload exposed on the resulting assistant message
- Works with streaming and with existing hook/interceptor surfaces
- Clear error when targeting a provider that doesn't support it
References
- OpenAI Structured Outputs: https://platform.openai.com/docs/guides/structured-outputs
- Anthropic structured output / tool schemas: https://docs.anthropic.com/en/docs/build-with-claude/tool-use
- Lenguaje dominante
- Java
- Estrellas
- 10.5k
- Forks
- 1.5k
- Merge medio
- 1 d 9 h
- PR fusionados (30 d)
- 131
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de github/copilot-sdk
-
agentic-workflows
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
github/copilot-sdk#2709 · 1 comentario ·
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 78/100
github/copilot-sdk#2673 ·
-
bug testing
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
github/copilot-sdk#2628 ·
-
agentic-workflows
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
github/copilot-sdk#2627 · 1 comentario ·
-
agentic-workflows
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
github/copilot-sdk#2493 ·
Todos los issues de github/copilot-sdk
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
elastic/gradle-plugins#157 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
cryptomator/hub#497 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
johanhaleby/occurrent#1120 ·