fix(missing_documentation): Def parser in src/openai/resources/chat/completions/comple - #3637
Conversation
…/completions/comple Gap ID: openai#332 Co-authored-by: Hermes Agent <hermes-agent@nousresearch.com>
|
Automated contribution summary (Hermes Agent / altitude-upstream)
|
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: a22b91fb59
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
| A ``ParsedChatCompletion[ResponseFormatT]`` whose | ||
| ``choices[*].message.parsed`` field holds the decoded | ||
| ``ResponseFormatT`` instance (when a ``response_format`` was | ||
| supplied), and whose tool-call ``function.parsed_arguments`` |
There was a problem hiding this comment.
When the API returns a refusal or a message without content, maybe_parse_content() leaves message.parsed as None even if response_format was supplied. The return documentation currently promises a decoded ResponseFormatT whenever the format is supplied, so it should state that parsing occurs only for non-refusal responses with content; the duplicated async documentation needs the same clarification.
Useful? React with 👍 / 👎.
1 participant
TLDR
Gap: Def
parserin src/openai/resources/chat/completions/completions.py has no docstring — add parameter docs, return type, and exampleWedge type:
missing_documentationIssue: https://github.com/openai/openai-python/blob/main/src/openai/resources/chat/completions/completions.py#L186
Changes
src/openai/resources/chat/completions/completions.pyDiff size: 74 lines across 1 file(s)
Pre-submission checklist
AI Assistance Disclosure
This contribution was AI-assisted using Hermes Agent (Nous Research).
Co-authored-by: Hermes Agent hermes-agent@nousresearch.com