rag_context
Adapted from the Griptape AI Framework documentation.
Bases:
SerializableMixin
Attributes
Name | Type | Description |
---|---|---|
query | str | Query provided by the user. |
module_configs | dict[str, dict] | Dictionary of module configs. First key should be a module name and the second a dictionary of configs parameters. |
before_query | list[str] | An optional list of strings to add before the query in response modules. |
after_query | list[str] | An optional list of strings to add after the query in response modules. |
text_chunks | list[TextArtifact] | A list of text chunks to pass around from the retrieval stage to the response stage. |
outputs | list[BaseArtifact] | List of outputs from the response stage. |
Source Code in griptape/engines/rag/rag_context.py
@define(kw_only=True) class RagContext(SerializableMixin): """Used by RagEngine stages and module to pass context that individual modules are expected to update in the `run` method. Attributes: query: Query provided by the user. module_configs: Dictionary of module configs. First key should be a module name and the second a dictionary of configs parameters. before_query: An optional list of strings to add before the query in response modules. after_query: An optional list of strings to add after the query in response modules. text_chunks: A list of text chunks to pass around from the retrieval stage to the response stage. outputs: List of outputs from the response stage. """ query: str = field(metadata={"serializable": True}) module_configs: dict[str, dict] = field(factory=dict, metadata={"serializable": True}) before_query: list[str] = field(factory=list, metadata={"serializable": True}) after_query: list[str] = field(factory=list, metadata={"serializable": True}) text_chunks: list[TextArtifact] = field(factory=list, metadata={"serializable": True}) outputs: list[BaseArtifact] = field(factory=list, metadata={"serializable": True}) def get_references(self) -> list[Reference]: return utils.references_from_artifacts(self.text_chunks)
after_query = field(factory=list, metadata={'serializable': True})
class-attribute instance-attributebefore_query = field(factory=list, metadata={'serializable': True})
class-attribute instance-attributemodule_configs = field(factory=dict, metadata={'serializable': True})
class-attribute instance-attributeoutputs = field(factory=list, metadata={'serializable': True})
class-attribute instance-attributequery = field(metadata={'serializable': True})
class-attribute instance-attributetext_chunks = field(factory=list, metadata={'serializable': True})
class-attribute instance-attribute
get_references()
Source Code in griptape/engines/rag/rag_context.py
def get_references(self) -> list[Reference]: return utils.references_from_artifacts(self.text_chunks)
- On this page
- Attributes
- get_references()
Could this page be better? Report a problem or suggest an addition!