tool
Adapted from the Griptape AI Framework documentation.
Attributes
Name | Type | Description |
---|---|---|
extraction_engine | BaseExtractionEngine | ExtractionEngine . |
Source Code in griptape/tools/extraction/tool.py
@define(kw_only=True) class ExtractionTool(BaseTool, RuleMixin): """Tool for using an Extraction Engine. Attributes: extraction_engine: `ExtractionEngine`. """ extraction_engine: BaseExtractionEngine = field() @activity( config={ "description": "Can be used extract structured text from data.", "schema": Schema( { Literal("data"): Or( str, Schema( { "memory_name": str, "artifact_namespace": str, } ), ), } ), }, ) def extract(self, params: dict) -> ListArtifact | InfoArtifact | ErrorArtifact: data = params["values"]["data"] if isinstance(data, str): artifacts = ListArtifact([TextArtifact(data)]) else: memory = self.find_input_memory(data["memory_name"]) artifact_namespace = data["artifact_namespace"] if memory is not None: artifacts = memory.load_artifacts(artifact_namespace) else: return ErrorArtifact("memory not found") return self.extraction_engine.extract_artifacts(artifacts)
extraction_engine = field()
class-attribute instance-attribute
extract(params)
Source Code in griptape/tools/extraction/tool.py
@activity( config={ "description": "Can be used extract structured text from data.", "schema": Schema( { Literal("data"): Or( str, Schema( { "memory_name": str, "artifact_namespace": str, } ), ), } ), }, ) def extract(self, params: dict) -> ListArtifact | InfoArtifact | ErrorArtifact: data = params["values"]["data"] if isinstance(data, str): artifacts = ListArtifact([TextArtifact(data)]) else: memory = self.find_input_memory(data["memory_name"]) artifact_namespace = data["artifact_namespace"] if memory is not None: artifacts = memory.load_artifacts(artifact_namespace) else: return ErrorArtifact("memory not found") return self.extraction_engine.extract_artifacts(artifacts)
- On this page
- Attributes
- extract(params)
Could this page be better? Report a problem or suggest an addition!