Explicitly don't support Responses API instructions
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 349
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 318
Description
Use cases, pain points, and background
instructions is a valid Response create parameter https://platform.openai.com/docs/api-reference/responses/create#responses_create-instructions. however, we don't have a clear implementation of this.
Description:
For the moment, we should explicitly error out when instructions are provided on Response create. Eventually we may want to support this when there is clearer guidance from OpenAI on what this maps to underneath the hood e.g. system or developer message.
Design:
Should just touch nemo_gym/openai_utils.py
Out of scope:
Acceptance Criteria:
- Implementation of the above
- Test
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read nemo_gym/openai_utils.py and find the Response create handling for the instructions parameter. Implement the explicit error behavior described in the issue and add a test covering a Response create request with instructions; run the relevant test suite to verify the unsupported parameter is rejected.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100