Update chat-completion json_schema specs (Python) #3167
Closed
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
Wauplin
changed the title
This was referenced Jun 17, 2025
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
|
closing this PR as it degrades the typing |
Wauplin
added a commit
to huggingface/huggingface.js
that referenced
this pull request
Jun 25, 2025
In huggingface/huggingface_hub#3082 @hanouticelina fixed the Python inference types for chat completion grammar input. Biggest update was: ```py @dataclass_with_extra class ChatCompletionInputResponseFormatText(BaseInferenceType): type: Literal["text"] @dataclass_with_extra class ChatCompletionInputResponseFormatJSONSchema(BaseInferenceType): type: Literal["json_schema"] json_schema: ChatCompletionInputJSONSchema @dataclass_with_extra class ChatCompletionInputResponseFormatJSONObject(BaseInferenceType): type: Literal["json_object"] ChatCompletionInputGrammarType = Union[ ChatCompletionInputResponseFormatText, ChatCompletionInputResponseFormatJSONSchema, ChatCompletionInputResponseFormatJSONObject, ] ``` --- This PR reflects "officially" this update in the JS specs. It makes JS and Python specs aligned again (was not the case for the last month, ending up with annoying PRs like this one huggingface/huggingface_hub#3104). The result is not as satisfying as what a manual implementation would give because the 3 objects are merged in 1 with optional fields (see `export type ChatCompletionInputGrammarTypeType = "text" | "json_schema" | "json_object";`). This is because quicktype do not handle properly unions (see glideapps/quicktype#1266 - 6 yo :confused: ). It's not the only case like this in our specs but first time I find out about it. Not a problem since we don't enforce data structures. In Python, the data structure will result in this: huggingface/huggingface_hub#3167
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.
Follow-up PR after #3082 and huggingface/huggingface.js#1537. Resulting data structure is less optimal but at least it comes from our JS specs. See huggingface/huggingface.js#1537 for more details.