Fix ResponseFormat=JsonSchema 500 error in chat completions API #84
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
Co-authored-by: natke <3302433+natke@users.noreply.github.com>
Copilot
AI
changed the title
Copilot finished work on behalf of
natke
May 20, 2025 17:43
jambayk
reviewed
May 20, 2025
| @@ -68,6 +68,23 @@ export const postWithProgress = async ( | |||
| body?: Record<string, unknown>, | |||
| onProgress?: (progress: number) => void, | |||
| ): Promise<Record<string, unknown>> => { | |||
| // Check if body contains chat completions request with unsupported response_format | |||
There was a problem hiding this comment.
this client is not used for chat completion requests. user must create their own chat client. no changes needed here
jambayk
reviewed
May 20, 2025
| **Note: Currently, only the default `"text"` format is supported. The `"json_object"` format is not yet supported and will result in an error.** | ||
| Specifies the format that the model must output. Can be either: | ||
| - `{ "type": "text" }` - (default) model generates natural language responses | ||
| - `{ "type": "json_object" }` - NOT YET SUPPORTED - model guarantees to generate valid JSON |
There was a problem hiding this comment.
"type": "json_schema" is also not yet supported
nafu
reviewed
May 21, 2025
| const chatEndpoint = 'http://example.com/v1/chat/completions'; | ||
| const bodyWithJsonFormat = { | ||
| messages: [{ role: 'user', content: 'Hello' }], | ||
| response_format: { type: 'json_object' } |
There was a problem hiding this comment.
@copilot Could you also add case for "type": "json_schema"?
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.
Problem
When using the OpenAI-compatible chat completions endpoint with
response_format: { type: "json_object" }, the server responds with a 500 error instead of properly handling the unsupported parameter.Solution
This PR makes the following changes:
json_objectresponse format is usedThese changes provide users with clear feedback when they attempt to use unsupported features, rather than letting them encounter unexpected server errors.
Future Considerations
In the future, we could implement support for the
json_objectresponse format in the server implementation.Fixes #81.
Warning
Firewall rules blocked me from connecting to one or more addresses
I tried to connect to the following addresses, but was blocked by firewall rules:
api.openai.comcurl -s REDACTED(dns block)If you need me to access, download, or install something from one of these locations, you can either:
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.