fix(api): align ChatCompletionCustomToolParam structure with API spec - #2765
Closed
thromel wants to merge 1 commit into
Closed
fix(api): align ChatCompletionCustomToolParam structure with API spec#2765thromel wants to merge 1 commit into
thromel wants to merge 1 commit into
Conversation
The Chat Completions API custom tool type had incorrect nesting that didn't match the actual API structure. The type expected `name`, `description`, and `format` to be nested inside a `custom` object, and `syntax`/`definition` to be nested inside `format.grammar`. The correct structure (matching the Responses API and documentation) has these fields at the top level and reuses the shared CustomToolInputFormat type. Fixes #2667
Contributor
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
ChatCompletionCustomToolParamtype definition to match the actual API structurecustomwrapper object andformat.grammarwrapper)CustomToolInputFormattype (same as Responses API)Problem
The Chat Completions API custom tool type had incorrect nesting that didn't match the actual API structure:
Before (incorrect):
{ "type": "custom", "custom": { # ← extra nesting "name": "tool_name", "format": { "type": "grammar", "grammar": { # ← extra nesting "syntax": "lark", "definition": "..." } } } }After (correct, matching API docs):
{ "type": "custom", "name": "tool_name", "format": { "type": "grammar", "syntax": "lark", "definition": "..." } }Test plan
CustomToolParamfrom Responses APICustomToolInputFormattypeFixes #2667