Support responseFormat in prompt.yml files #71
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for responseFormat configuration in prompt.yml files, enabling users to specify structured output formats including JSON objects and JSON schema validation for AI model responses.
- Adds
responseFormatandjsonSchemafields to prompt file structure with validation - Implements three response format types: "text", "json_object", and "json_schema"
- Updates the Azure models types to include ResponseFormat in chat completion options
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| pkg/prompt/prompt.go | Adds JsonSchema struct, responseFormat validation, and BuildChatCompletionOptions method updates |
| pkg/prompt/prompt_test.go | Comprehensive test coverage for new responseFormat functionality |
| internal/azuremodels/types.go | Adds ResponseFormat struct and updates ChatCompletionOptions |
| cmd/run/run.go | Integrates prompt file's BuildChatCompletionOptions method for responseFormat support |
| cmd/run/run_test.go | Tests responseFormat integration in run command |
| cmd/eval/eval_test.go | Tests responseFormat functionality in evaluation command |
| examples/*.yml | Example prompt files demonstrating responseFormat usage |
Co-authored-by: Copilot <[email protected]>
Yuzuki-S
approved these changes
Jul 17, 2025
itsbagpack
approved these changes
Jul 17, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
https://github.com/github/models/issues/2522
The CLI supports prompt.yml files, but it doesn't support json or json schema outputs. This PR adds that support.
Diff is mostly tests and fixtures.