QueryEngine Tool
The QueryEngine Tool node is a component in the LlamaIndex ecosystem that creates a tool for invoking a query engine. This tool can be used in various AI applications, particularly those involving language models and information retrieval.
Node Details
-
Name:
queryEngineToolLlamaIndex
-
Type:
QueryEngineTool
-
Version: 2.0
-
Category: Tools
Input Parameters
-
Base QueryEngine
-
Label: Base QueryEngine
-
Name: baseQueryEngine
-
Type: BaseQueryEngine
-
Description: The underlying query engine that this tool will use for processing queries.
-
-
Tool Name
-
Label: Tool Name
-
Name: toolName
-
Type: string
-
Description: A unique identifier for the tool. Must be in lowercase with underscores (e.g., “my_tool”).
-
-
Tool Description
-
Label: Tool Description
-
Name: toolDesc
-
Type: string
-
Description: A brief description of what the tool does or its purpose.
-
Output
The node initializes and returns a QueryEngineTool
instance, which can be used in other parts of your application or workflow.
Usage
This node is typically used in scenarios where you need to:
-
Integrate a query engine into a larger AI system.
-
Create a tool that can be used by language models to access and query specific information.
-
Build a modular system where different query engines can be swapped or combined.
Implementation Details
-
The node uses the
QueryEngineTool
class from the LlamaIndex library. -
It takes the base query engine, tool name, and description as inputs.
-
The
init
method creates and returns a newQueryEngineTool
instance with the provided parameters.
Base Classes
-
QueryEngineTool
-
Tool_LlamaIndex
This node serves as a bridge between raw query engines and higher-level AI applications, allowing for more flexible and powerful information retrieval systems.