feat(runnable-rails): implement AIMessage metadata parity in RunnableRails #1369
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
Pouyanpi
force-pushed
the
feat/runnable-rails-ai-message
branch
from
8309931 to
8e1033c
Compare
Pouyanpi
force-pushed
the
feat/runnable-rails-ai-message
branch
2 times, most recently
from
1c5837e to
6a6050b
Compare
Pouyanpi
force-pushed
the
feat/runnable-rails
branch
from
7ae2f3a to
68f438e
Compare
Pouyanpi
force-pushed
the
feat/runnable-rails-ai-message
branch
2 times, most recently
from
ce4d6c1 to
0b114ba
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR implements AIMessage metadata parity in RunnableRails by ensuring that LLM metadata (response_metadata, usage_metadata, additional_kwargs, id) from the underlying LLM is preserved and passed through to the final AIMessage responses. This enables consistent behavior when using RunnableRails within LangChain chains.
- Adds metadata preservation infrastructure to capture and store LLM response metadata
- Updates RunnableRails output formatting to include preserved metadata in AIMessage responses
- Adds comprehensive test coverage for metadata preservation scenarios
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/runnable_rails/test_runnable_rails.py | Adds integration test to verify metadata preservation through RunnableRails |
| tests/runnable_rails/test_metadata.py | Comprehensive test suite for metadata preservation with various input/output formats |
| nemoguardrails/rails/llm/options.py | Adds llm_metadata field to GenerationResponse to store LLM metadata |
| nemoguardrails/rails/llm/llmrails.py | Updates to include llm_metadata in generation responses |
| nemoguardrails/integrations/langchain/runnable_rails.py | Updates output formatting methods to include metadata in AIMessage creation |
| nemoguardrails/context.py | Adds context variable for storing LLM response metadata |
| nemoguardrails/actions/llm/utils.py | Adds function to store and retrieve LLM response metadata |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Pouyanpi
changed the title
Pouyanpi
force-pushed
the
feat/runnable-rails
branch
3 times, most recently
from
feb4447 to
0c2a65e
Compare
Pouyanpi
force-pushed
the
feat/runnable-rails-ai-message
branch
from
0b114ba to
0e0ea4f
Compare
Pouyanpi
force-pushed
the
feat/runnable-rails
branch
from
0c2a65e to
a223dc3
Compare
…Rails Ensure AIMessage responses from RunnableRails contain the same metadata fields (response_metadata, usage_metadata, additional_kwargs, id) as direct LLM calls, enabling consistent LangChain integration behavior.
Pouyanpi
force-pushed
the
feat/runnable-rails-ai-message
branch
from
0e0ea4f to
00589c2
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
tgasser-nv
pushed a commit
that referenced
this pull request
Sep 22, 2025
…Rails (#1369) Ensure AIMessage responses from RunnableRails contain the same metadata fields (response_metadata, usage_metadata, additional_kwargs, id) as direct LLM calls, enabling consistent LangChain integration behavior.
tgasser-nv
pushed a commit
that referenced
this pull request
Sep 22, 2025
…Rails (#1369) Ensure AIMessage responses from RunnableRails contain the same metadata fields (response_metadata, usage_metadata, additional_kwargs, id) as direct LLM calls, enabling consistent LangChain integration behavior.
Pouyanpi
added a commit
that referenced
this pull request
Oct 1, 2025
…Rails (#1369) Ensure AIMessage responses from RunnableRails contain the same metadata fields (response_metadata, usage_metadata, additional_kwargs, id) as direct LLM calls, enabling consistent LangChain integration behavior.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Ensure AIMessage responses from RunnableRails contain the same metadata fields (response_metadata, usage_metadata, additional_kwargs, id) as direct LLM calls, enabling consistent LangChain integration behavior.