feat: add support for /responses background parameter #4751
Conversation
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
meta-cla
bot
added
the
CLA Signed
cdoern
changed the title
background parameter
cdoern
force-pushed
the
responses-background
branch
from
851633d to
b531423
Compare
Contributor
✱ Stainless preview buildsThis PR will update the Edit this comment to update it. It will appear in the SDK's changelogs.
|
⚠️ llama-stack-client-openapi studio · code · diff
There was a regression in your SDK.
generate ⚠️→lint ⏳→test ⏳New diagnostics (1 warning)
⚠️ Endpoint/NotConfigured: `post /v1/responses/{response_id}/cancel` exists in the OpenAPI spec, but isn't specified in the Stainless config, so code will not be generated for it.
❗ llama-stack-client-kotlin studio
Code was not generated because there was a fatal error.
⚠️ llama-stack-client-python studio · conflict
There was a regression in your SDK.
New diagnostics (1 warning)
⚠️ Endpoint/NotConfigured: `post /v1/responses/{response_id}/cancel` exists in the OpenAPI spec, but isn't specified in the Stainless config, so code will not be generated for it.
⚠️ llama-stack-client-go studio · conflict
There was a regression in your SDK.
New diagnostics (1 warning)
⚠️ Endpoint/NotConfigured: `post /v1/responses/{response_id}/cancel` exists in the OpenAPI spec, but isn't specified in the Stainless config, so code will not be generated for it.
⏳ These are partial results; builds are still running.
This comment is auto-generated by GitHub Actions and is automatically kept up to date as you push.
Last updated: 2026-01-27 18:47:19 UTC
cdoern
force-pushed
the
responses-background
branch
from
b531423 to
fb4b986
Compare
Add OpenAI-compatible background mode for the Responses API, allowing responses to be queued for asynchronous processing. - Added `background` parameter (bool, default: false) - When true, returns immediately with status "queued" - Added `background` field to `OpenAIResponseObject` - New status values: "queued", "in_progress", "cancelled" - OpenAI-compatible endpoint for cancelling background responses - Only works for responses created with background=true - Only cancellable when status is "queued" or "in_progress" - `agents/models.py`: Added `background` to `CreateResponseRequest`, new `CancelResponseRequest` - `agents/api.py`: Added `cancel_openai_response` to Agents protocol - `agents/fastapi_routes.py`: Added cancel route - `openai_responses.py`: Added `background` field to response object - `openai_responses.py`: Background processing with `_create_background_response` and `_process_background_response` - `responses_store.py`: Added `update_response_object` for status updates - Issue: llamastack#4701 - OpenAI docs: https://platform.openai.com/docs/guides/background Signed-off-by: Charlie Doern <cdoern@redhat.com>
cdoern
force-pushed
the
responses-background
branch
from
fb4b986 to
1d39612
Compare
|
This pull request has merge conflicts that must be resolved before it can be merged. @cdoern please rebase it. https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork |
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.
What does this PR do?
Add OpenAI-compatible background mode for the Responses API, allowing responses to be queued for asynchronous processing.
Added
backgroundparameter (bool, default: false)When true, returns immediately with status "queued"
Added
backgroundfield toOpenAIResponseObjectNew status values: "queued", "in_progress", "cancelled"
OpenAI-compatible endpoint for cancelling background responses
Only works for responses created with background=true
Only cancellable when status is "queued" or "in_progress"
agents/models.py: AddedbackgroundtoCreateResponseRequest, newCancelResponseRequestagents/api.py: Addedcancel_openai_responseto Agents protocolagents/fastapi_routes.py: Added cancel routeopenai_responses.py: Addedbackgroundfield to response objectopenai_responses.py: Background processing with_create_background_responseand_process_background_responseresponses_store.py: Addedupdate_response_objectfor status updatescloses #4701
Test Plan
new unit and integration tests (with stainless builds) should pass. The integration tests represent the testing for the new API changes.