Skip to content

Conversation

@RVV-karma
Copy link
Contributor

Summary

Adds documentation for the run_in_parallel parameter introduced in #1986, explaining the two execution modes for input guardrails and their use cases.

Documentation Changes:

  • Updated introduction to clarify guardrails can run in parallel or blocking mode
  • Added "Execution modes" section explaining:
    • Parallel execution (default) for low latency
    • Blocking execution for cost efficiency and preventing race conditions
  • Added comparison table of both modes
  • Added code examples demonstrating both execution modes
  • Updated recommendations for when to use each mode

Context:

This documentation was split from #1986 per reviewer feedback to be merged after the feature is released in version 0.5.x.

Related PRs/Issues


Checklist:

  • Documentation updated
  • Examples included
  • Clear and accurate

Short and focused on just the docs changes! This makes it clear it's a follow-up documentation PR. 📝

@seratch seratch added documentation Improvements or additions to documentation feature:core labels Nov 15, 2025
@seratch seratch added this to the 0.6.x milestone Nov 18, 2025
@seratch seratch merged commit e93d778 into openai:main Nov 19, 2025
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation feature:core

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants