fix: correct prompt_cache_retention literal from "in-memory" to "in_memory"#2946
Open
giulio-leone wants to merge 1 commit intoopenai:mainfrom
Open
fix: correct prompt_cache_retention literal from "in-memory" to "in_memory"#2946giulio-leone wants to merge 1 commit intoopenai:mainfrom
giulio-leone wants to merge 1 commit intoopenai:mainfrom
Conversation
…emory" The Literal type for prompt_cache_retention used "in-memory" (hyphen) but the OpenAI API expects "in_memory" (underscore). Using the SDK-typed value caused 400 errors from the API. Updated all type definitions, method signatures, and tests across: - types/responses/response_create_params.py - types/responses/response.py - types/responses/responses_client_event.py - types/responses/responses_client_event_param.py - types/chat/completion_create_params.py - resources/chat/completions/completions.py - resources/responses/responses.py - tests/api_resources/chat/test_completions.py - tests/api_resources/test_responses.py Fixes openai#2883
Author
|
Friendly ping — CI is green, tests pass, rebased on latest. Ready for review whenever convenient. Happy to address any feedback. 🙏 |
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
1 participant
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 #2883
The
Literaltype forprompt_cache_retentionused"in-memory"(hyphen) but the OpenAI API expects"in_memory"(underscore). Using the SDK-typed value caused 400 Bad Request errors from the API.Changes
Replaced all 41 occurrences of
"in-memory"→"in_memory"across:Type definitions
src/openai/types/responses/response_create_params.pysrc/openai/types/responses/response.pysrc/openai/types/responses/responses_client_event.pysrc/openai/types/responses/responses_client_event_param.pysrc/openai/types/chat/completion_create_params.pyMethod signatures
src/openai/resources/chat/completions/completions.pysrc/openai/resources/responses/responses.pyTests
tests/api_resources/chat/test_completions.pytests/api_resources/test_responses.pyReproduction
As described in #2883, passing
prompt_cache_retention="in-memory"(the SDK-typed value) returns a 400 error, while"in_memory"succeeds.