fix(sdk): add missing format field to SessionPromptData type - #26428
Closed
xxiaoxiong wants to merge 1 commit into
Closed
fix(sdk): add missing format field to SessionPromptData type#26428xxiaoxiong wants to merge 1 commit into
xxiaoxiong wants to merge 1 commit into
Conversation
The SessionPromptData type was missing the 'format' field that exists in the OpenAPI spec. This field allows users to specify structured output formats (text or json_schema) when sending prompts. Added missing types: - OutputFormatText: for plain text output - OutputFormatJsonSchema: for JSON schema-based structured output - OutputFormat: union type of the above - format?: OutputFormat field in SessionPromptData.body This allows TypeScript users to use the format parameter without type errors, matching the actual API behavior. Fixes #26408
Contributor
|
This PR doesn't fully meet our contributing guidelines and PR template. What needs to be fixed:
Please edit this PR description to address the above within 2 hours, or it will be automatically closed. If you believe this was flagged incorrectly, please let a maintainer know. |
Contributor
|
This pull request has been automatically closed because it was not updated to meet our contributing guidelines within the 2-hour window. Feel free to open a new pull request that follows our guidelines. |
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
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
Fixes a TypeScript type definition issue where the
formatfield is missing fromSessionPromptData, even though it exists in the OpenAPI spec and works at runtime.Problem
Users trying to use structured output with the SDK get TypeScript errors:
The OpenAPI spec (line 5254-5256 in
packages/sdk/openapi.json) does include theformatfield:But the generated TypeScript types in
packages/sdk/js/src/gen/types.gen.tsare missing:OutputFormattypeOutputFormatTexttypeOutputFormatJsonSchematypeformatfield inSessionPromptData.bodyRoot Cause
The types are auto-generated from the OpenAPI spec, but the generation appears to have skipped these definitions. This could be:
@hey-api/openapi-ts)Solution
Manually added the missing type definitions based on the OpenAPI spec:
And added the
formatfield toSessionPromptData.body:Changes
OutputFormatTexttypeOutputFormatJsonSchematypeOutputFormatunion typeformat?: OutputFormatfield toSessionPromptData.bodyTesting
formatparameter without type errorsNotes
This is a manual fix. The proper long-term solution would be to:
./packages/sdk/js/script/build.ts) after fixing the root causeHowever, since the generation script requires Bun and a full build environment, this manual fix provides immediate relief for users hitting this issue.
Fixes #26408