Skip to content

Conversation

jwm4
Copy link
Contributor

@jwm4 jwm4 commented Oct 10, 2025

What does this PR do?

Adds a subpage of the OpenAI compatibility page in the documentation. This subpage documents known limitations of the Responses API.

Closes #3575

@meta-cla meta-cla bot added the CLA Signed This label is managed by the Meta Open Source bot. label Oct 10, 2025
@jwm4 jwm4 changed the title Document known limitations of Responses docs: Document known limitations of Responses Oct 10, 2025
@zanetworker
Copy link

@jwm4 would we consider prompt-caching a limitation in the API: https://platform.openai.com/docs/api-reference/responses/create#responses-create-prompt_cache_key

Allowing consumers the ability to configure this will matter from a cost/efficiency standpoint (especially with the open implementation here).

@jwm4 jwm4 force-pushed the jwm4-known-limits branch 3 times, most recently from c753bb9 to 7fca369 Compare October 14, 2025 12:46
@jwm4
Copy link
Contributor Author

jwm4 commented Oct 14, 2025

I've addressed the review comments, but I am running out of theories as to how to move forward on getting the CI to pass. Running uv run pre-commit run --all-files and pushing all the changes it makes (to files not involved in this PR) doesn't seem to be getting anywhere. I keep rolling back those commits and trying again, rebasing with main, etc. but it doesn't seem to help.

@ashwinb
Copy link
Contributor

ashwinb commented Oct 14, 2025

I've addressed the review comments, but I am running out of theories as to how to move forward on getting the CI to pass. Running uv run pre-commit run --all-files and pushing all the changes it makes (to files not involved in this PR) doesn't seem to be getting anywhere. I keep rolling back those commits and trying again, rebasing with main, etc. but it doesn't seem to help.

This is an annoying issue with our pre-commit where we need pre-commit==4.3.0 and python==3.12 and any other combination doesn't make it work. It is likely that one of these is not correct in your environment somehow.

Signed-off-by: Bill Murdock <bmurdock@redhat.com>
@jwm4 jwm4 force-pushed the jwm4-known-limits branch from 862bb61 to 6f669dc Compare October 14, 2025 19:03
Signed-off-by: Bill Murdock <bmurdock@redhat.com>
@jwm4
Copy link
Contributor Author

jwm4 commented Oct 14, 2025

Thx, @ashwinb ! I had run into similar issues with code change PRs before but I hadn't thought carefully about the implications for documentation PRs. This seems to have sorted out the CI issues. I will open a separate PR to update CONTRIBUTING.md with this info too.

jwm4 added 2 commits October 14, 2025 16:41
Signed-off-by: Bill Murdock <bmurdock@redhat.com>
Signed-off-by: Bill Murdock <bmurdock@redhat.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed This label is managed by the Meta Open Source bot.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document known limitations and/or inconsistencies of the Responses API in Llama Stack

4 participants