ResponseRagStage and PromptResponseRagModule updates
#1056
Conversation
# Conflicts: # docs/examples/query-webpage-astra-db.md # docs/examples/talk-to-a-pdf.md # docs/examples/talk-to-a-webpage.md # docs/griptape-framework/engines/rag-engines.md # docs/griptape-framework/structures/task-memory.md # docs/griptape-framework/structures/tasks.md # docs/griptape-tools/official-tools/rag-client.md
Codecov ReportAttention: Patch coverage is 📢 Thoughts on this report? Let us know! |
CHANGELOG.md
Outdated
| **BREAKING**: Removed before and after response modules from `ResponseRagStage`. | ||
| **BREAKING**: Moved ruleset and metadata ingestion from standalone modules to `PromptResponseRagModule`. |
| prompt_driver: BasePromptDriver = field() | ||
| answer_token_offset: int = field(default=400) | ||
| rulesets: list[Ruleset] = field(factory=list) |
There was a problem hiding this comment.
Should implement RuleMixin instead of defining itself.
| params: dict[str, Any] = {"text_chunks": [c.to_text() for c in artifacts]} | ||
|
|
||
| if len(self.rulesets) > 0: | ||
| params["rulesets"] = J2("rulesets/rulesets.j2").render(rulesets=self.rulesets) |
There was a problem hiding this comment.
After implementing RuleMixin, replace self.rulesets with self.all_rulesets.
| artifacts = WebLoader(max_tokens=500).load("https://www.griptape.ai") | ||
| if isinstance(artifacts, ErrorArtifact): | ||
| raise ValueError(artifacts.value) | ||
|
|
||
| vector_store.upsert_text_artifacts({"griptape": artifacts}) | ||
| vector_store.upsert_text_artifacts( | ||
| { | ||
| "griptape": WebLoader(max_tokens=500).load("https://www.griptape.ai"), | ||
| } | ||
| ) |
There was a problem hiding this comment.
Does this pass type checks?
Edit: it probably will not: #1057
| name: str = field( | ||
| default=Factory(lambda self: f"{self.__class__.__name__}-{uuid.uuid4().hex}", takes_self=True), kw_only=True | ||
| ) |
There was a problem hiding this comment.
What does name uniqueness get us?
There was a problem hiding this comment.
Much easier to add multiple modules of the same type without having to explicitly define names. May be that's something we add to tools as well?
| def modules(self) -> list[BaseRagModule]: | ||
| ms = [] | ||
|
|
||
| ms.extend(self.before_response_modules) | ||
| ms.extend(self.after_response_modules) | ||
|
|
||
| if self.response_module is not None: | ||
| ms.append(self.response_module) | ||
| ms.extend(self.response_modules) | ||
|
|
||
| return ms |
There was a problem hiding this comment.
Do we still need this property?
There was a problem hiding this comment.
We do because we test for module name uniqueness by using this property.
Describe your changes
RagContext.outputwas changed toRagContext.outputsto support multiple outputs. All relevant RAG modules we adjusted accordingly.ResponseRagStage.PromptResponseRagModule.RagEnginemodules.📚 Documentation preview 📚: https://griptape--1056.org.readthedocs.build//1056/